qfai 0.3.0 → 0.3.1

package/README.md

@@ -1,4 +1,4 @@
-# QFAI Toolkit (v0.3.0)
+# QFAI Toolkit (v0.3.1)
 
 Single-package distribution for QFAI.
 
@@ -12,17 +12,15 @@ npm i -D qfai
 
 ```
 npx qfai init
-npx qfai validate --fail-on error --format github --json-path .qfai/out/validate.json
-npx qfai report --json-path .qfai/out/validate.json --out .qfai/out/report.md
+npx qfai validate --fail-on error --format github
+npx qfai report
 ```
 
 ## Usage
 
-`validate` は `--fail-on` / `--strict` によって CI ゲート化できます。
-JSON 出力は `--json-path` 指定、または `qfai.config.yaml` の `output.format: json` で有効化できます。
-`report` は `validate.json` が必須で、未生成の場合は exit code 2 で次の手順を案内します。
-`report` の入力は `--json-path` が優先で、未指定の場合は `output.jsonPath` を使います。どちらも未設定の場合はレポートを生成できないため、いずれかを必ず指定してください。既定の出力は `.qfai/out/report.md`（`--format json` の場合は `.qfai/out/report.json`）です。
-`init --yes` は非対話でデフォルトを採用します（現状の init は非対話が既定のため挙動は同じです。将来対話が導入されても自動で承認されます）。既存ファイルがある場合は `--force` が必要です。
+`validate` は `--fail-on` / `--strict` によって CI ゲート化できます。`validate` は常に `.qfai/out/validate.json`（`output.validateJsonPath`）へ JSON を出力し、`--format` は表示形式（text/github）のみを制御します。
+`report` は `.qfai/out/validate.json` を読み、既定で `.qfai/out/report.md` を出力します（`--format json` の場合は `.qfai/out/report.json`）。出力先は `--out` で変更できます。入力パスは固定です。
+`init --yes` は予約フラグです（v0.3.1 の init は非対話のため挙動差はありません）。既存ファイルがある場合は `--force` が必要です。
 
 設定はリポジトリ直下の `qfai.config.yaml` で行います。
 命名規約は `docs/rules/naming.md` を参照してください。

package/assets/init/.qfai/README.md

@@ -5,22 +5,23 @@
 ## 最短成功（init → validate → report）
 
 ```bash
-npx qfai validate --fail-on error --format github --json-path .qfai/out/validate.json
-npx qfai report --json-path .qfai/out/validate.json --out .qfai/out/report.md
+npx qfai validate --fail-on error --format github
+npx qfai report
 ```
 
 ## ディレクトリ概要
 
-- `spec/` : 仕様・シナリオ・ADR（意思決定）を置く場所
+- `specs/` : Spec Pack（spec.md / delta.md / scenario.md）
 - `contracts/` : UI / API / DB 契約を置く場所
+- `rules/` : 規約・運用ルール
 - `prompts/` : 生成プロンプト資産（自動読取はしない）
 - `out/` : `validate` / `report` の出力先（gitignore 推奨）
 
 詳細は各 README を参照してください。
 
-- `spec/README.md`
-- `spec/decisions/README.md`
+- `specs/README.md`
 - `contracts/README.md`
+- `rules/conventions.md`
 - `prompts/README.md`
 - `out/README.md`
 

package/assets/init/.qfai/rules/conventions.md

@@ -0,0 +1,21 @@
+# 互換維持 / 仕様変更の分類ルール
+
+本ドキュメントは `delta.md` の「変更区分」を一貫させるための規約です。
+
+## Compatibility（互換維持）
+
+- 既存の仕様と整合しており、期待値の変更がない
+- 既存の受入テスト/シナリオがそのまま成立する
+- 互換性の維持を前提とした改善・整理に留まる
+
+## Change/Improvement（改善/仕様変更）
+
+- 期待値や振る舞いが変更される、または明確に追加される
+- 既存の受入テスト/シナリオの修正が必要になる
+- 互換性の破壊または新しい制約が生じる
+
+## 運用ルール
+
+- `delta.md` では **必ずどちらか1つにチェック**する
+- 両方ON/両方OFFは無効（エラー）
+- 迷った場合は「影響範囲」「受入観点」を追記して明文化する

package/assets/init/.qfai/specs/README.md

