candy-debug 1.0.0 → 1.1.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/README.md +41 -15
- package/dist/candy-debug.mjs +33209 -229
- package/package.json +11 -4
package/README.md
CHANGED
|
@@ -31,25 +31,51 @@ candy-debug ./my-project > review.json
|
|
|
31
31
|
|
|
32
32
|
# AI を呼ばずに、対象になるファイルだけを確かめる
|
|
33
33
|
candy-debug ./my-project --scan-only
|
|
34
|
-
```
|
|
35
34
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
35
|
+
# Amazon Bedrock で動かす（モデルは環境変数 BEDROCK_MODEL_ID）
|
|
36
|
+
export AWS_REGION=ap-northeast-1 BEDROCK_MODEL_ID=jp.anthropic.claude-sonnet-4-6
|
|
37
|
+
cdbg ./my-project --provider bedrock -o review.json
|
|
38
|
+
|
|
39
|
+
# CI で使う: warning 以上の指摘があれば終了コード 3（JSON は書き終えてから返す）
|
|
40
|
+
cdbg . --provider bedrock --fail-on warning -o review.json
|
|
41
|
+
|
|
42
|
+
# レビュー結果の改善案をソースへ当てる（このときだけ対象フォルダへ書き込む）
|
|
43
|
+
cdbg fix review.json --dir . --summary pr.md
|
|
44
|
+
```
|
|
46
45
|
|
|
47
|
-
|
|
46
|
+
Bedrock の認証は AWS SDK の標準の順序（環境変数・`~/.aws`・SSO・CodeBuild/ECS の実行ロールなど）で探します。
|
|
47
|
+
CodePipeline に組み込んだ例は、リポジトリの `examples/roxy-pipeline/`（ロキシーパイプライン）にあります。
|
|
48
|
+
|
|
49
|
+
| オプション | 内容 |
|
|
50
|
+
| ----------------------- | -------------------------------------------------------------------------------------------- |
|
|
51
|
+
| `-o, --output <file>` | 結果の JSON を書き出すファイル（省略時は標準出力） |
|
|
52
|
+
| `--max-findings <n>` | 指摘の最大件数（既定 6） |
|
|
53
|
+
| `--provider <name>` | `claude` / `bedrock`（既定 `claude`・環境変数 `CANDY_DEBUG_PROVIDER`） |
|
|
54
|
+
| `--model <id>` | レビューに使うモデル（claude の既定 `claude-sonnet-5`・bedrock の既定は `BEDROCK_MODEL_ID`） |
|
|
55
|
+
| `--region <region>` | bedrock のリージョン（既定 `AWS_REGION`） |
|
|
56
|
+
| `--fail-on <severity>` | この重要度以上の指摘があれば終了コード 3（`critical` / `warning` / `info`） |
|
|
57
|
+
| `--scenario-model <id>` | 台本づくりに使うモデル（既定は `--model` と同じ） |
|
|
58
|
+
| `--claude <command>` | `claude` コマンドの場所 |
|
|
59
|
+
| `--progress <mode>` | 進捗の出し方: `text` / `json` / `none`（既定 `text`） |
|
|
60
|
+
| `--scan-only` | 走査結果だけを JSON で出す |
|
|
61
|
+
| `--doctor [--json]` | AI を呼べるかの確認 |
|
|
62
|
+
|
|
63
|
+
`cdbg fix <review.json>` のオプション: `--dir <folder>`（既定 カレント）/ `--min-severity <sev>`（既定 `warning`）/
|
|
64
|
+
`--summary <file>`（プルリクエスト用の Markdown）/ `--dry-run`
|
|
65
|
+
|
|
66
|
+
| 環境変数 | 内容 |
|
|
67
|
+
| --------------------------- | --------------------------------------------- |
|
|
68
|
+
| `BEDROCK_MODEL_ID` | Bedrock のモデル ID（推論プロファイル ID 可） |
|
|
69
|
+
| `BEDROCK_SCENARIO_MODEL_ID` | 台本づくりだけ別のモデルにしたいとき |
|
|
70
|
+
| `BEDROCK_MAX_TOKENS` | 1 回の応答の上限（既定 8192） |
|
|
71
|
+
| `CANDY_DEBUG_PROVIDER` | `--provider` の既定 |
|
|
72
|
+
|
|
73
|
+
終了コード: `0` 成功 / `1` 失敗 / `2` 引数の誤り / `3` `--fail-on` に該当する指摘あり / `130` 中断
|
|
48
74
|
|
|
49
75
|
## 注意
|
|
50
76
|
|
|
51
|
-
- **対象のコードは
|
|
52
|
-
-
|
|
77
|
+
- **対象のコードは AI（`claude` なら Anthropic、`bedrock` なら Amazon Bedrock）へ送られます。** 送ってよいコードかを確かめてから実行してください。
|
|
78
|
+
- レビューは対象フォルダへ一切書き込みません（`-o` で明示した場所にだけ書きます）。書き込むのは `cdbg fix` を実行したときだけです。
|
|
53
79
|
- 1 回の実行で `claude` を数回呼びます。目安は指摘 6 件で約 3 分・約 $0.3 です（2026-09-09 実測）。
|
|
54
80
|
|
|
55
81
|
## 出力の形
|
|
@@ -58,7 +84,7 @@ candy-debug ./my-project --scan-only
|
|
|
58
84
|
{
|
|
59
85
|
"format": "candy-debug/review",
|
|
60
86
|
"schemaVersion": 1,
|
|
61
|
-
"generator": { "name": "candy-debug", "version": "1.
|
|
87
|
+
"generator": { "name": "candy-debug", "version": "1.1.0" },
|
|
62
88
|
"project": { "name": "my-project", "dir": "/path/to/my-project" },
|
|
63
89
|
"findings": [/* 指摘 */],
|
|
64
90
|
"scenario": { "beats": [/* 台詞・表情・コード片・赤枠の位置 */] },
|