ai-check-template 0.2.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README-ja.md +151 -0
- package/README.md +149 -0
- package/bin/ai-check-template.mjs +7 -0
- package/docs/cli.md +348 -0
- package/package-templates/.claude/README.md +83 -0
- package/package-templates/.claude/rules/test-rules.md +46 -0
- package/package-templates/.claude/settings.hook-fragment.json +25 -0
- package/package-templates/README.md +56 -0
- package/package-templates/ci-examples/README.md +134 -0
- package/package-templates/ci-examples/github-actions/ai-check-fast.yml +49 -0
- package/package-templates/ci-examples/github-actions/ai-check.yml +58 -0
- package/package-templates/ci-examples/github-actions/ai-quality-call.yml +26 -0
- package/package-templates/ci-examples/github-actions/ai-quality-reusable.yml +113 -0
- package/package-templates/docs/philosophy/formal-name-match.md +182 -0
- package/package-templates/docs/philosophy/given-when-then.md +206 -0
- package/package-templates/docs/philosophy/qa-techniques.md +235 -0
- package/package-templates/docs/philosophy/test-pyramid.md +171 -0
- package/package-templates/docs/test-design-template.md +173 -0
- package/package-templates/package.scripts.fragment.json +6 -0
- package/package-templates/profiles/README.md +89 -0
- package/package-templates/profiles/expo-rn/README.md +80 -0
- package/package-templates/profiles/node-cli/README.md +93 -0
- package/package-templates/profiles/react-nextjs/README.md +82 -0
- package/package-templates/profiles/react-vanilla/README.md +73 -0
- package/package-templates/profiles/supabase-rls/README.md +89 -0
- package/package-templates/prompts/README.md +94 -0
- package/package-templates/prompts/boundary-value.md +94 -0
- package/package-templates/prompts/decision-table.md +82 -0
- package/package-templates/prompts/diagnostic-repair.md +149 -0
- package/package-templates/prompts/plan-first.md +122 -0
- package/package-templates/prompts/rls-permission.md +94 -0
- package/package-templates/prompts/state-transition.md +81 -0
- package/package-templates/scripts/README.md +78 -0
- package/package-templates/scripts/ai-check-fast.sh +20 -0
- package/package-templates/scripts/ai-check.sh +22 -0
- package/package.json +47 -0
- package/src/cli/ci-workflows.mjs +104 -0
- package/src/cli/claude-hooks.mjs +94 -0
- package/src/cli/dependency-installer.mjs +164 -0
- package/src/cli/doctor.mjs +392 -0
- package/src/cli/index.mjs +80 -0
- package/src/cli/init.mjs +433 -0
- package/src/cli/install-state.mjs +242 -0
- package/src/cli/package-manager.mjs +78 -0
- package/src/cli/profile-diagnostics.mjs +160 -0
- package/src/cli/profile-docs.mjs +31 -0
- package/src/cli/profile-scripts.mjs +96 -0
- package/src/cli/profile.mjs +59 -0
- package/src/cli/update.mjs +537 -0
- package/src/cli/utils.mjs +75 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README-ja.md
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# ai-check-template(日本語版)
|
|
2
|
+
|
|
3
|
+
**AI が生成したコードを、そのまま信じない。**
|
|
4
|
+
|
|
5
|
+
`ai-check-template` は、AI が書いたコードを**検証・修正・安全にマージする**ためのテンプレート集です。
|
|
6
|
+
|
|
7
|
+
> 「AI が実装しました」
|
|
8
|
+
|
|
9
|
+
から、
|
|
10
|
+
|
|
11
|
+
> 「AI が実装し、検査を通過し、リスクが可視化され、人間が証拠付きで受け入れた」
|
|
12
|
+
|
|
13
|
+
への移行を支援します。
|
|
14
|
+
|
|
15
|
+
> English version: [`README.md`](./README.md)
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## What is this? / これは何?
|
|
20
|
+
|
|
21
|
+
AI 駆動開発のためのテンプレート集。以下を提供:
|
|
22
|
+
|
|
23
|
+
- AI 生成コード向けの**テスト設計思想**(Test Pyramid / Given-When-Then / QA 技法 / 形名参同)
|
|
24
|
+
- 実装前に成功基準を AI に宣言させる **AI プロンプト雛形**
|
|
25
|
+
- `ai:check` **実行スタック**(npm scripts / Claude Code hooks / シェルエントリポイント)
|
|
26
|
+
- 同じ `ai:check` を PR で走らせる **GitHub Actions テンプレ**(direct workflow / reusable workflow example)
|
|
27
|
+
- 主要スタック向け**プロファイル**(Next.js / vanilla React / Expo / Node CLI / Supabase + RLS)
|
|
28
|
+
- 安全な初期導入のための alpha **CLI foundation**
|
|
29
|
+
|
|
30
|
+
必要な部分をコピーして自プロジェクトに合わせ、検証可能なループを得る。特定の LLM・フレームワーク・ベンダーに依存しない設計。
|
|
31
|
+
|
|
32
|
+
## Why? / なぜ?
|
|
33
|
+
|
|
34
|
+
AI コーディングツール(Claude Code / Codex / Cursor 等)は実装を速くするが、**検証を速くはしない**。
|
|
35
|
+
|
|
36
|
+
実務で AI 生成コードはよく以下に陥る:
|
|
37
|
+
|
|
38
|
+
- 目視チェックは通るが、型 / lint / E2E で落ちる
|
|
39
|
+
- 動いて見えるが、認可 / RLS / レート制限を無視している
|
|
40
|
+
- 未使用 export / 不要コード / 意図しないスコープ拡散が残る
|
|
41
|
+
- 「完了しました」と自己申告するが、実際は部分完了
|
|
42
|
+
|
|
43
|
+
本リポは**形名参同**(事前宣言した成功基準と実測値の照合)を中核に据える。AI に自己採点させない。
|
|
44
|
+
|
|
45
|
+
## Core loop / 中核ループ
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
要件
|
|
49
|
+
↓
|
|
50
|
+
受け入れ条件(Given-When-Then)
|
|
51
|
+
↓
|
|
52
|
+
テスト設計(QA 技法: 同値分割 / 境界値 / デシジョンテーブル / 状態遷移 / RLS 権限)
|
|
53
|
+
↓
|
|
54
|
+
AI 実装
|
|
55
|
+
↓
|
|
56
|
+
品質チェック(typecheck → lint → unit → diagnostics → E2E smoke)
|
|
57
|
+
↓
|
|
58
|
+
修正(AI が同一セッションで自動修正)
|
|
59
|
+
↓
|
|
60
|
+
再チェック
|
|
61
|
+
↓
|
|
62
|
+
人間の受け入れ判断(証拠付き)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
各ステップに対応するテンプレ・プロンプトを配布します。
|
|
66
|
+
|
|
67
|
+
## What you get / 提供物
|
|
68
|
+
|
|
69
|
+
| レイヤ | 内容 |
|
|
70
|
+
|---|---|
|
|
71
|
+
| **思想ドキュメント** | [`formal-name-match.md`](./package-templates/docs/philosophy/formal-name-match.md)(形名参同)、[`test-pyramid.md`](./package-templates/docs/philosophy/test-pyramid.md)(責務分割)、[`given-when-then.md`](./package-templates/docs/philosophy/given-when-then.md)(GWT)、[`qa-techniques.md`](./package-templates/docs/philosophy/qa-techniques.md)(QA 技法) |
|
|
72
|
+
| **テスト設計** | [`test-design-template.md`](./package-templates/docs/test-design-template.md) は要件を AC / Test Matrix / 検証コマンドへ落とすテンプレート |
|
|
73
|
+
| **AI プロンプト雛形** | `decision-table` / `state-transition` / `boundary-value` / `rls-permission` / `plan-first` / [`diagnostic-repair.md`](./package-templates/prompts/diagnostic-repair.md) |
|
|
74
|
+
| **実行スタック** | `scripts/ai-check.sh`、`scripts/ai-check-fast.sh`、`.claude/settings.hook-fragment.json`、`.claude/rules/test-rules.md`、`package.scripts.fragment.json` |
|
|
75
|
+
| **CI テンプレ** | GitHub Actions `ai-check.yml`(フル)、`ai-check-fast.yml`(PR の fast ループ)、reusable workflow examples |
|
|
76
|
+
| **Examples** | [`examples/nextjs-basic`](./examples/nextjs-basic/) は AI 生成コードの Before / After を示す runnable example |
|
|
77
|
+
| **プロファイル** | `react-nextjs` / `react-vanilla` / `expo-rn` / `node-cli` / `supabase-rls` |
|
|
78
|
+
| **CLI alpha** | [`docs/cli.md`](./docs/cli.md) は repository-local `init` command、read-only `doctor` command、guarded `update` command、install state(`.ai-check-template.json`)、profile-aware package script migrations、profile docs migration、support script defaults、`pnpm` / `npm` / `yarn` / `bun` の package manager detection と Claude hook / CI workflow command rendering、optional `--install-deps` npm dev dependency install、exact-managed workflow cleanup、advisory profile / missing-script diagnostics warnings、stale managed CI diagnostics、`doctor --strict`、`--profile`、`--package-manager`、`--ci`、`--claude-hooks`、`--dry-run`、`--overwrite`、`npm pack` readiness、`npm publish --dry-run --tag next` preflight を説明 |
|
|
79
|
+
| **プロジェクト docs** | [`docs/vision.md`](./docs/vision.md)、[`docs/roadmap.md`](./docs/roadmap.md)、Phase 1 dogfooding プロトコル、[`初回 dogfooding report`](./docs/phase-1-initial-dogfooding-report.md) |
|
|
80
|
+
|
|
81
|
+
## Quick start / 最短手順
|
|
82
|
+
|
|
83
|
+
> v0.1.0 は「コピー&カスタマイズ」型としてリリース済み。詳細は [`docs/releases/v0.1.0.md`](./docs/releases/v0.1.0.md)。repository-local の v0.2.0 alpha CLI、install state、profile-aware package script migrations、profile docs migration、support script defaults、package manager detection、package-manager-aware Claude hook / CI workflow rendering、optional `--install-deps`、exact-managed workflow cleanup、advisory profile / missing-script / stale managed CI diagnostics と `doctor --strict`、`npm pack` readiness、`npm publish --dry-run --tag next` preflight は [`docs/cli.md`](./docs/cli.md) を参照。actual npm / `npx ai-check-template init` 公開は今後の作業です。
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
# 1. リポをクローン
|
|
87
|
+
git clone https://github.com/heidayo/ai-check-template.git
|
|
88
|
+
|
|
89
|
+
# 2. alpha CLI init を dry-run するか、手動コピー用 profile を確認
|
|
90
|
+
node ai-check-template/bin/ai-check-template.mjs init --target . --profile react-nextjs --dry-run
|
|
91
|
+
node ai-check-template/bin/ai-check-template.mjs init --target . --profile react-nextjs --install-deps --dry-run
|
|
92
|
+
node ai-check-template/bin/ai-check-template.mjs init --target . --profile node-cli --package-manager npm --dry-run
|
|
93
|
+
node ai-check-template/bin/ai-check-template.mjs doctor --target . --ci none
|
|
94
|
+
node ai-check-template/bin/ai-check-template.mjs doctor --target . --strict --json
|
|
95
|
+
node ai-check-template/bin/ai-check-template.mjs update --target . --dry-run
|
|
96
|
+
|
|
97
|
+
# 3. スタックに合う profile を確認
|
|
98
|
+
cat ai-check-template/package-templates/profiles/react-nextjs/README.md
|
|
99
|
+
|
|
100
|
+
# 4. 必要なファイルを自プロジェクトにコピー
|
|
101
|
+
cp -r ai-check-template/package-templates/scripts ./scripts
|
|
102
|
+
cp -r ai-check-template/package-templates/.claude ./.claude
|
|
103
|
+
cp ai-check-template/package-templates/ci-examples/github-actions/ai-check.yml .github/workflows/
|
|
104
|
+
cp ai-check-template/package-templates/ci-examples/github-actions/ai-check-fast.yml .github/workflows/
|
|
105
|
+
# reusable workflow 方式にしたい場合は ai-quality-reusable.yml + ai-quality-call.yml をコピー
|
|
106
|
+
|
|
107
|
+
# 5. scripts fragment を package.json にマージ
|
|
108
|
+
cat ai-check-template/package-templates/package.scripts.fragment.json
|
|
109
|
+
# 出力の "ai:check" / "ai:check:fast" を自プロジェクトの package.json の scripts に追加
|
|
110
|
+
|
|
111
|
+
# 6. ループを回す
|
|
112
|
+
pnpm ai:check
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
実行できる Before / After の例は [`examples/nextjs-basic`](./examples/nextjs-basic/) を参照。自分のタスクを実装前に整理する場合は [`test-design-template.md`](./package-templates/docs/test-design-template.md) から始め、`ai:check` や CI の diagnostic が失敗したら [`diagnostic-repair.md`](./package-templates/prompts/diagnostic-repair.md) を使います。
|
|
116
|
+
|
|
117
|
+
詳細は [`docs/roadmap.md`](./docs/roadmap.md) と各 profile の README([`package-templates/profiles/`](./package-templates/profiles/))を参照。
|
|
118
|
+
|
|
119
|
+
## Supported profiles / 対応プロファイル
|
|
120
|
+
|
|
121
|
+
| Profile | 対象スタック | 注意点 |
|
|
122
|
+
|---|---|---|
|
|
123
|
+
| [`react-nextjs`](./package-templates/profiles/react-nextjs/) | Next.js App Router + TypeScript | フル toolchain(RD / Knip / Playwright / Semgrep) |
|
|
124
|
+
| [`react-vanilla`](./package-templates/profiles/react-vanilla/) | 純 React + TypeScript(Vite / CRA) | Next.js 固有の React Doctor 診断は対象外 |
|
|
125
|
+
| [`expo-rn`](./package-templates/profiles/expo-rn/) | Expo / React Native | React Doctor 非対応。E2E は Maestro / Detox |
|
|
126
|
+
| [`node-cli`](./package-templates/profiles/node-cli/) | Node CLI / Library | UI / E2E なし、Static + Unit 中心 |
|
|
127
|
+
| [`supabase-rls`](./package-templates/profiles/supabase-rls/) | Supabase + RLS(addon) | 他 profile と組み合わせ(例: `react-nextjs+supabase-rls`) |
|
|
128
|
+
|
|
129
|
+
## Roadmap
|
|
130
|
+
|
|
131
|
+
| バージョン | テーマ | 状態 |
|
|
132
|
+
|---|---|---|
|
|
133
|
+
| **v0.1.0** | 手動コピーで使うテンプレ集 | Released([notes](./docs/releases/v0.1.0.md)) |
|
|
134
|
+
| **v0.2.0** | CLI scaffolding(`npx ai-check-template init`) | 進行中([alpha CLI docs + `npm pack` readiness](./docs/cli.md)) |
|
|
135
|
+
| **v0.3.0+** | Reusable workflow + Composite Action(GitHub Marketplace) | 計画中 |
|
|
136
|
+
|
|
137
|
+
詳細: [`docs/roadmap.md`](./docs/roadmap.md)。
|
|
138
|
+
|
|
139
|
+
## Contributing / 貢献
|
|
140
|
+
|
|
141
|
+
貢献を歓迎します。PR フロー / レーン選択は [`CONTRIBUTING.md`](./CONTRIBUTING.md)、コミュニティ規範は [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)、脆弱性報告は [`SECURITY.md`](./SECURITY.md) を参照。
|
|
142
|
+
|
|
143
|
+
Issue / PR テンプレートは [`.github/`](./.github/) 配下。
|
|
144
|
+
|
|
145
|
+
## License
|
|
146
|
+
|
|
147
|
+
[Apache-2.0](./LICENSE)
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
> 本リポ自身も [SAGE Development System](https://github.com/heidayo/sage-ai-template)(Spec → Plan → Task → Execute → Verify)で開発しています。利用者は SAGE インストール不要(テンプレを使う側は SAGE 非依存)。SAGE 共存は opt-in。詳細は [`CONTRIBUTING.md`](./CONTRIBUTING.md) を参照。
|
package/README.md
ADDED
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
# ai-check-template
|
|
2
|
+
|
|
3
|
+
**AI-generated code should not be trusted by default.**
|
|
4
|
+
|
|
5
|
+
`ai-check-template` provides reusable templates for **verifying, repairing, and safely merging AI-generated code**. It helps teams move from:
|
|
6
|
+
|
|
7
|
+
> "AI implemented it."
|
|
8
|
+
|
|
9
|
+
to:
|
|
10
|
+
|
|
11
|
+
> "AI implemented it, checks passed, risks are visible, and humans can accept it with evidence."
|
|
12
|
+
|
|
13
|
+
> 日本語版 / Japanese: [`README-ja.md`](./README-ja.md)
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## What is this?
|
|
18
|
+
|
|
19
|
+
A template collection for AI-driven development. It bundles:
|
|
20
|
+
|
|
21
|
+
- A **testing philosophy** built for AI-written code (Test Pyramid, Given-When-Then, QA techniques, Formal Name Match)
|
|
22
|
+
- **AI prompt templates** that force the model to declare success criteria before implementing
|
|
23
|
+
- An **`ai:check` execution stack** (npm scripts, Claude Code hooks, shell entry points)
|
|
24
|
+
- **GitHub Actions templates** that run the same `ai:check` on every PR, including direct and reusable workflow examples
|
|
25
|
+
- **Profiles** for common stacks (Next.js, vanilla React, Expo, Node CLI, Supabase + RLS)
|
|
26
|
+
- An alpha **CLI foundation** for safer repository-local initialization
|
|
27
|
+
|
|
28
|
+
You copy what you need, adapt to your project, and get a verifiable loop — without depending on any specific LLM, framework, or vendor.
|
|
29
|
+
|
|
30
|
+
## Why?
|
|
31
|
+
|
|
32
|
+
AI coding tools (Claude Code, Codex, Cursor) make implementation fast. They do not make verification fast.
|
|
33
|
+
|
|
34
|
+
In practice, AI-generated code often:
|
|
35
|
+
|
|
36
|
+
- Passes a quick eyeball check, then fails type / lint / E2E
|
|
37
|
+
- Looks correct, but ignores authorization, RLS, or rate limiting
|
|
38
|
+
- Leaves dead code, unused exports, or accidental scope drift
|
|
39
|
+
- Self-reports "Done" when reality is "Partially done"
|
|
40
|
+
|
|
41
|
+
`ai-check-template` is built around the principle of **Formal Name Match** (形名参同): declare the success criteria **before** implementation, then mechanically compare against the actual evidence after. AI cannot self-grade.
|
|
42
|
+
|
|
43
|
+
## Core loop
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
Requirement
|
|
47
|
+
↓
|
|
48
|
+
Acceptance Criteria (Given-When-Then)
|
|
49
|
+
↓
|
|
50
|
+
Test Design (QA techniques: equivalence partitioning, boundary value, decision table, state transition, RLS permission)
|
|
51
|
+
↓
|
|
52
|
+
AI Implementation
|
|
53
|
+
↓
|
|
54
|
+
Quality Check (typecheck → lint → unit → diagnostics → E2E smoke)
|
|
55
|
+
↓
|
|
56
|
+
Repair (AI auto-fix in the same session)
|
|
57
|
+
↓
|
|
58
|
+
Re-check
|
|
59
|
+
↓
|
|
60
|
+
Human Acceptance (with evidence)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
The repository ships templates and prompts for every step in this loop.
|
|
64
|
+
|
|
65
|
+
## What you get
|
|
66
|
+
|
|
67
|
+
| Layer | Contents |
|
|
68
|
+
|---|---|
|
|
69
|
+
| **Philosophy** | [`formal-name-match.md`](./package-templates/docs/philosophy/formal-name-match.md), [`test-pyramid.md`](./package-templates/docs/philosophy/test-pyramid.md), [`given-when-then.md`](./package-templates/docs/philosophy/given-when-then.md), [`qa-techniques.md`](./package-templates/docs/philosophy/qa-techniques.md) |
|
|
70
|
+
| **Test design** | [`test-design-template.md`](./package-templates/docs/test-design-template.md) maps requirements to acceptance criteria, test matrix rows, and verification commands |
|
|
71
|
+
| **Prompts** | `decision-table` / `state-transition` / `boundary-value` / `rls-permission` / `plan-first` / [`diagnostic-repair.md`](./package-templates/prompts/diagnostic-repair.md) |
|
|
72
|
+
| **Execution stack** | `scripts/ai-check.sh`, `scripts/ai-check-fast.sh`, `.claude/settings.hook-fragment.json`, `.claude/rules/test-rules.md`, `package.scripts.fragment.json` |
|
|
73
|
+
| **CI templates** | GitHub Actions `ai-check.yml` (full), `ai-check-fast.yml` (PR-only fast loop), and reusable workflow examples |
|
|
74
|
+
| **Examples** | [`examples/nextjs-basic`](./examples/nextjs-basic/) shows a Before / After of AI-generated code under `ai-check-template` |
|
|
75
|
+
| **Profiles** | `react-nextjs`, `react-vanilla`, `expo-rn`, `node-cli`, `supabase-rls` |
|
|
76
|
+
| **CLI alpha** | [`docs/cli.md`](./docs/cli.md) documents the repository-local `init`, read-only `doctor`, and guarded `update` commands, install state (`.ai-check-template.json`), profile-aware package script migrations, profile docs migration, support script defaults, package manager detection plus Claude hook and CI workflow command rendering for `pnpm` / `npm` / `yarn` / `bun`, optional `--install-deps` npm dev dependency install, exact-managed workflow cleanup, advisory profile and missing-script diagnostics warnings, stale managed CI diagnostics, `doctor --strict`, `--profile`, `--package-manager`, `--ci`, `--claude-hooks`, `--dry-run`, `--overwrite`, `npm pack` readiness, and `npm publish --dry-run --tag next` preflight |
|
|
77
|
+
| **Project docs** | [`docs/vision.md`](./docs/vision.md), [`docs/roadmap.md`](./docs/roadmap.md), Phase 1 dogfooding protocol, [`initial dogfooding report`](./docs/phase-1-initial-dogfooding-report.md) |
|
|
78
|
+
|
|
79
|
+
## Quick start
|
|
80
|
+
|
|
81
|
+
> v0.1.0 is released as "copy & adapt." See [`docs/releases/v0.1.0.md`](./docs/releases/v0.1.0.md). A repository-local v0.2.0 alpha CLI, install state, profile-aware package script migrations, profile docs migration, support script defaults, package manager detection, package-manager-aware Claude hook and CI workflow rendering, optional `--install-deps`, exact-managed workflow cleanup, advisory profile / missing-script / stale managed CI diagnostics with `doctor --strict`, `npm pack` readiness, and `npm publish --dry-run --tag next` preflight are available in [`docs/cli.md`](./docs/cli.md); actual npm / `npx ai-check-template init` publishing is still future work.
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# 1. Clone or browse the templates
|
|
85
|
+
git clone https://github.com/heidayo/ai-check-template.git
|
|
86
|
+
|
|
87
|
+
# 2. Preview the alpha CLI init, or pick a profile and copy manually
|
|
88
|
+
node ai-check-template/bin/ai-check-template.mjs init --target . --profile react-nextjs --dry-run
|
|
89
|
+
node ai-check-template/bin/ai-check-template.mjs init --target . --profile react-nextjs --install-deps --dry-run
|
|
90
|
+
node ai-check-template/bin/ai-check-template.mjs init --target . --profile node-cli --package-manager npm --dry-run
|
|
91
|
+
node ai-check-template/bin/ai-check-template.mjs doctor --target . --ci none
|
|
92
|
+
node ai-check-template/bin/ai-check-template.mjs doctor --target . --strict --json
|
|
93
|
+
node ai-check-template/bin/ai-check-template.mjs update --target . --dry-run
|
|
94
|
+
|
|
95
|
+
# 3. Pick a profile that matches your stack
|
|
96
|
+
cat ai-check-template/package-templates/profiles/react-nextjs/README.md
|
|
97
|
+
|
|
98
|
+
# 4. Copy what you need into your project
|
|
99
|
+
cp -r ai-check-template/package-templates/scripts ./scripts
|
|
100
|
+
cp -r ai-check-template/package-templates/.claude ./.claude
|
|
101
|
+
cp ai-check-template/package-templates/ci-examples/github-actions/ai-check.yml .github/workflows/
|
|
102
|
+
cp ai-check-template/package-templates/ci-examples/github-actions/ai-check-fast.yml .github/workflows/
|
|
103
|
+
# Or copy ai-quality-reusable.yml + ai-quality-call.yml if you prefer reusable workflows.
|
|
104
|
+
|
|
105
|
+
# 5. Merge the scripts fragment into your package.json
|
|
106
|
+
cat ai-check-template/package-templates/package.scripts.fragment.json
|
|
107
|
+
# Then add the "ai:check" and "ai:check:fast" entries to your package.json "scripts"
|
|
108
|
+
|
|
109
|
+
# 6. Run the loop
|
|
110
|
+
pnpm ai:check
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
To inspect a runnable Before / After example, see [`examples/nextjs-basic`](./examples/nextjs-basic/). To prepare your own task before implementation, start from [`test-design-template.md`](./package-templates/docs/test-design-template.md), then use [`diagnostic-repair.md`](./package-templates/prompts/diagnostic-repair.md) when `ai:check` or CI returns a failing diagnostic.
|
|
114
|
+
|
|
115
|
+
Detailed walkthrough: see [`docs/roadmap.md`](./docs/roadmap.md) and the per-profile README under [`package-templates/profiles/`](./package-templates/profiles/).
|
|
116
|
+
|
|
117
|
+
## Supported profiles
|
|
118
|
+
|
|
119
|
+
| Profile | Target stack | Notes |
|
|
120
|
+
|---|---|---|
|
|
121
|
+
| [`react-nextjs`](./package-templates/profiles/react-nextjs/) | Next.js App Router + TypeScript | Full toolchain (RD / Knip / Playwright / Semgrep) |
|
|
122
|
+
| [`react-vanilla`](./package-templates/profiles/react-vanilla/) | Plain React + TypeScript (Vite / CRA) | Next.js-specific RD checks skipped |
|
|
123
|
+
| [`expo-rn`](./package-templates/profiles/expo-rn/) | Expo / React Native | React Doctor not supported; use Maestro / Detox for E2E |
|
|
124
|
+
| [`node-cli`](./package-templates/profiles/node-cli/) | Node CLI / library | No UI / E2E; Static + Unit focus |
|
|
125
|
+
| [`supabase-rls`](./package-templates/profiles/supabase-rls/) | Supabase + RLS (addon) | Combine with any of the above (e.g. `react-nextjs+supabase-rls`) |
|
|
126
|
+
|
|
127
|
+
## Roadmap
|
|
128
|
+
|
|
129
|
+
| Version | Theme | Status |
|
|
130
|
+
|---|---|---|
|
|
131
|
+
| **v0.1.0** | Manual templates for AI code verification | Released ([notes](./docs/releases/v0.1.0.md)) |
|
|
132
|
+
| **v0.2.0** | CLI scaffolding (`npx ai-check-template init`) | In progress ([alpha CLI docs + `npm pack` readiness](./docs/cli.md)) |
|
|
133
|
+
| **v0.3.0+** | Reusable workflow + Composite Action (GitHub Marketplace) | Planned |
|
|
134
|
+
|
|
135
|
+
Full breakdown: [`docs/roadmap.md`](./docs/roadmap.md).
|
|
136
|
+
|
|
137
|
+
## Contributing
|
|
138
|
+
|
|
139
|
+
We welcome contributions. See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the PR flow and lane selection, [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md) for community standards, and [`SECURITY.md`](./SECURITY.md) for vulnerability reporting.
|
|
140
|
+
|
|
141
|
+
Issue and PR templates live under [`.github/`](./.github/).
|
|
142
|
+
|
|
143
|
+
## License
|
|
144
|
+
|
|
145
|
+
[Apache-2.0](./LICENSE)
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
> This repository is itself developed under the [SAGE Development System](https://github.com/heidayo/sage-ai-template) (Spec → Plan → Task → Execute → Verify). Contributors do not need SAGE installed to use the templates; SAGE coexistence is opt-in. See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for details.
|