kodevu 0.1.31 → 0.1.33
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 +45 -55
- package/package.json +1 -1
- package/src/config.js +111 -213
- package/src/index.js +3 -16
- package/src/report-generator.js +101 -27
package/README.md
CHANGED
|
@@ -2,98 +2,88 @@
|
|
|
2
2
|
|
|
3
3
|
A Node.js tool that fetches Git commits or SVN revisions, sends the diff to a supported AI reviewer CLI, and writes review results to report files.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Pure & Zero Config
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
2. Fetch the specified revision(s) as requested by the user:
|
|
9
|
-
- A single specific revision/commit via `--rev`.
|
|
10
|
-
- The latest $N$ revisions/commits via `--last` (default: 1).
|
|
11
|
-
3. For each change:
|
|
12
|
-
- Load metadata and changed paths from SVN or Git.
|
|
13
|
-
- Generate a unified diff for that single revision or commit.
|
|
14
|
-
- Send the diff and change metadata to the configured reviewer CLI.
|
|
15
|
-
- Allow the reviewer to inspect related local repository files in read-only mode when a local workspace is available.
|
|
16
|
-
- Write the result to `~/.kodevu/` (Markdown by default; optional JSON via config).
|
|
7
|
+
Kodevu is designed to be stateless and requires no configuration files. It relies entirely on command-line arguments and environment variables.
|
|
17
8
|
|
|
18
|
-
|
|
9
|
+
1. **Automatic Detection**: Detects repository type (Git/SVN), language, and available reviewers.
|
|
10
|
+
2. **Stateless**: Does not track history; reviews exactly what you ask for.
|
|
11
|
+
3. **Flexible**: Every setting can be overridden via CLI flags or ENV vars.
|
|
19
12
|
|
|
20
|
-
## Quick
|
|
13
|
+
## Quick Start
|
|
21
14
|
|
|
22
15
|
Review the latest commit in your repository:
|
|
23
16
|
|
|
24
17
|
```bash
|
|
25
|
-
npx kodevu
|
|
18
|
+
npx kodevu .
|
|
26
19
|
```
|
|
27
20
|
|
|
28
21
|
Review the latest 3 commits:
|
|
29
22
|
|
|
30
23
|
```bash
|
|
31
|
-
npx kodevu
|
|
24
|
+
npx kodevu . --last 3
|
|
32
25
|
```
|
|
33
26
|
|
|
34
27
|
Review a specific commit:
|
|
35
28
|
|
|
36
29
|
```bash
|
|
37
|
-
npx kodevu
|
|
30
|
+
npx kodevu . --rev abc1234
|
|
38
31
|
```
|
|
39
32
|
|
|
40
|
-
|
|
33
|
+
Reports are written to `~/.kodevu/` by default.
|
|
41
34
|
|
|
42
|
-
##
|
|
43
|
-
|
|
44
|
-
If you want to customize settings beyond the defaults:
|
|
35
|
+
## Usage
|
|
45
36
|
|
|
46
37
|
```bash
|
|
47
|
-
npx kodevu
|
|
38
|
+
npx kodevu [target] [options]
|
|
48
39
|
```
|
|
49
40
|
|
|
50
|
-
|
|
41
|
+
### Options
|
|
51
42
|
|
|
52
|
-
|
|
43
|
+
- `target`: Repository path (Git) or SVN URL/Working copy (default: `.`).
|
|
44
|
+
- `--reviewer, -r`: `codex`, `gemini`, `copilot`, or `auto` (default: `auto`).
|
|
45
|
+
- `--rev, -v`: A specific revision or commit hash to review.
|
|
46
|
+
- `--last, -n`: Number of latest revisions to review (default: 1).
|
|
47
|
+
- `--lang, -l`: Output language (e.g., `zh`, `en`, `auto`).
|
|
48
|
+
- `--prompt, -p`: Additional instructions for the reviewer. Use `@file.txt` to read from a file.
|
|
49
|
+
- `--output, -o`: Report output directory (default: `~/.kodevu`).
|
|
50
|
+
- `--format, -f`: Output formats (e.g., `markdown`, `json`, or `markdown,json`).
|
|
51
|
+
- `--debug, -d`: Print debug information.
|
|
53
52
|
|
|
54
|
-
|
|
53
|
+
### Environment Variables
|
|
55
54
|
|
|
56
|
-
|
|
57
|
-
npx kodevu /path/to/your/repo --lang zh
|
|
58
|
-
```
|
|
55
|
+
You can set these in your shell to change default behavior without typing flags every time:
|
|
59
56
|
|
|
60
|
-
|
|
57
|
+
- `KODEVU_REVIEWER`: Default reviewer.
|
|
58
|
+
- `KODEVU_LANG`: Default language.
|
|
59
|
+
- `KODEVU_OUTPUT_DIR`: Default output directory.
|
|
60
|
+
- `KODEVU_PROMPT`: Default prompt instructions.
|
|
61
|
+
- `KODEVU_TIMEOUT`: Reviewer execution timeout in milliseconds.
|
|
61
62
|
|
|
63
|
+
## Examples
|
|
64
|
+
|
|
65
|
+
**Review with a custom prompt from a file:**
|
|
62
66
|
```bash
|
|
63
|
-
npx kodevu
|
|
67
|
+
npx kodevu . --prompt @my-rules.txt
|
|
64
68
|
```
|
|
65
69
|
|
|
66
|
-
|
|
67
|
-
|
|
70
|
+
**Generate JSON reports in a local folder:**
|
|
68
71
|
```bash
|
|
69
|
-
npx kodevu --
|
|
72
|
+
npx kodevu . --format json --output ./review-reports
|
|
70
73
|
```
|
|
71
74
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
- `last`: Number of latest revisions to review (default: 1 if `rev` is not set).
|
|
78
|
-
- `lang`: Output language for the review (e.g., `zh`, `en`, `auto`).
|
|
79
|
-
- `prompt`: Additional instructions for the reviewer.
|
|
80
|
-
- `outputDir`: Report output directory (default: `~/.kodevu`).
|
|
81
|
-
- `outputFormats`: Report formats to generate (supports `markdown` and `json`; default: `["markdown"]`).
|
|
82
|
-
- `commandTimeoutMs`: Timeout for a single review command execution in milliseconds.
|
|
83
|
-
- `maxRevisionsPerRun`: Cap the number of revisions handled in one run.
|
|
84
|
-
|
|
85
|
-
## Target Rules
|
|
86
|
-
|
|
87
|
-
- For SVN, `target` can be a working copy path or repository URL.
|
|
88
|
-
- For Git, `target` must be a local repository path or a subdirectory inside a local repository.
|
|
89
|
-
- The tool tries Git first, then falls back to SVN.
|
|
75
|
+
**Set a persistent reviewer via ENV:**
|
|
76
|
+
```bash
|
|
77
|
+
export KODEVU_REVIEWER=gemini
|
|
78
|
+
npx kodevu .
|
|
79
|
+
```
|
|
90
80
|
|
|
91
|
-
##
|
|
81
|
+
## How it Works
|
|
92
82
|
|
|
93
|
-
-
|
|
94
|
-
-
|
|
95
|
-
-
|
|
96
|
-
-
|
|
83
|
+
- **Git Targets**: `target` must be a local repository or subdirectory.
|
|
84
|
+
- **SVN Targets**: `target` can be a working copy path or repository URL.
|
|
85
|
+
- **Reviewer "auto"**: Probes `codex`, `gemini`, and `copilot` in your `PATH` and selects one.
|
|
86
|
+
- **Contextual Review**: For local repositories, the reviewer can inspect related files beyond the diff to provide deeper insights.
|
|
97
87
|
|
|
98
88
|
## License
|
|
99
89
|
|
package/package.json
CHANGED
package/src/config.js
CHANGED
|
@@ -6,7 +6,6 @@ import { findCommandOnPath } from "./shell.js";
|
|
|
6
6
|
const defaultStorageDir = path.join(os.homedir(), ".kodevu");
|
|
7
7
|
const SUPPORTED_REVIEWERS = ["codex", "gemini", "copilot"];
|
|
8
8
|
|
|
9
|
-
|
|
10
9
|
const defaultConfig = {
|
|
11
10
|
reviewer: "auto",
|
|
12
11
|
target: "",
|
|
@@ -21,61 +20,36 @@ const defaultConfig = {
|
|
|
21
20
|
last: 0
|
|
22
21
|
};
|
|
23
22
|
|
|
24
|
-
const
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
maxRevisionsPerRun: defaultConfig.maxRevisionsPerRun,
|
|
33
|
-
outputFormats: defaultConfig.outputFormats,
|
|
34
|
-
rev: "",
|
|
35
|
-
last: 1
|
|
23
|
+
const ENV_MAP = {
|
|
24
|
+
KODEVU_REVIEWER: "reviewer",
|
|
25
|
+
KODEVU_LANG: "lang",
|
|
26
|
+
KODEVU_OUTPUT_DIR: "outputDir",
|
|
27
|
+
KODEVU_PROMPT: "prompt",
|
|
28
|
+
KODEVU_TIMEOUT: "commandTimeoutMs",
|
|
29
|
+
KODEVU_MAX_REVISIONS: "maxRevisionsPerRun",
|
|
30
|
+
KODEVU_FORMATS: "outputFormats"
|
|
36
31
|
};
|
|
37
32
|
|
|
38
|
-
function
|
|
39
|
-
if (!value)
|
|
40
|
-
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
if (typeof value !== "string") {
|
|
44
|
-
return path.resolve(baseDir, String(value));
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
if (value === "~") {
|
|
48
|
-
return os.homedir();
|
|
49
|
-
}
|
|
50
|
-
|
|
33
|
+
function resolvePath(value) {
|
|
34
|
+
if (!value) return value;
|
|
35
|
+
if (value === "~") return os.homedir();
|
|
51
36
|
if (value.startsWith("~/") || value.startsWith("~\\")) {
|
|
52
37
|
return path.join(os.homedir(), value.slice(2));
|
|
53
38
|
}
|
|
54
|
-
|
|
55
|
-
return path.isAbsolute(value) ? value : path.resolve(baseDir, value);
|
|
39
|
+
return path.isAbsolute(value) ? value : path.resolve(process.cwd(), value);
|
|
56
40
|
}
|
|
57
41
|
|
|
58
|
-
|
|
59
|
-
function normalizeOutputFormats(outputFormats, loadedConfigPath) {
|
|
42
|
+
function normalizeOutputFormats(outputFormats) {
|
|
60
43
|
const source = outputFormats == null ? ["markdown"] : outputFormats;
|
|
61
|
-
const values = Array.isArray(source) ? source :
|
|
44
|
+
const values = Array.isArray(source) ? source : String(source).split(",");
|
|
62
45
|
const normalized = [...new Set(values.map((item) => String(item || "").trim().toLowerCase()).filter(Boolean))];
|
|
63
46
|
const supported = ["markdown", "json"];
|
|
64
47
|
const invalid = normalized.filter((item) => !supported.includes(item));
|
|
65
48
|
|
|
66
49
|
if (invalid.length > 0) {
|
|
67
|
-
throw new Error(
|
|
68
|
-
`"outputFormats" contains unsupported value(s): ${invalid.join(", ")}. Use any of: ${supported.join(", ")}${
|
|
69
|
-
loadedConfigPath ? ` in ${loadedConfigPath}` : ""
|
|
70
|
-
}`
|
|
71
|
-
);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
if (normalized.length === 0) {
|
|
75
|
-
throw new Error(`"outputFormats" must include at least one format${loadedConfigPath ? ` in ${loadedConfigPath}` : ""}`);
|
|
50
|
+
throw new Error(`Unsupported output format(s): ${invalid.join(", ")}. Use: ${supported.join(", ")}`);
|
|
76
51
|
}
|
|
77
|
-
|
|
78
|
-
return normalized;
|
|
52
|
+
return normalized.length === 0 ? ["markdown"] : normalized;
|
|
79
53
|
}
|
|
80
54
|
|
|
81
55
|
function detectLanguage() {
|
|
@@ -88,46 +62,28 @@ function detectLanguage() {
|
|
|
88
62
|
}
|
|
89
63
|
})();
|
|
90
64
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
if (
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
if (envLang) {
|
|
99
|
-
if (envLang.startsWith("zh")) return "zh";
|
|
100
|
-
if (envLang.startsWith("en")) return "en";
|
|
101
|
-
return envLang.split(/[._-]/)[0];
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
if (intlLocale) {
|
|
105
|
-
if (intlLocale.startsWith("zh")) return "zh";
|
|
106
|
-
if (intlLocale.startsWith("en")) return "en";
|
|
107
|
-
return intlLocale.split("-")[0];
|
|
108
|
-
}
|
|
109
|
-
|
|
65
|
+
if (os.platform() === "win32" && intlLocale.startsWith("zh")) return "zh";
|
|
66
|
+
if (envLang.startsWith("zh")) return "zh";
|
|
67
|
+
if (envLang.startsWith("en")) return "en";
|
|
68
|
+
if (envLang) return envLang.split(/[._-]/)[0];
|
|
69
|
+
if (intlLocale.startsWith("zh")) return "zh";
|
|
70
|
+
if (intlLocale.startsWith("en")) return "en";
|
|
71
|
+
if (intlLocale) return intlLocale.split("-")[0];
|
|
110
72
|
return "en";
|
|
111
73
|
}
|
|
112
74
|
|
|
113
|
-
async function resolveAutoReviewers(debug
|
|
75
|
+
async function resolveAutoReviewers(debug) {
|
|
114
76
|
const availableReviewers = [];
|
|
115
|
-
|
|
116
77
|
for (const reviewerName of SUPPORTED_REVIEWERS) {
|
|
117
78
|
const commandPath = await findCommandOnPath(reviewerName, { debug });
|
|
118
|
-
if (commandPath) {
|
|
119
|
-
availableReviewers.push({ reviewerName, commandPath });
|
|
120
|
-
}
|
|
79
|
+
if (commandPath) availableReviewers.push({ reviewerName, commandPath });
|
|
121
80
|
}
|
|
122
81
|
|
|
123
82
|
if (availableReviewers.length === 0) {
|
|
124
|
-
throw new Error(
|
|
125
|
-
`No reviewer CLI was found in PATH for "reviewer": "auto". Install one of: ${SUPPORTED_REVIEWERS.join(", ")}${
|
|
126
|
-
loadedConfigPath ? ` (${loadedConfigPath})` : ""
|
|
127
|
-
}`
|
|
128
|
-
);
|
|
83
|
+
throw new Error(`No reviewer CLI found in PATH. Install one of: ${SUPPORTED_REVIEWERS.join(", ")}`);
|
|
129
84
|
}
|
|
130
85
|
|
|
86
|
+
// Shuffle for variety
|
|
131
87
|
for (let i = availableReviewers.length - 1; i > 0; i--) {
|
|
132
88
|
const j = Math.floor(Math.random() * (i + 1));
|
|
133
89
|
[availableReviewers[i], availableReviewers[j]] = [availableReviewers[j], availableReviewers[i]];
|
|
@@ -138,9 +94,6 @@ async function resolveAutoReviewers(debug, loadedConfigPath) {
|
|
|
138
94
|
|
|
139
95
|
export function parseCliArgs(argv) {
|
|
140
96
|
const args = {
|
|
141
|
-
command: "run",
|
|
142
|
-
configPath: "config.json",
|
|
143
|
-
configExplicitlySet: false,
|
|
144
97
|
target: "",
|
|
145
98
|
debug: false,
|
|
146
99
|
help: false,
|
|
@@ -149,18 +102,13 @@ export function parseCliArgs(argv) {
|
|
|
149
102
|
prompt: "",
|
|
150
103
|
rev: "",
|
|
151
104
|
last: "",
|
|
152
|
-
|
|
105
|
+
outputDir: "",
|
|
106
|
+
outputFormats: ""
|
|
153
107
|
};
|
|
154
108
|
|
|
155
109
|
for (let index = 0; index < argv.length; index += 1) {
|
|
156
110
|
const value = argv[index];
|
|
157
111
|
|
|
158
|
-
if (value === "init" && !args.commandExplicitlySet && index === 0) {
|
|
159
|
-
args.command = "init";
|
|
160
|
-
args.commandExplicitlySet = true;
|
|
161
|
-
continue;
|
|
162
|
-
}
|
|
163
|
-
|
|
164
112
|
if (value === "--help" || value === "-h") {
|
|
165
113
|
args.help = true;
|
|
166
114
|
continue;
|
|
@@ -171,68 +119,59 @@ export function parseCliArgs(argv) {
|
|
|
171
119
|
continue;
|
|
172
120
|
}
|
|
173
121
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
if (!configPath || configPath.startsWith("-")) {
|
|
177
|
-
throw new Error(`Missing value for ${value}`);
|
|
178
|
-
}
|
|
179
|
-
args.configPath = configPath;
|
|
180
|
-
args.configExplicitlySet = true;
|
|
181
|
-
index += 1;
|
|
182
|
-
continue;
|
|
183
|
-
}
|
|
122
|
+
const nextValue = argv[index + 1];
|
|
123
|
+
const hasNextValue = nextValue && !nextValue.startsWith("-");
|
|
184
124
|
|
|
185
125
|
if (value === "--reviewer" || value === "-r") {
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
throw new Error(`Missing value for ${value}`);
|
|
189
|
-
}
|
|
190
|
-
args.reviewer = reviewer;
|
|
126
|
+
if (!hasNextValue) throw new Error(`Missing value for ${value}`);
|
|
127
|
+
args.reviewer = nextValue;
|
|
191
128
|
index += 1;
|
|
192
129
|
continue;
|
|
193
130
|
}
|
|
194
131
|
|
|
195
132
|
if (value === "--prompt" || value === "-p") {
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
throw new Error(`Missing value for ${value}`);
|
|
199
|
-
}
|
|
200
|
-
args.prompt = prompt;
|
|
133
|
+
if (!hasNextValue) throw new Error(`Missing value for ${value}`);
|
|
134
|
+
args.prompt = nextValue;
|
|
201
135
|
index += 1;
|
|
202
136
|
continue;
|
|
203
137
|
}
|
|
204
138
|
|
|
205
139
|
if (value === "--lang" || value === "-l") {
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
throw new Error(`Missing value for ${value}`);
|
|
209
|
-
}
|
|
210
|
-
args.lang = lang;
|
|
140
|
+
if (!hasNextValue) throw new Error(`Missing value for ${value}`);
|
|
141
|
+
args.lang = nextValue;
|
|
211
142
|
index += 1;
|
|
212
143
|
continue;
|
|
213
144
|
}
|
|
214
145
|
|
|
215
146
|
if (value === "--rev" || value === "-v") {
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
throw new Error(`Missing value for ${value}`);
|
|
219
|
-
}
|
|
220
|
-
args.rev = rev;
|
|
147
|
+
if (!hasNextValue) throw new Error(`Missing value for ${value}`);
|
|
148
|
+
args.rev = nextValue;
|
|
221
149
|
index += 1;
|
|
222
150
|
continue;
|
|
223
151
|
}
|
|
224
152
|
|
|
225
153
|
if (value === "--last" || value === "-n") {
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
154
|
+
if (!hasNextValue) throw new Error(`Missing value for ${value}`);
|
|
155
|
+
args.last = nextValue;
|
|
156
|
+
index += 1;
|
|
157
|
+
continue;
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
if (value === "--output" || value === "-o") {
|
|
161
|
+
if (!hasNextValue) throw new Error(`Missing value for ${value}`);
|
|
162
|
+
args.outputDir = nextValue;
|
|
231
163
|
index += 1;
|
|
232
164
|
continue;
|
|
233
165
|
}
|
|
234
166
|
|
|
235
|
-
if (
|
|
167
|
+
if (value === "--format" || value === "-f") {
|
|
168
|
+
if (!hasNextValue) throw new Error(`Missing value for ${value}`);
|
|
169
|
+
args.outputFormats = nextValue;
|
|
170
|
+
index += 1;
|
|
171
|
+
continue;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
if (!value.startsWith("-") && !args.target) {
|
|
236
175
|
args.target = value;
|
|
237
176
|
continue;
|
|
238
177
|
}
|
|
@@ -240,100 +179,78 @@ export function parseCliArgs(argv) {
|
|
|
240
179
|
throw new Error(`Unexpected argument: ${value}`);
|
|
241
180
|
}
|
|
242
181
|
|
|
243
|
-
delete args.commandExplicitlySet;
|
|
244
182
|
return args;
|
|
245
183
|
}
|
|
246
184
|
|
|
247
|
-
export async function
|
|
248
|
-
const
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
const raw = await fs.readFile(absoluteConfigPath, "utf8");
|
|
255
|
-
loadedConfig = JSON.parse(raw);
|
|
256
|
-
loadedConfigPath = absoluteConfigPath;
|
|
257
|
-
baseDir = path.dirname(absoluteConfigPath);
|
|
258
|
-
} catch (error) {
|
|
259
|
-
if (!(error?.code === "ENOENT" && !cliArgs.configExplicitlySet)) {
|
|
260
|
-
throw error;
|
|
185
|
+
export async function resolveConfig(cliArgs = {}) {
|
|
186
|
+
const config = { ...defaultConfig };
|
|
187
|
+
|
|
188
|
+
// 1. Merge Environment Variables
|
|
189
|
+
for (const [envVar, configKey] of Object.entries(ENV_MAP)) {
|
|
190
|
+
if (process.env[envVar] !== undefined) {
|
|
191
|
+
config[configKey] = process.env[envVar];
|
|
261
192
|
}
|
|
262
193
|
}
|
|
263
194
|
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
195
|
+
// 2. Merge CLI Arguments
|
|
196
|
+
const cliMapping = {
|
|
197
|
+
target: "target",
|
|
198
|
+
reviewer: "reviewer",
|
|
199
|
+
prompt: "prompt",
|
|
200
|
+
lang: "lang",
|
|
201
|
+
rev: "rev",
|
|
202
|
+
last: "last",
|
|
203
|
+
outputDir: "outputDir",
|
|
204
|
+
outputFormats: "outputFormats"
|
|
267
205
|
};
|
|
268
206
|
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
if (cliArgs.reviewer) {
|
|
274
|
-
config.reviewer = cliArgs.reviewer;
|
|
275
|
-
}
|
|
276
|
-
|
|
277
|
-
if (cliArgs.prompt) {
|
|
278
|
-
config.prompt = cliArgs.prompt;
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
if (cliArgs.lang) {
|
|
282
|
-
config.lang = cliArgs.lang;
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
if (cliArgs.rev) {
|
|
286
|
-
config.rev = cliArgs.rev;
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
if (cliArgs.last) {
|
|
290
|
-
config.last = cliArgs.last;
|
|
207
|
+
for (const [cliKey, configKey] of Object.entries(cliMapping)) {
|
|
208
|
+
if (cliArgs[cliKey]) {
|
|
209
|
+
config[configKey] = cliArgs[cliKey];
|
|
210
|
+
}
|
|
291
211
|
}
|
|
292
212
|
|
|
293
213
|
if (!config.target) {
|
|
294
|
-
|
|
214
|
+
config.target = process.cwd();
|
|
295
215
|
}
|
|
296
216
|
|
|
297
217
|
config.debug = Boolean(cliArgs.debug);
|
|
298
218
|
config.reviewer = String(config.reviewer || "auto").toLowerCase();
|
|
299
219
|
config.lang = String(config.lang || "auto").toLowerCase();
|
|
300
|
-
|
|
301
220
|
config.resolvedLang = config.lang === "auto" ? detectLanguage() : config.lang;
|
|
302
221
|
|
|
222
|
+
// Handle @file prompt
|
|
223
|
+
if (config.prompt.startsWith("@")) {
|
|
224
|
+
const promptPath = resolvePath(config.prompt.slice(1));
|
|
225
|
+
try {
|
|
226
|
+
config.prompt = await fs.readFile(promptPath, "utf8");
|
|
227
|
+
} catch (err) {
|
|
228
|
+
throw new Error(`Failed to read prompt file: ${promptPath} (${err.message})`);
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
|
|
303
232
|
if (config.reviewer === "auto") {
|
|
304
|
-
const availableReviewers = await resolveAutoReviewers(config.debug
|
|
233
|
+
const availableReviewers = await resolveAutoReviewers(config.debug);
|
|
305
234
|
const selectedReviewer = availableReviewers[0];
|
|
306
235
|
config.reviewer = selectedReviewer.reviewerName;
|
|
307
236
|
config.reviewerCommandPath = selectedReviewer.commandPath;
|
|
308
237
|
config.fallbackReviewers = availableReviewers.map(r => r.reviewerName).slice(1);
|
|
309
238
|
config.reviewerWasAutoSelected = true;
|
|
310
239
|
} else if (!SUPPORTED_REVIEWERS.includes(config.reviewer)) {
|
|
311
|
-
throw new Error(
|
|
312
|
-
`"reviewer" must be one of "codex", "gemini", "copilot", or "auto"${loadedConfigPath ? ` in ${loadedConfigPath}` : ""}`
|
|
313
|
-
);
|
|
240
|
+
throw new Error(`"reviewer" must be one of: ${SUPPORTED_REVIEWERS.join(", ")}, or "auto"`);
|
|
314
241
|
}
|
|
315
242
|
|
|
316
|
-
config.
|
|
317
|
-
config.
|
|
318
|
-
config.outputDir = resolveConfigPath(config.baseDir, config.outputDir);
|
|
319
|
-
config.logsDir = resolveConfigPath(config.baseDir, config.logsDir);
|
|
243
|
+
config.outputDir = resolvePath(config.outputDir);
|
|
244
|
+
config.logsDir = path.join(config.outputDir, "logs");
|
|
320
245
|
config.maxRevisionsPerRun = Number(config.maxRevisionsPerRun);
|
|
321
246
|
config.commandTimeoutMs = Number(config.commandTimeoutMs);
|
|
322
247
|
config.last = Number(config.last);
|
|
323
|
-
config.outputFormats = normalizeOutputFormats(config.outputFormats
|
|
248
|
+
config.outputFormats = normalizeOutputFormats(config.outputFormats);
|
|
324
249
|
|
|
325
250
|
if (!config.rev && (isNaN(config.last) || config.last <= 0)) {
|
|
326
251
|
config.last = 1;
|
|
327
252
|
}
|
|
328
253
|
|
|
329
|
-
if (!Number.isInteger(config.maxRevisionsPerRun) || config.maxRevisionsPerRun <= 0) {
|
|
330
|
-
throw new Error(`"maxRevisionsPerRun" must be a positive integer${loadedConfigPath ? ` in ${loadedConfigPath}` : ""}`);
|
|
331
|
-
}
|
|
332
|
-
|
|
333
|
-
if (!Number.isInteger(config.commandTimeoutMs) || config.commandTimeoutMs <= 0) {
|
|
334
|
-
throw new Error(`"commandTimeoutMs" must be a positive integer${loadedConfigPath ? ` in ${loadedConfigPath}` : ""}`);
|
|
335
|
-
}
|
|
336
|
-
|
|
337
254
|
return config;
|
|
338
255
|
}
|
|
339
256
|
|
|
@@ -341,44 +258,25 @@ export function printHelp() {
|
|
|
341
258
|
console.log(`Kodevu
|
|
342
259
|
|
|
343
260
|
Usage:
|
|
344
|
-
kodevu
|
|
345
|
-
npx kodevu init
|
|
346
|
-
kodevu <target> [--debug]
|
|
347
|
-
npx kodevu <target> [--debug]
|
|
348
|
-
kodevu [--config config.json]
|
|
349
|
-
npx kodevu [--config config.json]
|
|
261
|
+
npx kodevu [target] [options]
|
|
350
262
|
|
|
351
263
|
Options:
|
|
352
|
-
--
|
|
353
|
-
--reviewer, -r
|
|
354
|
-
--prompt, -p
|
|
355
|
-
--lang, -l
|
|
356
|
-
--rev, -v
|
|
357
|
-
--last, -n
|
|
358
|
-
--
|
|
359
|
-
--
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
264
|
+
--target, <path> Target repository path (default: current directory)
|
|
265
|
+
--reviewer, -r Reviewer (codex | gemini | copilot | auto, default: auto)
|
|
266
|
+
--prompt, -p Additional instructions or @file.txt to read from file
|
|
267
|
+
--lang, -l Output language (e.g. zh, en, auto)
|
|
268
|
+
--rev, -v Review a specific revision or commit hash
|
|
269
|
+
--last, -n Review the latest N revisions (default: 1)
|
|
270
|
+
--output, -o Output directory (default: ~/.kodevu)
|
|
271
|
+
--format, -f Output formats (markdown, json, comma-separated)
|
|
272
|
+
--debug, -d Print extra debug information
|
|
273
|
+
--help, -h Show help
|
|
274
|
+
|
|
275
|
+
Environment Variables:
|
|
276
|
+
KODEVU_REVIEWER Default reviewer
|
|
277
|
+
KODEVU_LANG Default language
|
|
278
|
+
KODEVU_OUTPUT_DIR Default output directory
|
|
279
|
+
KODEVU_PROMPT Default prompt text
|
|
280
|
+
KODEVU_TIMEOUT Reviewer timeout in ms
|
|
365
281
|
`);
|
|
366
282
|
}
|
|
367
|
-
|
|
368
|
-
export async function initConfig(targetPath = "config.json") {
|
|
369
|
-
const absoluteTargetPath = path.resolve(targetPath);
|
|
370
|
-
|
|
371
|
-
await fs.mkdir(path.dirname(absoluteTargetPath), { recursive: true });
|
|
372
|
-
|
|
373
|
-
const content = JSON.stringify(configTemplate, null, 2) + "\n";
|
|
374
|
-
try {
|
|
375
|
-
await fs.writeFile(absoluteTargetPath, content, { flag: "wx" });
|
|
376
|
-
} catch (error) {
|
|
377
|
-
if (error?.code === "EEXIST") {
|
|
378
|
-
throw new Error(`Config file already exists: ${absoluteTargetPath}`);
|
|
379
|
-
}
|
|
380
|
-
throw error;
|
|
381
|
-
}
|
|
382
|
-
|
|
383
|
-
return absoluteTargetPath;
|
|
384
|
-
}
|
package/src/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
|
-
import {
|
|
3
|
+
import { resolveConfig, parseCliArgs, printHelp } from "./config.js";
|
|
4
4
|
import { runReviewCycle } from "./review-runner.js";
|
|
5
5
|
import { logger } from "./logger.js";
|
|
6
6
|
|
|
@@ -19,19 +19,8 @@ if (cliArgs.help) {
|
|
|
19
19
|
process.exit(0);
|
|
20
20
|
}
|
|
21
21
|
|
|
22
|
-
if (cliArgs.command === "init") {
|
|
23
|
-
try {
|
|
24
|
-
const createdPath = await initConfig(cliArgs.configPath);
|
|
25
|
-
console.log(`Created config: ${createdPath}`);
|
|
26
|
-
process.exit(0);
|
|
27
|
-
} catch (error) {
|
|
28
|
-
console.error(error?.stack || String(error));
|
|
29
|
-
process.exit(1);
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
|
|
33
22
|
try {
|
|
34
|
-
const config = await
|
|
23
|
+
const config = await resolveConfig(cliArgs);
|
|
35
24
|
logger.init(config);
|
|
36
25
|
|
|
37
26
|
if (config.reviewerWasAutoSelected) {
|
|
@@ -42,8 +31,7 @@ try {
|
|
|
42
31
|
|
|
43
32
|
if (config.debug) {
|
|
44
33
|
logger.debug(
|
|
45
|
-
`
|
|
46
|
-
configPath: config.configPath,
|
|
34
|
+
`Resolved config: ${JSON.stringify({
|
|
47
35
|
reviewer: config.reviewer,
|
|
48
36
|
reviewerCommandPath: config.reviewerCommandPath,
|
|
49
37
|
reviewerWasAutoSelected: config.reviewerWasAutoSelected,
|
|
@@ -59,7 +47,6 @@ try {
|
|
|
59
47
|
await runReviewCycle(config);
|
|
60
48
|
logger.info("Session completed successfully.");
|
|
61
49
|
} catch (error) {
|
|
62
|
-
// If config was loaded, logger might be initialized, otherwise it will fall back to stderr
|
|
63
50
|
logger.error("Session failed with error", error);
|
|
64
51
|
process.exitCode = 1;
|
|
65
52
|
}
|
package/src/report-generator.js
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
|
-
export
|
|
2
|
-
|
|
1
|
+
export function getCoreReviewInstruction(lang) {
|
|
2
|
+
const lowLang = (lang || "").toLowerCase();
|
|
3
|
+
if (lowLang.startsWith("zh")) {
|
|
4
|
+
if (lowLang === "zh-tw" || lowLang === "zh-hk") {
|
|
5
|
+
return "請嚴格審查目前的更改,優先考慮錯誤、回歸風險、相容性問題、安全問題、邊界條件缺陷和缺失的測試。請使用 Markdown 進行回覆。如果未發現明顯缺陷,請寫「未發現明顯缺陷」並補充風險。";
|
|
6
|
+
}
|
|
7
|
+
return "请严格审查当前的更改,优先处理 Bug、回归风险、兼容性问题、安全问题、边界条件缺陷和缺失的测试。请使用 Markdown 进行回复。如果未发现明显缺陷,请写“未发现明显缺陷”并补充残留风险。";
|
|
8
|
+
}
|
|
9
|
+
return "Please strictly review the current changes, prioritizing bugs, regression risks, compatibility issues, security concerns, boundary condition flaws, and missing tests. Please use Markdown for your response. If no clear flaws are found, write \"No clear flaws found\" and supplement with residual risks.";
|
|
10
|
+
}
|
|
3
11
|
|
|
4
12
|
export function getReviewWorkspaceRoot(config, backend, targetInfo) {
|
|
5
13
|
if (backend.kind === "git" && targetInfo.repoRootPath) {
|
|
@@ -30,13 +38,77 @@ function getLanguageDisplayName(lang) {
|
|
|
30
38
|
return lang;
|
|
31
39
|
}
|
|
32
40
|
|
|
41
|
+
const LOCALIZED_PHRASES = {
|
|
42
|
+
en: {
|
|
43
|
+
workspaceRoot: "You are running inside a read-only workspace rooted at:",
|
|
44
|
+
noWorkspace: "No local repository workspace is available for this review run.",
|
|
45
|
+
besidesDiff: "Besides the diff below, you may read other related files in the workspace when needed to understand call sites, shared utilities, configuration, tests, or data flow. Do not modify files or rely on shell commands.",
|
|
46
|
+
reviewFromDiff: "Review primarily from the diff below. Do not assume access to other local files, shell commands, or repository history.",
|
|
47
|
+
fileRefs: "Use plain text file references like path/to/file.js:123. Do not emit clickable workspace links.",
|
|
48
|
+
repoType: "Repository Type",
|
|
49
|
+
changeId: "Change ID",
|
|
50
|
+
author: "Author",
|
|
51
|
+
date: "Date",
|
|
52
|
+
changedFiles: "Changed files",
|
|
53
|
+
commitMessage: "Commit message",
|
|
54
|
+
diffNoteTruncated: "Diff delivery note: the diff was truncated before being sent to the reviewer to stay within configured size limits. Original diff size was {originalLineCount} lines / {originalCharCount} chars, and the included excerpt is {outputLineCount} lines / {outputCharCount} chars. Use the changed file list and inspect related workspace files when needed.",
|
|
55
|
+
diffNoteFull: "Diff delivery note: the full diff is included. Size is {originalLineCount} lines / {originalCharCount} chars.",
|
|
56
|
+
langRule: "--- IMPORTANT LANGUAGE RULE ---\nYou MUST respond strictly in {langName}. No other language should be used for the explanation and comments."
|
|
57
|
+
},
|
|
58
|
+
zh: {
|
|
59
|
+
workspaceRoot: "你正运行在一个只读工作区内,根目录为:",
|
|
60
|
+
noWorkspace: "此审查运行没有可用的本地仓库工作区。",
|
|
61
|
+
besidesDiff: "除了下面的 Diff,你可以在需要时阅读工作区中的其他相关文件,以了解调用点、共享工具、配置、测试或数据流。请勿修改文件或依赖 Shell 命令。",
|
|
62
|
+
reviewFromDiff: "主要根据下面的 Diff 进行审查。不要假设可以访问其他本地文件、Shell 命令或仓库历史。",
|
|
63
|
+
fileRefs: "使用纯文本文件引用,如 path/to/file.js:123。不要生成可点击的工作区链接。",
|
|
64
|
+
repoType: "仓库类型",
|
|
65
|
+
changeId: "变更 ID",
|
|
66
|
+
author: "作者",
|
|
67
|
+
date: "日期",
|
|
68
|
+
changedFiles: "已变更文件",
|
|
69
|
+
commitMessage: "提交信息",
|
|
70
|
+
diffNoteTruncated: "Diff 交付说明:Diff 在发送给审查者之前已被截斷,以保持在配置的大小限制内。原始 Diff 大小为 {originalLineCount} 行 / {originalCharCount} 个字符,包含的摘录为 {outputLineCount} 行 / {outputCharCount} 个字符。在需要时使用已更正文件列表并检查相关工作区文件。",
|
|
71
|
+
diffNoteFull: "Diff 交付说明:包含完整的 Diff。大小为 {originalLineCount} 行 / {originalCharCount} 个字符。",
|
|
72
|
+
langRule: "--- 重要语言规则 ---\n你必须严格使用 {langName} 进行回复。解释、评论和总结均不得使用其他语言。"
|
|
73
|
+
},
|
|
74
|
+
"zh-tw": {
|
|
75
|
+
workspaceRoot: "你正運行在一個唯讀工作區內,根目錄為:",
|
|
76
|
+
noWorkspace: "此審查運行沒有可用的本地倉庫工作區。",
|
|
77
|
+
besidesDiff: "除了下面的 Diff,你可以在需要時閱讀工作區中的其他相關文件,以了解調用點、共享工具、配置、測試或資料流。請勿修改文件或依賴 Shell 命令。",
|
|
78
|
+
reviewFromDiff: "主要根據下面的 Diff 進行審查。不要假設可以訪問其他本地文件、Shell 命令或倉庫歷史。",
|
|
79
|
+
fileRefs: "使用純文本文件引用,如 path/to/file.js:123。不要生成可點擊的工作區連結。",
|
|
80
|
+
repoType: "倉庫類型",
|
|
81
|
+
changeId: "變更 ID",
|
|
82
|
+
author: "作者",
|
|
83
|
+
date: "日期",
|
|
84
|
+
changedFiles: "已變更文件",
|
|
85
|
+
commitMessage: "提交信息",
|
|
86
|
+
diffNoteTruncated: "Diff 交付說明:Diff 在傳送給審查者之前已被截斷,以保持在配置的大小限制內。原始 Diff 大小為 {originalLineCount} 行 / {originalCharCount} 個字符,包含的摘錄為 {outputLineCount} 行 / {outputCharCount} 個字符。在需要時使用已更正文件列表並檢查相關工作區文件。",
|
|
87
|
+
diffNoteFull: "Diff 交付說明:包含完整的 Diff。大小為 {originalLineCount} 行 / {originalCharCount} 個字符。",
|
|
88
|
+
langRule: "--- 重要語言規則 ---\n你必須嚴格使用 {langName} 進行回覆。解釋、評論和總結均不得使用其他語言。"
|
|
89
|
+
}
|
|
90
|
+
};
|
|
91
|
+
|
|
92
|
+
function getPhrase(key, lang, placeholders = {}) {
|
|
93
|
+
const lowLang = (lang || "en").toLowerCase();
|
|
94
|
+
const langKey = lowLang.startsWith("zh") ? (lowLang === "zh-tw" || lowLang === "zh-hk" ? "zh-tw" : "zh") : "en";
|
|
95
|
+
let phrase = LOCALIZED_PHRASES[langKey][key] || LOCALIZED_PHRASES.en[key];
|
|
96
|
+
|
|
97
|
+
for (const [k, v] of Object.entries(placeholders)) {
|
|
98
|
+
phrase = phrase.replace(`{${k}}`, v);
|
|
99
|
+
}
|
|
100
|
+
return phrase;
|
|
101
|
+
}
|
|
102
|
+
|
|
33
103
|
export function buildPrompt(config, backend, targetInfo, details, reviewDiffPayload) {
|
|
34
104
|
const fileList = details.changedPaths.map((item) => `${item.action} ${item.relativePath}`).join("\n");
|
|
35
105
|
const workspaceRoot = getReviewWorkspaceRoot(config, backend, targetInfo);
|
|
36
106
|
const canReadRelatedFiles = backend.kind === "git" || Boolean(targetInfo.workingCopyPath);
|
|
37
107
|
|
|
38
|
-
const
|
|
39
|
-
const
|
|
108
|
+
const lang = config.resolvedLang || "en";
|
|
109
|
+
const langName = getLanguageDisplayName(lang);
|
|
110
|
+
const lowLang = lang.toLowerCase();
|
|
111
|
+
|
|
40
112
|
let langInstruction = `IMPORTANT: Your entire response MUST be in ${langName}. All explanations, comments, and structure should strictly follow the ${langName} language rules.`;
|
|
41
113
|
|
|
42
114
|
if (lowLang.startsWith("zh")) {
|
|
@@ -47,39 +119,41 @@ export function buildPrompt(config, backend, targetInfo, details, reviewDiffPayl
|
|
|
47
119
|
}
|
|
48
120
|
}
|
|
49
121
|
|
|
50
|
-
|
|
51
|
-
|
|
52
122
|
return [
|
|
53
|
-
CORE_REVIEW_INSTRUCTION,
|
|
54
123
|
langInstruction,
|
|
124
|
+
getCoreReviewInstruction(lang),
|
|
55
125
|
config.prompt,
|
|
56
126
|
canReadRelatedFiles
|
|
57
|
-
?
|
|
58
|
-
: "
|
|
127
|
+
? `${getPhrase("workspaceRoot", lang)} ${workspaceRoot}`
|
|
128
|
+
: getPhrase("noWorkspace", lang),
|
|
59
129
|
canReadRelatedFiles
|
|
60
|
-
? "
|
|
61
|
-
: "
|
|
62
|
-
"
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
130
|
+
? getPhrase("besidesDiff", lang)
|
|
131
|
+
: getPhrase("reviewFromDiff", lang),
|
|
132
|
+
getPhrase("fileRefs", lang),
|
|
133
|
+
`${getPhrase("repoType", lang)}: ${backend.displayName}`,
|
|
134
|
+
`${getPhrase("changeId", lang)}: ${details.displayId}`,
|
|
135
|
+
`${getPhrase("author", lang)}: ${details.author}`,
|
|
136
|
+
`${getPhrase("date", lang)}: ${details.date || "unknown"}`,
|
|
137
|
+
`${getPhrase("changedFiles", lang)}:\n${fileList || "(none)"}`,
|
|
138
|
+
`${getPhrase("commitMessage", lang)}:\n${details.message || "(empty)"}`,
|
|
69
139
|
reviewDiffPayload.wasTruncated
|
|
70
|
-
?
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
140
|
+
? getPhrase("diffNoteTruncated", lang, {
|
|
141
|
+
originalLineCount: reviewDiffPayload.originalLineCount,
|
|
142
|
+
originalCharCount: reviewDiffPayload.originalCharCount,
|
|
143
|
+
outputLineCount: reviewDiffPayload.outputLineCount,
|
|
144
|
+
outputCharCount: reviewDiffPayload.outputCharCount
|
|
145
|
+
})
|
|
146
|
+
: getPhrase("diffNoteFull", lang, {
|
|
147
|
+
originalLineCount: reviewDiffPayload.originalLineCount,
|
|
148
|
+
originalCharCount: reviewDiffPayload.originalCharCount
|
|
149
|
+
}),
|
|
150
|
+
getPhrase("langRule", lang, { langName }) +
|
|
151
|
+
(lowLang.startsWith("zh")
|
|
74
152
|
? lowLang === "zh-tw" || lowLang === "zh-hk"
|
|
75
153
|
? "\n請務必完全使用繁體中文進行回覆,所有的審查分析、注釋和總結都必須使用繁體中文。"
|
|
76
154
|
: "\n请务必完全使用简体中文进行回复,所有的审查分析、注释和总结都必须使用简体中文。"
|
|
77
|
-
: ""
|
|
78
|
-
}`
|
|
79
|
-
|
|
155
|
+
: "")
|
|
80
156
|
].filter(Boolean).join("\n\n");
|
|
81
|
-
|
|
82
|
-
|
|
83
157
|
}
|
|
84
158
|
|
|
85
159
|
export function formatTokenUsage(tokenUsage) {
|