Skip to content

使用ガイド

基本的な使い方

最も基本的な使い方は、テストケースを含むマークダウンファイルを変換することです：

markdown_to_testcase convert -i input_file.md

これにより、以下の処理が行われます： 1. 入力ファイルからすべてのテストケースを解析 2. yamllintを使用してYAML構文を検証 3. テストケースセクションごとにCSVファイルを作成 4. すべてのテストケースを含む単一のExcelファイルを作成

コマンドラインオプション

必須オプション

  • -i, --input: 入力するマークダウンまたはYAMLファイルのパス（必須）

オプション項目

  • -o, --output-dir: 出力ファイルを保存するディレクトリ（デフォルト：output）
  • -F, --force: 確認なしで出力ファイルを上書き
  • -d, --debug: デバッグモードを有効化（DEBUGレベルのログを出力）
  • --verbose: YAML解析の問題に関する詳細なエラーメッセージと提案を表示
  • --no-yaml-lint: YAML内容に対するyamllintの実行をスキップ（検証はデフォルトで有効）
  • -v, --version: バージョン情報を表示

YAMLファイルの使用

YAMLファイルを直接提供することもできます：

markdown_to_testcase convert -i testcases.yaml

YAMLファイルは以下の構造に従う必要があります：

filename1.md:
  - ID: TC001
    Name: テストケース名
    # ... 他のフィールド
  - ID: TC002
    Name: 別のテストケース
    # ... 他のフィールド

filename2.md:
  - ID: TC101
    Name: 別のファイル用のテストケース
    # ... 他のフィールド

出力ファイル

このツールは以下の出力を生成します：

  1. CSVファイル: テストケースセクションごとに1つのCSVファイル。セクションヘッダーのファイル名に基づいて命名されます。
  2. Excelファイル: すべてのテストケースを含む単一のtest_cases.xlsxファイル。各セクションは別々のシートとして表示されます。

デフォルトでは、すべての出力ファイルはoutputディレクトリに保存されます。-oオプションを使用してこれを変更できます。

デバッグとVerboseモード

トラブルシューティングのために、デバッグとverboseオプションを使用できます：

markdown_to_testcase convert -i input_file.md -d --verbose

これにより、より詳細なログが表示され、YAML解析が失敗した場合に提案が提供されます。