@@ -0,0 +1,51 @@
+# Specs (Spec Pack)
+
+このディレクトリは「Spec / Delta / Scenario」を **1セット（Spec Pack）** として管理するための入口です。
+
+## 置くべきファイル
+
+- `spec-001/spec.md`（必須）
+- `spec-001/delta.md`（必須）
+- `spec-001/scenario.md`（必須・Gherkin）
+
+> `spec-001` は **3桁連番**。Spec ID は **4桁（SPEC-0001）** を継続します。
+
+## Spec（spec.md）最小例
+
+```md
+# SPEC-0001: 注文登録の最小要件
+
+## 背景
+
+- 例: 受注の登録ルールを明文化し、手戻りを減らすため
+
+## 業務ルール
+
+- [BR-0001][P2] 受注は承認者が承認するまで確定しない
+```
+
+### BR の書き方
+
+- **1ルール = 1 BR** を守る
+- Priority は **P0/P1/P2/P3** のいずれかを必ず付与
+- BR 定義は **`## 業務ルール` セクション内のみ**（他セクションは参照扱い）
+
+## Delta（delta.md）
+
+- 互換維持 / 仕様変更の **どちらか1つ**に必ずチェックする
+- 根拠と影響範囲を明記する
+
+## Scenario（scenario.md）最小要件
+
+- **Gherkin 記法**（Given/When/Then）
+- `@SPEC-xxxx` は Feature レベルに置ける（Feature/Scenario のいずれかで必須）
+- Scenario / Scenario Outline には `@SC-xxxx` が **ちょうど1つ**必要
+- Scenario / Scenario Outline には `@BR-xxxx` が **1つ以上**必要
+
+## CI でチェックされること（抜粋）
+
+- Spec: 必須セクション、SPEC/BR ID、BR Priority、ID 形式、Contract 参照の実在性
+- Delta: 変更区分（互換/変更）のチェック状態
+- Scenario: Feature/Scenario の存在、タグ要件、Given/When/Then
+- Traceability: BR→SC、SC→契約（UI/API/DATA）の接続、BR の所属 SPEC 整合
+- IDs: 定義 ID の重複検知（Spec/Scenario/Contracts）

package/assets/init/.qfai/specs/spec-001/delta.md

@@ -0,0 +1,30 @@
+# Delta: SPEC-0001
+
+## 変更区分
+
+- [x] Compatibility（互換維持: 既存仕様と整合）
+- [ ] Change/Improvement（改善/仕様変更: 期待値の変更を含む）
+
+## 変更の要約（What）
+
+- ...
+
+## 根拠（Why）
+
+- ...
+
+## 影響範囲（Impact）
+
+- 仕様（spec.md）:
+- シナリオ（scenario.md）:
+- 契約（contracts）:
+- 実装（src）:
+- テスト（tests）:
+
+## 受入観点（ATDD/QA）
+
+- ...
+
+## 移行メモ（任意）
+
+- ...

package/assets/init/.qfai/specs/spec-001/scenario.md

@@ -0,0 +1,10 @@
+@SPEC-0001
+Feature: 注文登録
+
+Rule: 承認者が存在する
+
+    @SC-0001 @BR-0001 @UI-0001 @API-0001 @DATA-0001
+    Scenario: 承認者が承認するまで注文は確定しない
+      Given ...
+      When ...
+      Then ...

package/assets/init/.qfai/{spec/spec-0001-sample.md → specs/spec-001/spec.md}

@@ -28,10 +28,11 @@
 
 ## 業務ルール
 
-- [BR-0001] (P2) 受注は承認者が承認するまで確定しない
+- [BR-0001][P2] 受注は承認者が承認するまで確定しない
 
 ### 書き方メモ
 
 - BR は **原子ルール** として採番する（`BR-0001.1` は使わない）
-- BR には **Priority(P0〜P3)** を付与する
+- BR には **Priority(P0〜P3)** を必ず付与する
+- BR 定義は `## 業務ルール` セクション内に置く
 - Spec では **SC ID** を参照しない

package/assets/init/root/.github/workflows/qfai.yml

@@ -15,7 +15,7 @@ jobs:
           node-version: 20
           cache: npm
       - run: npm ci
-      - run: npx qfai validate --fail-on error --format github --json-path .qfai/out/validate.json
+      - run: npx qfai validate --fail-on error --format github
       - uses: actions/upload-artifact@v4
         with:
           name: qfai-validation

package/assets/init/root/qfai.config.yaml

@@ -1,11 +1,9 @@
 paths:
-  specDir: .qfai/spec
-  decisionsDir: .qfai/spec/decisions
-  scenariosDir: .qfai/spec/scenarios
+  specsDir: .qfai/specs
   contractsDir: .qfai/contracts
-  uiContractsDir: .qfai/contracts/ui
-  apiContractsDir: .qfai/contracts/api
-  dataContractsDir: .qfai/contracts/db
+  rulesDir: .qfai/rules
+  outDir: .qfai/out
+  promptsDir: .qfai/prompts
   srcDir: src
   testsDir: tests
 validation:
@@ -25,5 +23,4 @@ validation:
     allowOrphanContracts: false
     unknownContractIdSeverity: error
 output:
-  format: text
-  jsonPath: .qfai/out/validate.json
+  validateJsonPath: .qfai/out/validate.json