docurun

DocuRun

DocuRun هي أداة لتشغيل وثائقك كاختبارات تكامل.

لماذا ؟

أراهن أن اختبارات التكامل والوثائق الخاصة بك كانت مخيبة للآمال.

• ربما تكون اختبارات التكامل الخاصة بك صعبة الكتابة، ويصعب قراءتها، ويصعب تصحيح أخطائها. عندما يحدث خطأ ما، يتعين عليك البحث في الكود ومحاولة تخمين النقطة التي تختلف عندها عما تفعله يدويًا في متصفحك.
• ربما تكون وثائق المستخدم النهائي قديمة، لأن المطورين لا يريدون تحديثها في كل مرة يقومون فيها بتغيير التعليمات البرمجية. عندما تقوم بتغيير صياغة زر ما، عليك أن تتذكر تحديث لقطات الشاشة في الوثائق، وربما لن تفعل ذلك.

إذا قمت بإجراء تغيير يكسر السلوك الموثق لواجهة المستخدم، فمن المحتمل أنك لن تكتشف ذلك إلا عندما يشتكي المستخدمون.

ما هو دوكيورون؟

DocuRun هي أداة تأخذ ملفات تخفيض السعر بما في ذلك كتل التعليمات البرمجية للكاتب المسرحي وتقوم بتشغيلها كاختبارات تكامل. ينتج موقع توثيق جميل مع لقطات شاشة تم التقاطها أثناء الاختبارات.

كيفية استخدام دوكيورون

1. اكتب وثائقك في ملفات تخفيض السعر، بما في ذلك كتل التعليمات البرمجية التي تصف كيفية استخدام التطبيق الخاص بك. قم بإنشاء ملف docurun/index.md الذي يبدو كالتالي:
2. قم بتشغيل DocuRun على ملفات تخفيض السعر الخاصة بك

   npx docurun

3. سيعرض Docurun تقريرًا جيدًا عن مخرجاته القياسية يوضح ملفات تخفيض السعر التي تم تشغيلها بنجاح وتلك التي فشلت. سيكون رمز الخروج 0 في حالة اجتياز جميع الاختبارات، و1 في حالة فشل بعض الاختبارات، مما يجعل من السهل التكامل في مسار CI/CD الخاص بك. سيقوم أيضًا بإنشاء دليل docurun/website/ يحتوي على موقع ويب ثابت يحتوي على الوثائق ولقطات الشاشة الخاصة بك. إذا فشلت بعض الاختبارات، فسوف تحتوي الوثائق على لقطات شاشة للصفحة في وقت الفشل ورسالة الخطأ.

عامل ميناء

يمكنك أيضًا تشغيل DocuRun في حاوية عامل إرساء، دون الحاجة إلى تثبيت Node.js على جهازك:

docker run -v $( pwd ) /docurun:/docurun -it lovasoa/docurun

راجع lovoa/docurun على Docker Hub.

لقطات الشاشة

صفحة SQL

يعرض هذا الوثائق القابلة للتنفيذ لأداة إنشاء موقع ويب SQLPage.

نجوم جيثب

أخطاء

يبدو تشغيل الخطأ هكذا في المحطة

 $ npx docurun

> [email protected] start
> node cli.js

Processing all files in ./docurun/:
 - download_sqlpage.md
 - star_a_repository.md.
Saving results to ./docurun/website/.

✅ download_sqlpage
Error while executing code:
await page.getByText('inexistent element').click()

locator.click: Timeout 30000ms exceeded.
Call log:
  - waiting for getByText('inexistent element')

 star_a_repository

وقدم: