عن المشروع

LiveDoc هي منصة توثيق حية تتيح للفرق كتابة مواصفات قابلة للتنفيذ باستخدام صيغة Gherkin بأسلوب Given/When/Then مباشرة داخل أطر الاختبار الموجودة لديهم. وبدلاً من الاحتفاظ بملفات ميزات منفصلة، تعيش المواصفات داخل كود الاختبار وتعمل أيضًا كتوثيق. ما الذي توفره: - دعم صيغة Gherkin لـ Vitest (TypeScript/JavaScript) عبر @swedevtools/livedoc-vitest، ولـ xUnit (.NET) عبر SweDevTools.LiveDoc.xUnit. - عارض واجهة ويب في الوقت الفعلي (@swedevtools/livedoc-viewer) يعرض نتائج الاختبار أثناء تشغيلها، مع مثال حي منشور مرتبط من README. - إضافة VS Code (livedoc-vscode) توفر مقتطفات وتنسيقًا لصيغة BDD. - جداول البيانات ومخططات السيناريو للاختبار المعتمد على البيانات. - تصفية الوسوم لتضمين أو استبعاد الاختبارات حسب الوسم. - مخرجات طرفية منسقة وملونة لنتائج الاختبار. مسارات الإعداد: - TypeScript: قم بتثبيت vitest و@swedevtools/livedoc-vitest كاعتماديات تطوير، ثم استورد مساعدات feature وscenario وgiven وwhen وthen لتنظيم الاختبارات. - C#: أضف حزمة SweDevTools.LiveDoc.xUnit واجعل فئات الاختبار مشتقة من FeatureTest، باستخدام سمات [Feature] و[Scenario] بالإضافة إلى طرق Given/When/Then. - يصف README أيضًا تدفق إعداد بمساعدة الذكاء الاصطناعي حيث يقرأ مساعد البرمجة دليل إعداد مستضافًا ويهيئ المستودع، ويطرح أسئلة التهيئة واحدة تلو الأخرى قبل إجراء التغييرات. هناك حزمتان في مساحة العمل، @swedevtools/livedoc-schema و@swedevtools/livedoc-server، خاصتان ومضمنتان في توزيع العارض بدلاً من نشرهما بشكل مستقل. المشروع مرخص بموجب MIT ويتطلب Node.js 18+ و.NET 8.0 للمجموعتين التقنيتين المعنيتين.