इस प्रोजेक्ट के बारे में

LiveDoc एक लिविंग डॉक्यूमेंटेशन प्लेटफ़ॉर्म है जो टीमों को अपने मौजूदा टेस्ट फ्रेमवर्क के अंदर सीधे Gherkin-शैली Given/When/Then सिंटैक्स का उपयोग करके निष्पादन योग्य स्पेसिफिकेशन लिखने की अनुमति देता है। अलग-अलग फीचर फाइलों को बनाए रखने के बजाय, स्पेसिफिकेशन टेस्ट कोड में रहते हैं और दस्तावेज़ीकरण के रूप में दोगुने होते हैं। यह क्या प्रदान करता है: - @swedevtools/livedoc-vitest के माध्यम से Vitest (TypeScript/JavaScript) के लिए Gherkin सिंटैक्स समर्थन, और SweDevTools.LiveDoc.xUnit के माध्यम से xUnit (.NET) के लिए। - एक रीयल-टाइम वेब UI व्यूअर (@swedevtools/livedoc-viewer) जो टेस्ट परिणामों को चलते समय प्रदर्शित करता है, README से लिंक किया गया एक प्रकाशित लाइव उदाहरण के साथ। - BDD सिंटैक्स के लिए स्निपेट और फ़ॉर्मेटिंग प्रदान करने वाला एक VS Code एक्सटेंशन (livedoc-vscode)। - डेटा-संचालित परीक्षण के लिए डेटा टेबल और सीनारियो आउटलाइन। - टैग द्वारा टेस्ट को शामिल या बाहर करने के लिए टैग फ़िल्टरिंग। - टेस्ट परिणामों के लिए फ़ॉर्मेटेड, रंगीन टर्मिनल आउटपुट। सेटअप पथ: - TypeScript: vitest और @swedevtools/livedoc-vitest को डेव निर्भरता के रूप में स्थापित करें, फिर टेस्ट संरचना के लिए feature, scenario, given, when और then हेल्पर्स आयात करें। - C#: SweDevTools.LiveDoc.xUnit पैकेज जोड़ें और टेस्ट क्लास को FeatureTest से व्युत्पन्न करें, [Feature] और [Scenario] विशेषताओं के साथ-साथ Given/When/Then विधियों का उपयोग करें। - README एक AI-सहायता प्राप्त सेटअप प्रवाह का भी वर्णन करता है जहां एक कोडिंग सहायक एक होस्ट किए गए सेटअप गाइड को पढ़ता है और रिपॉजिटरी को कॉन्फ़िगर करता है, परिवर्तन करने से पहले एक-एक करके कॉन्फ़िगरेशन प्रश्न पूछता है। दो वर्कस्पेस पैकेज, @swedevtools/livedoc-schema और @swedevtools/livedoc-server, निजी हैं और स्वतंत्र रूप से प्रकाशित होने के बजाय व्यूअर वितरण में एम्बेड किए गए हैं। परियोजना MIT लाइसेंस प्राप्त है और संबंधित स्टैक के लिए Node.js 18+ और .NET 8.0 की आवश्यकता है।