candy-debug 0.0.0-stage → 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/LICENSE +21 -0
- package/README.md +99 -2
- package/dist/candy-debug.mjs +34041 -0
- package/package.json +35 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ryome
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,100 @@
|
|
|
1
|
-
#
|
|
1
|
+
# candy-debug
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ロキシーがあなたのコードをレビューして、ノベルゲーム用の台本（JSON）を作る CLI です。
|
|
4
|
+
|
|
5
|
+
フォルダを渡すと、ローカルの [Claude Code](https://www.npmjs.com/package/@anthropic-ai/claude-code)（`claude` コマンド）が
|
|
6
|
+
コードを読み、指摘をロキシーの台詞にまとめます。出てきた JSON は candy-debug のクライアントアプリで、
|
|
7
|
+
音声つきのノベルとして再生できます。
|
|
8
|
+
|
|
9
|
+
## 必要なもの
|
|
10
|
+
|
|
11
|
+
- Node.js 20 以上
|
|
12
|
+
- ログイン済みの `claude` コマンド（`npm install -g @anthropic-ai/claude-code`）
|
|
13
|
+
|
|
14
|
+
## インストール
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
npm install -g candy-debug
|
|
18
|
+
candy-debug --doctor # claude が使えるかを確かめる
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
`cdbg` という短縮名でも同じコマンドを呼べます（`cdbg ./my-project -o review.json`）。
|
|
22
|
+
|
|
23
|
+
## 使い方
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
# 結果をファイルに書き出す
|
|
27
|
+
candy-debug ./my-project -o review.json
|
|
28
|
+
|
|
29
|
+
# 標準出力に JSON を出す（進捗は標準エラー）
|
|
30
|
+
candy-debug ./my-project > review.json
|
|
31
|
+
|
|
32
|
+
# AI を呼ばずに、対象になるファイルだけを確かめる
|
|
33
|
+
candy-debug ./my-project --scan-only
|
|
34
|
+
|
|
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
|
+
```
|
|
45
|
+
|
|
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` 中断
|
|
74
|
+
|
|
75
|
+
## 注意
|
|
76
|
+
|
|
77
|
+
- **対象のコードは AI（`claude` なら Anthropic、`bedrock` なら Amazon Bedrock）へ送られます。** 送ってよいコードかを確かめてから実行してください。
|
|
78
|
+
- レビューは対象フォルダへ一切書き込みません（`-o` で明示した場所にだけ書きます）。書き込むのは `cdbg fix` を実行したときだけです。
|
|
79
|
+
- 1 回の実行で `claude` を数回呼びます。目安は指摘 6 件で約 3 分・約 $0.3 です（2026-09-09 実測）。
|
|
80
|
+
|
|
81
|
+
## 出力の形
|
|
82
|
+
|
|
83
|
+
```jsonc
|
|
84
|
+
{
|
|
85
|
+
"format": "candy-debug/review",
|
|
86
|
+
"schemaVersion": 1,
|
|
87
|
+
"generator": { "name": "candy-debug", "version": "1.1.0" },
|
|
88
|
+
"project": { "name": "my-project", "dir": "/path/to/my-project" },
|
|
89
|
+
"findings": [/* 指摘 */],
|
|
90
|
+
"scenario": { "beats": [/* 台詞・表情・コード片・赤枠の位置 */] },
|
|
91
|
+
"warnings": [],
|
|
92
|
+
"costUsd": 0.29,
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
コード片は台本に埋め込まれているので、再生する側は対象プロジェクトを持っていなくても構いません。
|
|
97
|
+
|
|
98
|
+
## ライセンス
|
|
99
|
+
|
|
100
|
+
MIT
|