livedoc

LiveDocは、チームが既存のテストフレームワーク内でGherkinスタイルのGiven/When/Then構文を直接使用して実行可能な仕様を記述できるリビングドキュメンテーションプラットフォームです。別の機能ファイル（Featureファイル）を維持管理する代わりに、仕様はテストコード内に存在し、ドキュメントとしても機能します。 提供機能： - Vitest（TypeScript/JavaScript）向けに @swedevtools/livedoc-vitest を、xUnit（.NET）向けに SweDevTools.LiveDoc.xUnit を通じたGherkin構文サポート。 - テスト結果を実行中にリアルタイムで表示するWeb 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支援セットアップフローについても記載されています。 2つのワークスペースパッケージ、@swedevtools/livedoc-schemaと@swedevtools/livedoc-serverはプライベートであり、独立して公開されるのではなく、ビューア配布物に組み込まれています。このプロジェクトはMITライセンスであり、対応するスタックにはNode.js 18以上と.NET 8.0が必要です。