@agentvibes/guardrails 0.2.8 → 0.3.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 +252 -5
- package/candidates/README.md +13 -13
- package/candidates/r10-as-cast.yml +4 -4
- package/candidates/r1d-scattered-numeric-const-in-component.yml +3 -3
- package/candidates/r2-helper-fn-in-tsx.yml +3 -3
- package/candidates/r3-hooks-outside-layout.yml +4 -4
- package/candidates/r6-jsx-comment-smell.yml +2 -2
- package/candidates/r7-raw-hsl-outside-tokens.yml +3 -3
- package/candidates/r8-inline-style-prop.yml +2 -2
- package/candidates/r9-optional-store-arg.yml +2 -2
- package/dist/astGrep.js +4 -2
- package/dist/astGrep.js.map +1 -1
- package/dist/cli.js +89 -6
- package/dist/cli.js.map +1 -1
- package/dist/cliArgsTest.d.ts +1 -0
- package/dist/cliArgsTest.js +44 -0
- package/dist/cliArgsTest.js.map +1 -0
- package/dist/doctor.d.ts +1 -1
- package/dist/doctor.js +58 -6
- package/dist/doctor.js.map +1 -1
- package/dist/fileSloc.d.ts +28 -0
- package/dist/fileSloc.js +72 -0
- package/dist/fileSloc.js.map +1 -0
- package/dist/fileSlocBaseline.d.ts +78 -0
- package/dist/fileSlocBaseline.js +173 -0
- package/dist/fileSlocBaseline.js.map +1 -0
- package/dist/fileSlocGate.d.ts +17 -0
- package/dist/fileSlocGate.js +75 -0
- package/dist/fileSlocGate.js.map +1 -0
- package/dist/fileSlocTest.d.ts +1 -0
- package/dist/fileSlocTest.js +172 -0
- package/dist/fileSlocTest.js.map +1 -0
- package/dist/fileWalk.js +1 -1
- package/dist/fileWalk.js.map +1 -1
- package/dist/findings.d.ts +1 -1
- package/dist/gateRed.d.ts +1 -1
- package/dist/gateRed.js +1 -0
- package/dist/gateRed.js.map +1 -1
- package/dist/gitDiff.d.ts +6 -0
- package/dist/gitDiff.js +25 -0
- package/dist/gitDiff.js.map +1 -1
- package/dist/hookStop.d.ts +2 -1
- package/dist/hookStop.js +7 -1
- package/dist/hookStop.js.map +1 -1
- package/dist/hookStopTest.d.ts +1 -1
- package/dist/hookStopTest.js +1 -0
- package/dist/hookStopTest.js.map +1 -1
- package/dist/init.js +1 -1
- package/dist/init.js.map +1 -1
- package/dist/initTest.d.ts +1 -1
- package/dist/initTest.js +2 -1
- package/dist/initTest.js.map +1 -1
- package/dist/iterateTest.d.ts +1 -1
- package/dist/iterateTest.js +1 -0
- package/dist/iterateTest.js.map +1 -1
- package/dist/jsxSuppress.js +1 -1
- package/dist/jsxSuppress.js.map +1 -1
- package/dist/jsxSuppressTest.d.ts +1 -1
- package/dist/jsxSuppressTest.js +4 -2
- package/dist/jsxSuppressTest.js.map +1 -1
- package/dist/leaksRed.d.ts +1 -1
- package/dist/leaksRed.js +1 -0
- package/dist/leaksRed.js.map +1 -1
- package/dist/metrics.d.ts +9 -0
- package/dist/metrics.js +96 -7
- package/dist/metrics.js.map +1 -1
- package/dist/metricsBaseline.js +1 -1
- package/dist/metricsBaseline.js.map +1 -1
- package/dist/metricsCollect.js +2 -45
- package/dist/metricsCollect.js.map +1 -1
- package/dist/metricsCycle.d.ts +1 -1
- package/dist/metricsCycle.js +1 -0
- package/dist/metricsCycle.js.map +1 -1
- package/dist/metricsTypes.d.ts +1 -1
- package/dist/overrideDeclarations.d.ts +35 -0
- package/dist/overrideDeclarations.js +94 -0
- package/dist/overrideDeclarations.js.map +1 -0
- package/dist/overrides.d.ts +35 -0
- package/dist/overrides.js +284 -0
- package/dist/overrides.js.map +1 -0
- package/dist/overridesTest.d.ts +1 -0
- package/dist/overridesTest.js +183 -0
- package/dist/overridesTest.js.map +1 -0
- package/dist/pipeOutputTest.d.ts +1 -1
- package/dist/pipeOutputTest.js +2 -1
- package/dist/pipeOutputTest.js.map +1 -1
- package/dist/presetDrift.d.ts +8 -0
- package/dist/presetDrift.js +91 -34
- package/dist/presetDrift.js.map +1 -1
- package/dist/presetDriftTest.d.ts +1 -1
- package/dist/presetDriftTest.js +3 -3
- package/dist/presetDriftTest.js.map +1 -1
- package/dist/record/config.d.ts +17 -0
- package/dist/record/config.js +83 -0
- package/dist/record/config.js.map +1 -0
- package/dist/record/index.d.ts +69 -0
- package/dist/record/index.js +8 -0
- package/dist/record/index.js.map +1 -0
- package/dist/record/record.d.ts +56 -0
- package/dist/record/record.js +111 -0
- package/dist/record/record.js.map +1 -0
- package/dist/record/repoKey.d.ts +8 -0
- package/dist/record/repoKey.js +70 -0
- package/dist/record/repoKey.js.map +1 -0
- package/dist/record/repoMetrics.d.ts +14 -0
- package/dist/record/repoMetrics.js +124 -0
- package/dist/record/repoMetrics.js.map +1 -0
- package/dist/record/runRecord.d.ts +60 -0
- package/dist/record/runRecord.js +2 -0
- package/dist/record/runRecord.js.map +1 -0
- package/dist/record/schema.d.ts +31 -0
- package/dist/record/schema.js +201 -0
- package/dist/record/schema.js.map +1 -0
- package/dist/record/writer.d.ts +22 -0
- package/dist/record/writer.js +341 -0
- package/dist/record/writer.js.map +1 -0
- package/dist/recordTest.d.ts +1 -0
- package/dist/recordTest.js +422 -0
- package/dist/recordTest.js.map +1 -0
- package/dist/renameDiffTest.d.ts +1 -1
- package/dist/renameDiffTest.js +2 -1
- package/dist/renameDiffTest.js.map +1 -1
- package/dist/repoRules.js +1 -1
- package/dist/repoRules.js.map +1 -1
- package/dist/repoRulesTest.d.ts +1 -1
- package/dist/repoRulesTest.js +2 -1
- package/dist/repoRulesTest.js.map +1 -1
- package/dist/screenScope.js +4 -5
- package/dist/screenScope.js.map +1 -1
- package/dist/screenScopeTest.d.ts +1 -1
- package/dist/screenScopeTest.js +2 -1
- package/dist/screenScopeTest.js.map +1 -1
- package/dist/severityTest.d.ts +1 -1
- package/dist/severityTest.js +1 -0
- package/dist/severityTest.js.map +1 -1
- package/dist/siblingCloneTest.js +12 -12
- package/dist/siblingCloneTest.js.map +1 -1
- package/dist/snapshot.d.ts +2 -0
- package/dist/snapshot.js +118 -0
- package/dist/snapshot.js.map +1 -0
- package/dist/snapshotTest.d.ts +1 -0
- package/dist/snapshotTest.js +194 -0
- package/dist/snapshotTest.js.map +1 -0
- package/dist/structure.js +2 -2
- package/dist/structure.js.map +1 -1
- package/dist/testIsolation.d.ts +1 -0
- package/dist/testIsolation.js +7 -0
- package/dist/testIsolation.js.map +1 -0
- package/dist/testPaths.d.ts +4 -0
- package/dist/testPaths.js +9 -0
- package/dist/testPaths.js.map +1 -0
- package/dist/testRules.js +3 -3
- package/dist/testRules.js.map +1 -1
- package/dist/time.d.ts +22 -0
- package/dist/time.js +77 -0
- package/dist/time.js.map +1 -0
- package/dist/timeTest.d.ts +1 -0
- package/dist/timeTest.js +103 -0
- package/dist/timeTest.js.map +1 -0
- package/dist/tomlTable.d.ts +1 -1
- package/dist/tomlTable.js +6 -3
- package/dist/tomlTable.js.map +1 -1
- package/dist/toolResolve.d.ts +6 -0
- package/dist/toolResolve.js +18 -0
- package/dist/toolResolve.js.map +1 -1
- package/dist/twinCoverageTest.js +1 -2
- package/dist/twinCoverageTest.js.map +1 -1
- package/dist/verify.d.ts +2 -1
- package/dist/verify.js +33 -5
- package/dist/verify.js.map +1 -1
- package/dist/verifyDiff.d.ts +3 -2
- package/dist/verifyDiff.js +58 -8
- package/dist/verifyDiff.js.map +1 -1
- package/dist/wiring.d.ts +31 -0
- package/dist/wiring.js +262 -0
- package/dist/wiring.js.map +1 -0
- package/dist/wiringTest.d.ts +1 -0
- package/dist/wiringTest.js +127 -0
- package/dist/wiringTest.js.map +1 -0
- package/package.json +18 -6
- package/rules/__fixtures__/demo-mode-by-default/bad.ts +1 -1
- package/rules/__fixtures__/demo-mode-by-default/bad.tsx +1 -1
- package/rules/__fixtures__/direct-store-import/bad.tsx +1 -1
- package/rules/__fixtures__/direct-store-import/good.tsx +2 -2
- package/rules/__fixtures__/discriminator-ternary/bad.tsx +1 -1
- package/rules/__fixtures__/discriminator-ternary/good.tsx +1 -1
- package/rules/__fixtures__/inline-map-row/bad.tsx +1 -1
- package/rules/__fixtures__/inline-map-row/good.tsx +1 -1
- package/rules/__fixtures__/missing-observer/bad.tsx +2 -2
- package/rules/__fixtures__/missing-observer/good.tsx +2 -2
- package/rules/__fixtures__/no-local-kit-clone/bad.ts +2 -2
- package/rules/__fixtures__/no-local-kit-clone/bad.tsx +2 -2
- package/rules/__fixtures__/state-loading-boolean-shape/good.ts +1 -1
- package/rules/__fixtures__/state-loading-boolean-shape/good.tsx +1 -1
- package/rules/__fixtures__/store-async-method/good.ts +1 -1
- package/rules/__fixtures__/store-async-method/good.tsx +1 -1
- package/rules/__fixtures__/store-context-provider/bad.ts +1 -1
- package/rules/__fixtures__/store-delegation-getter/bad.ts +1 -1
- package/rules/__fixtures__/store-delegation-getter/bad.tsx +1 -1
- package/rules/__fixtures__/store-delegation-getter/good.ts +3 -3
- package/rules/__fixtures__/store-delegation-getter/good.tsx +3 -3
- package/rules/__fixtures__/store-no-runinaction/bad.ts +1 -1
- package/rules/__fixtures__/store-no-runinaction/bad.tsx +1 -1
- package/rules/__fixtures__/store-no-runinaction/good.ts +1 -1
- package/rules/__fixtures__/store-no-runinaction/good.tsx +1 -1
- package/rules/__fixtures__/ts-pattern-dangling-match/bad.ts +1 -1
- package/rules/__fixtures__/ts-pattern-dangling-match/good.ts +2 -2
- package/rules/__fixtures__/ui-imports-app-store/src/ui/good.tsx +1 -1
- package/rules/__fixtures__/view-imports-store/good.view.tsx +1 -1
- package/rules/as-any-escape-tsx.yml +2 -2
- package/rules/as-any-escape.yml +2 -2
- package/rules/catch-empty-tsx.yml +3 -3
- package/rules/catch-empty.yml +3 -3
- package/rules/demo-mode-by-default-ts.yml +6 -7
- package/rules/demo-mode-by-default.yml +6 -7
- package/rules/direct-store-import.yml +15 -16
- package/rules/discriminator-ternary-ts.yml +1 -1
- package/rules/discriminator-ternary.yml +3 -3
- package/rules/hardcoded-url-in-component-ts.yml +1 -1
- package/rules/hardcoded-url-in-component.yml +5 -5
- package/rules/inline-map-row.yml +7 -7
- package/rules/instanceof-map-set-tsx.yml +2 -2
- package/rules/instanceof-map-set.yml +2 -2
- package/rules/kind-if-without-match-tsx.yml +1 -1
- package/rules/literal-union-in-component-tsx.yml +2 -2
- package/rules/literal-union-in-component.yml +7 -7
- package/rules/match-bool-to-null-ts.yml +1 -1
- package/rules/missing-observer.yml +5 -5
- package/rules/no-local-kit-clone-tsx.yml +2 -2
- package/rules/no-local-kit-clone.yml +2 -2
- package/rules/non-exhaustive-match-tsx.yml +4 -7
- package/rules/non-exhaustive-match.yml +2 -2
- package/rules/page-store-bare-usememo-tsx.yml +1 -1
- package/rules/page-store-bare-usememo.yml +1 -1
- package/rules/screen-file-styling.yml +3 -3
- package/rules/silent-default-return-tsx.yml +1 -1
- package/rules/store-async-method-tsx.yml +1 -1
- package/rules/store-async-method.yml +1 -1
- package/rules/store-context-provider-tsx.yml +3 -3
- package/rules/store-context-provider.yml +5 -5
- package/rules/store-delegation-getter-tsx.yml +2 -2
- package/rules/store-delegation-getter.yml +2 -2
- package/rules/store-no-runinaction-tsx.yml +2 -2
- package/rules/store-no-runinaction.yml +2 -2
- package/rules/store-no-setinterval-poll-tsx.yml +1 -1
- package/rules/store-no-setinterval-poll.yml +1 -1
- package/rules/ts-pattern-dangling-match-tsx.yml +4 -4
- package/rules/ts-pattern-dangling-match.yml +4 -4
- package/rules/ui-imports-app-store-ts.yml +2 -2
- package/rules/ui-imports-app-store.yml +1 -1
- package/rules/view-file-logic.yml +5 -5
- package/rules/view-imports-store.yml +4 -5
- package/rules/zod-optional-nullable-tsx.yml +2 -2
- package/rules/zod-optional-nullable.yml +2 -2
- package/structure/rules/component-decl.yml +1 -1
package/dist/cli.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
+
import { existsSync } from "node:fs";
|
|
2
3
|
import { fileURLToPath } from "node:url";
|
|
3
4
|
import { match } from "ts-pattern";
|
|
4
5
|
import { runDeploy } from "./deploy.js";
|
|
@@ -9,6 +10,9 @@ import { runInit } from "./init.js";
|
|
|
9
10
|
import { runIterate } from "./iterate.js";
|
|
10
11
|
import { runLeaks } from "./leaks.js";
|
|
11
12
|
import { runMetrics } from "./metrics.js";
|
|
13
|
+
import { NOT_RECORDING, RunCollector, recordRun, resolveTarget } from "./record/record.js";
|
|
14
|
+
import { runSnapshot } from "./snapshot.js";
|
|
15
|
+
import { runTime } from "./time.js";
|
|
12
16
|
import { ToolMissingError } from "./toolResolve.js";
|
|
13
17
|
import { runVerify } from "./verify.js";
|
|
14
18
|
import { runVerifyDiff } from "./verifyDiff.js";
|
|
@@ -31,6 +35,16 @@ Usage:
|
|
|
31
35
|
baseline (2% hysteresis); --snapshot appends
|
|
32
36
|
a JSONL trend row; --baseline <path> overrides
|
|
33
37
|
|
|
38
|
+
guardrails snapshot [path] record one checkout (default .) into the
|
|
39
|
+
recording database, whether or not it
|
|
40
|
+
uses guardrails; writes nothing into it;
|
|
41
|
+
exit 2 only when the record fails
|
|
42
|
+
|
|
43
|
+
guardrails time [--name N] -- CMD run CMD, pass its output and exit code
|
|
44
|
+
through; while recording, store its
|
|
45
|
+
wall-clock time as metric N (build_ms)
|
|
46
|
+
when it exits 0
|
|
47
|
+
|
|
34
48
|
guardrails leaks [paths] public/private boundary gate: scan for
|
|
35
49
|
private-infrastructure markers and token
|
|
36
50
|
patterns (+ gitleaks when available);
|
|
@@ -52,10 +66,19 @@ Usage:
|
|
|
52
66
|
back, repeat to green or --max (6)
|
|
53
67
|
|
|
54
68
|
All subcommands accept --json.
|
|
69
|
+
GUARDRAILS_RECORD=1 (or a database path) records verify, verify-diff, metrics,
|
|
70
|
+
hook-stop and time runs into SQLite; see README "Recording".
|
|
55
71
|
Exit codes: 0 ok · 1 findings/regression · 2 usage, missing tool, or missing baseline
|
|
56
72
|
`;
|
|
73
|
+
/** Commands whose runs are recorded when GUARDRAILS_RECORD is on (README "Recording"). */
|
|
74
|
+
const RECORDED = new Set(["verify", "verify-diff", "metrics", "hook-stop", "time"]);
|
|
57
75
|
async function main(argv) {
|
|
58
76
|
const args = [...argv];
|
|
77
|
+
// `time` runs another command: everything after the first `--` is that
|
|
78
|
+
// command's argv, never our flags (`time -- tsc --help` must not print our help).
|
|
79
|
+
// The command is the first argument that is not --json (`--json time …`).
|
|
80
|
+
const separator = args.find((a) => a !== "--json") === "time" ? args.indexOf("--") : -1;
|
|
81
|
+
const child = separator < 0 ? undefined : args.splice(separator).slice(1);
|
|
59
82
|
const json = args.includes("--json");
|
|
60
83
|
const filtered = args.filter((a) => a !== "--json");
|
|
61
84
|
const command = filtered.shift();
|
|
@@ -96,21 +119,70 @@ async function main(argv) {
|
|
|
96
119
|
const cmd = takeValueFlag("--cmd") ?? undefined;
|
|
97
120
|
const gateCmd = takeValueFlag("--gate") ?? undefined;
|
|
98
121
|
const max = takeValueFlag("--max") ?? undefined;
|
|
122
|
+
// Only `time` owns --name: `deploy` passes its arguments to a plugin as typed.
|
|
123
|
+
const metricName = command === "time" ? takeValueFlag("--name") : undefined;
|
|
124
|
+
if (metricName === null) {
|
|
125
|
+
console.error("guardrails: --name requires a metric name");
|
|
126
|
+
return 2;
|
|
127
|
+
}
|
|
99
128
|
const check = takeBoolFlag("--check");
|
|
100
129
|
const updateBaseline = takeBoolFlag("--update-baseline");
|
|
101
130
|
const force = takeBoolFlag("--force");
|
|
102
131
|
const snapshot = takeBoolFlag("--snapshot");
|
|
132
|
+
// `deploy` hands its args to a plugin verbatim, so its flags are not ours to
|
|
133
|
+
// judge. Every other subcommand: `--help` is help, and any other leftover
|
|
134
|
+
// `-x` is a usage error. Before this, an unknown flag fell through as a scan
|
|
135
|
+
// TARGET — `metrics --help` reached ast-grep as `--help`, ast-grep printed
|
|
136
|
+
// its own help text to stdout and exited 0, and the JSON parse crashed.
|
|
137
|
+
if (command !== "deploy") {
|
|
138
|
+
if (filtered.includes("--help") || filtered.includes("-h")) {
|
|
139
|
+
console.log(USAGE);
|
|
140
|
+
return 0;
|
|
141
|
+
}
|
|
142
|
+
const unknown = filtered.filter((a) => a.startsWith("-"));
|
|
143
|
+
if (unknown.length > 0) {
|
|
144
|
+
console.error(`guardrails ${command}: unknown option(s) ${unknown.join(" ")}\n`);
|
|
145
|
+
console.error(USAGE);
|
|
146
|
+
return 2;
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
// Path targets must exist: ast-grep reports a missing path on stderr and
|
|
150
|
+
// still exits 0 with an empty result, which would read as a clean scan.
|
|
151
|
+
if (command === "verify" || command === "metrics" || command === "leaks") {
|
|
152
|
+
const missing = filtered.filter((t) => !existsSync(t));
|
|
153
|
+
if (missing.length > 0) {
|
|
154
|
+
console.error(`guardrails ${command}: no such file or directory: ${missing.join(" ")}`);
|
|
155
|
+
return 2;
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
const recorded = RECORDED.has(command);
|
|
159
|
+
// snapshot records by definition (an unset variable means the default
|
|
160
|
+
// database) and writes its own record, so it is not in RECORDED.
|
|
161
|
+
const run = new RunCollector(command === "snapshot" ? resolveTarget(true) : recorded ? resolveTarget() : NOT_RECORDING);
|
|
162
|
+
const startedAt = new Date();
|
|
163
|
+
const started = performance.now();
|
|
103
164
|
// ast-grep-ignore: non-exhaustive-match -- `command` is arbitrary CLI input (open string), not a closed union; the otherwise arm IS the unknown-subcommand error path
|
|
104
|
-
|
|
105
|
-
.with("verify", () => runVerify(filtered, json))
|
|
106
|
-
.with("verify-diff", () => runVerifyDiff(base, json))
|
|
165
|
+
const exitCode = match(command)
|
|
166
|
+
.with("verify", () => runVerify(filtered, json, run))
|
|
167
|
+
.with("verify-diff", () => runVerifyDiff(base, json, run))
|
|
107
168
|
.with("doctor", () => runDoctor(json))
|
|
108
169
|
.with("init", () => runInit(json))
|
|
109
|
-
.with("metrics", () => runMetrics({
|
|
170
|
+
.with("metrics", () => runMetrics({
|
|
171
|
+
targets: filtered,
|
|
172
|
+
json,
|
|
173
|
+
check,
|
|
174
|
+
updateBaseline,
|
|
175
|
+
force,
|
|
176
|
+
snapshot,
|
|
177
|
+
baselinePath,
|
|
178
|
+
run,
|
|
179
|
+
}))
|
|
110
180
|
.with("leaks", () => runLeaks(filtered, json, patternsFile))
|
|
181
|
+
.with("snapshot", () => runSnapshot(filtered, json, run))
|
|
111
182
|
.with("deploy", () => runDeploy(filtered, json))
|
|
112
183
|
.with("hook-postedit", () => runHookPostedit())
|
|
113
|
-
.with("hook-stop", () => runHookStop())
|
|
184
|
+
.with("hook-stop", () => runHookStop(run))
|
|
185
|
+
.with("time", () => runTime({ name: metricName, stray: filtered, child, json, run }))
|
|
114
186
|
.with("iterate", () => runIterate({
|
|
115
187
|
task,
|
|
116
188
|
cmd,
|
|
@@ -124,10 +196,21 @@ async function main(argv) {
|
|
|
124
196
|
console.error(USAGE);
|
|
125
197
|
return 2;
|
|
126
198
|
});
|
|
199
|
+
if (recorded && run.recording) {
|
|
200
|
+
// The outcome is reported on stderr by recordRun; a run that could not be
|
|
201
|
+
// recorded keeps its own exit code (a state database is not a gate).
|
|
202
|
+
await recordRun(run, {
|
|
203
|
+
command,
|
|
204
|
+
exitCode: await exitCode,
|
|
205
|
+
durationMs: performance.now() - started,
|
|
206
|
+
startedAt,
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
return exitCode;
|
|
127
210
|
}
|
|
128
211
|
// `exitCode`, never `process.exit()`: stdout to a pipe is asynchronous, and
|
|
129
212
|
// exiting outright dropped everything past the pipe's first 64 KiB of a
|
|
130
|
-
// `--json` report
|
|
213
|
+
// `--json` report. Node exits with this code once stdout drains.
|
|
131
214
|
try {
|
|
132
215
|
process.exitCode = await main(process.argv.slice(2));
|
|
133
216
|
}
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,KAAK,GAAG
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,KAAK,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqDb,CAAC;AAEF,0FAA0F;AAC1F,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;AAEpF,KAAK,UAAU,IAAI,CAAC,IAAc;IAChC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACvB,uEAAuE;IACvE,kFAAkF;IAClF,0EAA0E;IAC1E,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxF,MAAM,KAAK,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;IAEjC,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QAC5F,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,aAAa,GAAG,CAAC,IAAY,EAA6B,EAAE;QAChE,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,GAAG,GAAG,CAAC;YAAE,OAAO,SAAS,CAAC;QAC9B,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;QAChC,2KAA2K;QAC3K,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACrC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAW,EAAE;QAC7C,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,GAAG,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAC1B,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACrC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC5D,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IACjD,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjE,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;IAC9D,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC;IAClD,MAAM,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC;IAChD,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC;IACrD,MAAM,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC;IAChD,+EAA+E;IAC/E,MAAM,UAAU,GAAG,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5E,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC3D,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACtC,MAAM,cAAc,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;IAE5C,6EAA6E;IAC7E,0EAA0E;IAC1E,6EAA6E;IAC7E,2EAA2E;IAC3E,wEAAwE;IACxE,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACzB,IAAI,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3D,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,KAAK,CAAC,cAAc,OAAO,uBAAuB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,yEAAyE;IACzE,wEAAwE;IACxE,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QACzE,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,KAAK,CAAC,cAAc,OAAO,gCAAgC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACxF,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvC,sEAAsE;IACtE,iEAAiE;IACjE,MAAM,GAAG,GAAG,IAAI,YAAY,CAC1B,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,aAAa,CAC1F,CAAC;IACF,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAClC,sKAAsK;IACtK,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;SAC5B,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;SACpD,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;SACzD,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SACrC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACjC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CACpB,UAAU,CAAC;QACT,OAAO,EAAE,QAAQ;QACjB,IAAI;QACJ,KAAK;QACL,cAAc;QACd,KAAK;QACL,QAAQ;QACR,YAAY;QACZ,GAAG;KACJ,CAAC,CACH;SACA,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;SAC3D,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;SACxD,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SAC/C,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC;SAC9C,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACzC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;SACpF,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CACpB,UAAU,CAAC;QACT,IAAI;QACJ,GAAG;QACH,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QACrB,IAAI;QACJ,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;KACxC,CAAC,CACH;SACA,SAAS,CAAC,GAAG,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,mCAAmC,OAAO,KAAK,CAAC,CAAC;QAC/D,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;IACL,IAAI,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;QAC9B,0EAA0E;QAC1E,qEAAqE;QACrE,MAAM,SAAS,CAAC,GAAG,EAAE;YACnB,OAAO;YACP,QAAQ,EAAE,MAAM,QAAQ;YACxB,UAAU,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,OAAO;YACvC,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,4EAA4E;AAC5E,wEAAwE;AACxE,iEAAiE;AACjE,IAAI,CAAC;IACH,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACvD,CAAC;AAAC,OAAO,GAAG,EAAE,CAAC;IACb,IAAI,CAAC,CAAC,GAAG,YAAY,gBAAgB,CAAC;QAAE,MAAM,GAAG,CAAC;IAClD,OAAO,CAAC,KAAK,CAAC,eAAe,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import "./testIsolation.js";
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import "./testIsolation.js";
|
|
2
|
+
import { spawnSync } from "node:child_process";
|
|
3
|
+
import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
|
4
|
+
import { tmpdir } from "node:os";
|
|
5
|
+
import { join } from "node:path";
|
|
6
|
+
import { packageRoot } from "./packagePaths.js";
|
|
7
|
+
const CASES = [
|
|
8
|
+
{ name: "metrics --help prints usage", args: ["metrics", "--help"], want: 0 },
|
|
9
|
+
{ name: "verify -h prints usage", args: ["verify", "-h"], want: 0 },
|
|
10
|
+
{ name: "verify --bogus is a usage error", args: ["verify", "--bogus"], want: 2 },
|
|
11
|
+
{ name: "metrics --bogus is a usage error", args: ["metrics", "--bogus", "."], want: 2 },
|
|
12
|
+
{ name: "leaks --bogus is a usage error", args: ["leaks", "--bogus"], want: 2 },
|
|
13
|
+
{ name: "verify on a missing path", args: ["verify", "no-such-dir"], want: 2 },
|
|
14
|
+
{ name: "metrics on a missing path", args: ["metrics", "no-such-dir"], want: 2 },
|
|
15
|
+
{ name: "metrics on a real dir", args: ["metrics", "."], want: 0 },
|
|
16
|
+
];
|
|
17
|
+
function main() {
|
|
18
|
+
const dir = mkdtempSync(join(tmpdir(), "guardrails-cli-args-"));
|
|
19
|
+
let failed = 0;
|
|
20
|
+
try {
|
|
21
|
+
writeFileSync(join(dir, "ok.ts"), "export const x = 1;\n");
|
|
22
|
+
for (const c of CASES) {
|
|
23
|
+
const res = spawnSync("node", [join(packageRoot, "dist", "cli.js"), ...c.args], {
|
|
24
|
+
cwd: dir,
|
|
25
|
+
encoding: "utf8",
|
|
26
|
+
});
|
|
27
|
+
if (res.error)
|
|
28
|
+
throw res.error;
|
|
29
|
+
const crashed = /\n\s+at /.test(res.stderr);
|
|
30
|
+
if (res.status !== c.want || crashed) {
|
|
31
|
+
console.error(`FAIL cli-args: ${c.name}: exit ${res.status}, expected ${c.want}${crashed ? " (stack trace)" : ""}\n${res.stderr.slice(0, 800)}`);
|
|
32
|
+
failed += 1;
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
console.log(` ok cli-args: ${c.name} → exit ${c.want}`);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
finally {
|
|
39
|
+
rmSync(dir, { recursive: true, force: true });
|
|
40
|
+
}
|
|
41
|
+
return failed === 0 ? 0 : 1;
|
|
42
|
+
}
|
|
43
|
+
process.exit(main());
|
|
44
|
+
//# sourceMappingURL=cliArgsTest.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cliArgsTest.js","sourceRoot":"","sources":["../src/cliArgsTest.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAchD,MAAM,KAAK,GAAW;IACpB,EAAE,IAAI,EAAE,6BAA6B,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;IAC7E,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;IACnE,EAAE,IAAI,EAAE,iCAAiC,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;IACjF,EAAE,IAAI,EAAE,kCAAkC,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;IACxF,EAAE,IAAI,EAAE,gCAAgC,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;IAC/E,EAAE,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;IAC9E,EAAE,IAAI,EAAE,2BAA2B,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;IAChF,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;CACnE,CAAC;AAEF,SAAS,IAAI;IACX,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAChE,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,CAAC;QACH,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC;QAC3D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE;gBAC9E,GAAG,EAAE,GAAG;gBACR,QAAQ,EAAE,MAAM;aACjB,CAAC,CAAC;YACH,IAAI,GAAG,CAAC,KAAK;gBAAE,MAAM,GAAG,CAAC,KAAK,CAAC;YAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;gBACrC,OAAO,CAAC,KAAK,CACX,kBAAkB,CAAC,CAAC,IAAI,UAAU,GAAG,CAAC,MAAM,cAAc,CAAC,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAClI,CAAC;gBACF,MAAM,IAAI,CAAC,CAAC;gBACZ,SAAS;YACX,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9B,CAAC;AAED,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC"}
|
package/dist/doctor.d.ts
CHANGED
package/dist/doctor.js
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
import { createHash } from "node:crypto";
|
|
2
2
|
import { existsSync, readdirSync, readFileSync } from "node:fs";
|
|
3
3
|
import { join } from "node:path";
|
|
4
|
+
import { match } from "ts-pattern";
|
|
5
|
+
import { OverrideConfigError } from "./overrideDeclarations.js";
|
|
6
|
+
import { collectOverrides } from "./overrides.js";
|
|
4
7
|
import { packageRoot, rulesDir, structureRulesDir } from "./packagePaths.js";
|
|
5
8
|
import { driftMessage, presetDrift } from "./presetDrift.js";
|
|
6
9
|
import { declaredRuleDirs } from "./repoRules.js";
|
|
7
10
|
import { pinnedVersion, tryResolveTool } from "./toolResolve.js";
|
|
11
|
+
import { detectWiring } from "./wiring.js";
|
|
8
12
|
function reportTool(name) {
|
|
9
13
|
const pin = pinnedVersion(name);
|
|
10
14
|
const resolved = tryResolveTool(name);
|
|
@@ -46,7 +50,7 @@ function discoverConfigs(cwd) {
|
|
|
46
50
|
const sg = join(cwd, "sgconfig.yml");
|
|
47
51
|
if (existsSync(sg)) {
|
|
48
52
|
// Name the ruleDirs, not just the file. `verify` scans with this config IN
|
|
49
|
-
// ADDITION to the canon
|
|
53
|
+
// ADDITION to the canon, so what it lists is what the repo
|
|
50
54
|
// adds on top — and a repo that thinks it has local rules can see here
|
|
51
55
|
// whether the config actually declares the directory holding them.
|
|
52
56
|
const dirs = declaredRuleDirs(sg);
|
|
@@ -76,8 +80,25 @@ function discoverConfigs(cwd) {
|
|
|
76
80
|
}
|
|
77
81
|
return found;
|
|
78
82
|
}
|
|
79
|
-
|
|
83
|
+
/** The overrides inventory for doctor: reported, never gating (drift already gates a bad declaration file). */
|
|
84
|
+
function readOverrides(root) {
|
|
85
|
+
try {
|
|
86
|
+
return { status: "read", ...collectOverrides(root) };
|
|
87
|
+
}
|
|
88
|
+
catch (err) {
|
|
89
|
+
if (err instanceof OverrideConfigError)
|
|
90
|
+
return { status: "unreadable", error: err.message };
|
|
91
|
+
throw err;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
export function runDoctor(json, root = process.cwd()) {
|
|
80
95
|
const version = JSON.parse(readFileSync(join(packageRoot, "package.json"), "utf8")).version;
|
|
96
|
+
const overrides = readOverrides(root);
|
|
97
|
+
// Wiring (wiring.ts) is a report: it never changes doctor's exit code.
|
|
98
|
+
const wiring = detectWiring(root, match(overrides)
|
|
99
|
+
.with({ status: "read" }, (r) => r)
|
|
100
|
+
.with({ status: "unreadable" }, () => undefined)
|
|
101
|
+
.exhaustive());
|
|
81
102
|
const result = {
|
|
82
103
|
command: "doctor",
|
|
83
104
|
package: { name: "@agentvibes/guardrails", version, root: packageRoot },
|
|
@@ -88,10 +109,12 @@ export function runDoctor(json) {
|
|
|
88
109
|
mise: tryResolveTool("mise") !== undefined,
|
|
89
110
|
},
|
|
90
111
|
rulesetSha: rulesetSha(),
|
|
91
|
-
configDiscovery: discoverConfigs(
|
|
92
|
-
// Preset drift
|
|
112
|
+
configDiscovery: discoverConfigs(root),
|
|
113
|
+
// Preset drift: reported and gated in every repo, the same
|
|
93
114
|
// rule `verify` applies.
|
|
94
|
-
presetDrift: { findings: presetDrift(
|
|
115
|
+
presetDrift: { findings: presetDrift(root) },
|
|
116
|
+
overrides,
|
|
117
|
+
wiring,
|
|
95
118
|
};
|
|
96
119
|
if (json) {
|
|
97
120
|
console.log(JSON.stringify(result, null, 2));
|
|
@@ -107,7 +130,7 @@ export function runDoctor(json) {
|
|
|
107
130
|
}
|
|
108
131
|
console.log(`mise ${result.tools.mise ? "present" : "absent"}`);
|
|
109
132
|
console.log(`ruleset sha256:${result.rulesetSha.slice(0, 16)}…`);
|
|
110
|
-
console.log(`config discovery in ${
|
|
133
|
+
console.log(`config discovery in ${root}:`);
|
|
111
134
|
for (const [k, v] of Object.entries(result.configDiscovery)) {
|
|
112
135
|
console.log(` ${k.padEnd(28)} ${v}`);
|
|
113
136
|
}
|
|
@@ -119,6 +142,8 @@ export function runDoctor(json) {
|
|
|
119
142
|
for (const f of result.presetDrift.findings)
|
|
120
143
|
console.log(` ${f.detail}`);
|
|
121
144
|
}
|
|
145
|
+
printOverrides(result.overrides);
|
|
146
|
+
printWiring(result.wiring);
|
|
122
147
|
}
|
|
123
148
|
const allFound = result.tools["ast-grep"].found && result.tools.biome.found;
|
|
124
149
|
const drifted = result.presetDrift.findings.length > 0;
|
|
@@ -126,4 +151,31 @@ export function runDoctor(json) {
|
|
|
126
151
|
console.error(`guardrails doctor: ${driftMessage(result.presetDrift.findings)}`);
|
|
127
152
|
return allFound && !drifted ? 0 : 1;
|
|
128
153
|
}
|
|
154
|
+
function printOverrides(read) {
|
|
155
|
+
match(read)
|
|
156
|
+
.with({ status: "unreadable" }, (r) => console.log(`overrides UNREADABLE — ${r.error}`))
|
|
157
|
+
.with({ status: "read" }, (r) => {
|
|
158
|
+
const missing = r.overrides.filter((o) => o.reason.status === "missing");
|
|
159
|
+
console.log(`overrides ${r.overrides.length}, ${missing.length} without a reason`);
|
|
160
|
+
const SHOWN = 20;
|
|
161
|
+
for (const f of r.findings.slice(0, SHOWN))
|
|
162
|
+
console.log(` ${f.rule}: ${f.message}`);
|
|
163
|
+
if (r.findings.length > SHOWN) {
|
|
164
|
+
console.log(` … ${r.findings.length - SHOWN} more: guardrails doctor --json lists every one`);
|
|
165
|
+
}
|
|
166
|
+
})
|
|
167
|
+
.exhaustive();
|
|
168
|
+
}
|
|
169
|
+
function printWiring(w) {
|
|
170
|
+
console.log(`wiring ${w.state.toUpperCase()}`);
|
|
171
|
+
for (const c of w.checks)
|
|
172
|
+
console.log(` ${c.status === "pass" ? "ok " : "MISS"} ${c.id.padEnd(14)} ${c.detail}`);
|
|
173
|
+
match(w.overrides)
|
|
174
|
+
.with({ status: "counted" }, (o) => {
|
|
175
|
+
if (o.total > 0)
|
|
176
|
+
console.log(` (${o.total} override(s) of the canon keep it from ON)`);
|
|
177
|
+
})
|
|
178
|
+
.with({ status: "unreadable" }, (o) => console.log(` overrides unreadable: ${o.error}`))
|
|
179
|
+
.exhaustive();
|
|
180
|
+
}
|
|
129
181
|
//# sourceMappingURL=doctor.js.map
|
package/dist/doctor.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAuB,MAAM,gBAAgB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAqB,MAAM,aAAa,CAAC;AAU9D,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,IAAI,EAAE,eAAe,IAAI,IAAI,GAAG,IAAI,QAAQ,EAAE;SAC/C,CAAC;IACJ,CAAC;IACD,OAAO;QACL,KAAK,EAAE,IAAI;QACX,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU;IACxB,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;IAClC,KAAK,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC,EAAE,CAAC;QAChD,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC;aAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACjC,IAAI,EAAE,CAAC;QACV,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,eAAe,CAAC,GAAW;IAClC,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACrC,IAAI,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;QACnB,2EAA2E;QAC3E,2DAA2D;QAC3D,uEAAuE;QACvE,mEAAmE;QACnE,MAAM,IAAI,GAAG,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAClC,KAAK,CAAC,cAAc,CAAC;YACnB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,+BAA+B,CAAC;IAChG,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,cAAc,CAAC,GAAG,QAAQ,CAAC;IACnC,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAC1C,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1B,MAAM,aAAa,GAAG,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC;QAC/F,KAAK,CAAC,YAAY,CAAC,GAAG,aAAa;YACjC,CAAC,CAAC,+CAA+C;YACjD,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC;IACjC,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;IAC1D,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;QACpE,KAAK,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,qBAAqB,CAAC;IAChG,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC;IAC/C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAMD,+GAA+G;AAC/G,SAAS,aAAa,CAAC,IAAY;IACjC,IAAI,CAAC;QACH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;IACvD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,mBAAmB;YAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;QAC5F,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAa,EAAE,OAAe,OAAO,CAAC,GAAG,EAAE;IACnE,MAAM,OAAO,GACX,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CACnE,CAAC,OAAO,CAAC;IACV,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACtC,uEAAuE;IACvE,MAAM,MAAM,GAAG,YAAY,CACzB,IAAI,EACJ,KAAK,CAAC,SAAS,CAAC;SACb,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;SAClC,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC;SAC/C,UAAU,EAAE,CAChB,CAAC;IACF,MAAM,MAAM,GAAG;QACb,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE;QACvE,IAAI,EAAE,OAAO,CAAC,OAAO;QACrB,KAAK,EAAE;YACL,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;YAClC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC;YAC1B,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,SAAS;SAC3C;QACD,UAAU,EAAE,UAAU,EAAE;QACxB,eAAe,EAAE,eAAe,CAAC,IAAI,CAAC;QACtC,2DAA2D;QAC3D,yBAAyB;QACzB,WAAW,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE;QAC5C,SAAS;QACT,MAAM;KACP,CAAC;IAEF,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,0BAA0B,OAAO,KAAK,WAAW,GAAG,CAAC,CAAC;QAClE,OAAO,CAAC,GAAG,CAAC,cAAc,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,KAAK,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE,OAAO,CAAU,EAAE,CAAC;YAClD,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC7B,OAAO,CAAC,GAAG,CACT,CAAC,CAAC,KAAK;gBACL,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,SAAS,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG;gBAChG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,uBAAuB,CAAC,CAAC,IAAI,EAAE,CACtD,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,cAAc,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtE,OAAO,CAAC,GAAG,CAAC,qBAAqB,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;QACpE,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,GAAG,CAAC,CAAC;QAC5C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAC5D,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7C,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YACnC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ;gBAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACjC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;IAC5E,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IACvD,IAAI,OAAO,IAAI,CAAC,IAAI;QAClB,OAAO,CAAC,KAAK,CAAC,sBAAsB,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACnF,OAAO,QAAQ,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,cAAc,CAAC,IAAmB;IACzC,KAAK,CAAC,IAAI,CAAC;SACR,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;SAC3F,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE;QAC9B,MAAM,OAAO,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;QACzE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,mBAAmB,CAAC,CAAC;QACvF,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACrF,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CACT,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,iDAAiD,CAClF,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;SACD,UAAU,EAAE,CAAC;AAClB,CAAC;AAED,SAAS,WAAW,CAAC,CAAe;IAClC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACtD,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM;QACtB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3F,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SACf,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE;QACjC,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,4CAA4C,CAAC,CAAC;IAC1F,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;SACxF,UAAU,EAAE,CAAC;AAClB,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { ImportDeclaration, Program } from "oxc-parser";
|
|
2
|
+
import { type ParsedFile } from "./oxcAst.js";
|
|
3
|
+
/**
|
|
4
|
+
* Production code only — tests, stories, showcases and declaration files are
|
|
5
|
+
* out of every metric and out of the length ratchet. Same exclusions the
|
|
6
|
+
* original audit used, so numbers stay comparable to its baselines.
|
|
7
|
+
*/
|
|
8
|
+
export declare const EXCLUDED_FILE: RegExp;
|
|
9
|
+
/**
|
|
10
|
+
* Metrics describe the PROJECT — its tracked source — so gitignored files
|
|
11
|
+
* (generated code, local build output) are dropped. Without this the numbers
|
|
12
|
+
* depend on which machine ran them: a fresh CI checkout has no generated
|
|
13
|
+
* files, a dev tree does, and the p90s disagree (observed: p90ContextCost
|
|
14
|
+
* 20 locally vs 21 in CI on the same commit). The ast-grep-backed counters
|
|
15
|
+
* were already deterministic — ast-grep honors .gitignore natively.
|
|
16
|
+
*/
|
|
17
|
+
export declare function dropGitignored(files: string[], cwd?: string): string[];
|
|
18
|
+
export declare function importDecls(program: Program): ImportDeclaration[];
|
|
19
|
+
/** SLOC of an already-parsed file: code lines that are not part of an import. */
|
|
20
|
+
export declare function slocOf(parsed: ParsedFile, text: string): number;
|
|
21
|
+
export type FileSlocRead = {
|
|
22
|
+
kind: "measured";
|
|
23
|
+
sloc: number;
|
|
24
|
+
} | {
|
|
25
|
+
kind: "unreadable";
|
|
26
|
+
};
|
|
27
|
+
/** Read, parse and count one file. A deleted or unreadable file is its own state, not 0. */
|
|
28
|
+
export declare function measureFileSloc(file: string): FileSlocRead;
|
package/dist/fileSloc.js
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { spawnSync } from "node:child_process";
|
|
2
|
+
import { readFileSync } from "node:fs";
|
|
3
|
+
import { isKind, parseFile } from "./oxcAst.js";
|
|
4
|
+
import { classifyLines } from "./sourceLines.js";
|
|
5
|
+
// One definition of "a file's SLOC" for the whole toolkit: `metrics` reports
|
|
6
|
+
// it, and the per-file length ratchet (fileSlocBaseline.ts) gates it from both
|
|
7
|
+
// `metrics --check` and `verify-diff`. SLOC = lines minus imports, blank lines
|
|
8
|
+
// and comment-only lines.
|
|
9
|
+
/**
|
|
10
|
+
* Production code only — tests, stories, showcases and declaration files are
|
|
11
|
+
* out of every metric and out of the length ratchet. Same exclusions the
|
|
12
|
+
* original audit used, so numbers stay comparable to its baselines.
|
|
13
|
+
*/
|
|
14
|
+
export const EXCLUDED_FILE = /\.(test|spec|stories)\.[jt]sx?$|__tests__|\/showcase\/|\.d\.ts$/;
|
|
15
|
+
/**
|
|
16
|
+
* Metrics describe the PROJECT — its tracked source — so gitignored files
|
|
17
|
+
* (generated code, local build output) are dropped. Without this the numbers
|
|
18
|
+
* depend on which machine ran them: a fresh CI checkout has no generated
|
|
19
|
+
* files, a dev tree does, and the p90s disagree (observed: p90ContextCost
|
|
20
|
+
* 20 locally vs 21 in CI on the same commit). The ast-grep-backed counters
|
|
21
|
+
* were already deterministic — ast-grep honors .gitignore natively.
|
|
22
|
+
*/
|
|
23
|
+
export function dropGitignored(files, cwd = process.cwd()) {
|
|
24
|
+
if (files.length === 0)
|
|
25
|
+
return files;
|
|
26
|
+
const res = spawnSync("git", ["check-ignore", "--stdin"], {
|
|
27
|
+
cwd,
|
|
28
|
+
input: files.join("\n"),
|
|
29
|
+
encoding: "utf8",
|
|
30
|
+
maxBuffer: 64 * 1024 * 1024,
|
|
31
|
+
});
|
|
32
|
+
// Outside a repo (or git missing) there is no ignore standard to apply.
|
|
33
|
+
if (res.error || res.status === null || res.status > 1)
|
|
34
|
+
return files;
|
|
35
|
+
const ignored = new Set(res.stdout.split("\n").filter((l) => l !== ""));
|
|
36
|
+
return files.filter((f) => !ignored.has(f));
|
|
37
|
+
}
|
|
38
|
+
export function importDecls(program) {
|
|
39
|
+
return program.body.filter((stmt) => isKind(stmt, "ImportDeclaration"));
|
|
40
|
+
}
|
|
41
|
+
function importLineSet(file) {
|
|
42
|
+
const lines = new Set();
|
|
43
|
+
for (const stmt of importDecls(file.program)) {
|
|
44
|
+
const start = file.lineAt(stmt.start);
|
|
45
|
+
const end = file.lineAt(stmt.end);
|
|
46
|
+
for (let l = start; l <= end; l++)
|
|
47
|
+
lines.add(l);
|
|
48
|
+
}
|
|
49
|
+
return lines;
|
|
50
|
+
}
|
|
51
|
+
/** SLOC of an already-parsed file: code lines that are not part of an import. */
|
|
52
|
+
export function slocOf(parsed, text) {
|
|
53
|
+
const importLines = importLineSet(parsed);
|
|
54
|
+
let sloc = 0;
|
|
55
|
+
classifyLines(text).forEach((k, i) => {
|
|
56
|
+
if (k === "code" && !importLines.has(i + 1))
|
|
57
|
+
sloc += 1;
|
|
58
|
+
});
|
|
59
|
+
return sloc;
|
|
60
|
+
}
|
|
61
|
+
/** Read, parse and count one file. A deleted or unreadable file is its own state, not 0. */
|
|
62
|
+
export function measureFileSloc(file) {
|
|
63
|
+
let text;
|
|
64
|
+
try {
|
|
65
|
+
text = readFileSync(file, "utf8");
|
|
66
|
+
}
|
|
67
|
+
catch {
|
|
68
|
+
return { kind: "unreadable" };
|
|
69
|
+
}
|
|
70
|
+
return { kind: "measured", sloc: slocOf(parseFile(file, text), text) };
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=fileSloc.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fileSloc.js","sourceRoot":"","sources":["../src/fileSloc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EAAE,MAAM,EAAmB,SAAS,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,6EAA6E;AAC7E,+EAA+E;AAC/E,+EAA+E;AAC/E,0BAA0B;AAE1B;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,iEAAiE,CAAC;AAE/F;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,KAAe,EAAE,MAAc,OAAO,CAAC,GAAG,EAAE;IACzE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC,cAAc,EAAE,SAAS,CAAC,EAAE;QACxD,GAAG;QACH,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,QAAQ,EAAE,MAAM;QAChB,SAAS,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI;KAC5B,CAAC,CAAC;IACH,wEAAwE;IACxE,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACrE,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACxE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAgB;IAC1C,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAA6B,EAAE,CAC7D,MAAM,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAClC,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAgB;IACrC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClC,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE;YAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,MAAM,CAAC,MAAkB,EAAE,IAAY;IACrD,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACnC,IAAI,CAAC,KAAK,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAAE,IAAI,IAAI,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC;AAID,4FAA4F;AAC5F,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAChC,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;AACzE,CAAC"}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
export declare const DEFAULT_MAX_FILE_SLOC = 500;
|
|
2
|
+
/**
|
|
3
|
+
* Whether a file (by baseline key) is under the length ratchet. Test code is
|
|
4
|
+
* not: besides the `*.test.*` files every metric drops (EXCLUDED_FILE), a file
|
|
5
|
+
* in a test directory (`tests/`, `e2e/`, `__mocks__/`, …) is test code too,
|
|
6
|
+
* such as a shared harness or an end-to-end script. The project-wide metrics
|
|
7
|
+
* keep their own file set, so their committed baselines do not move.
|
|
8
|
+
*/
|
|
9
|
+
export declare function lengthGated(key: string): boolean;
|
|
10
|
+
export declare const FILE_SLOC_RULE = "file-sloc";
|
|
11
|
+
export declare class FileSlocConfigError extends Error {
|
|
12
|
+
}
|
|
13
|
+
export interface FileSlocBaseline {
|
|
14
|
+
version: 1;
|
|
15
|
+
/** the threshold in force when the file was written — informational */
|
|
16
|
+
threshold: number;
|
|
17
|
+
/** repo-relative POSIX path → SLOC ceiling */
|
|
18
|
+
files: Record<string, number>;
|
|
19
|
+
}
|
|
20
|
+
export type FileSlocViolation = {
|
|
21
|
+
kind: "grew";
|
|
22
|
+
file: string;
|
|
23
|
+
sloc: number;
|
|
24
|
+
ceiling: number;
|
|
25
|
+
} | {
|
|
26
|
+
kind: "crossed";
|
|
27
|
+
file: string;
|
|
28
|
+
sloc: number;
|
|
29
|
+
threshold: number;
|
|
30
|
+
};
|
|
31
|
+
export declare function fileSlocBaselinePath(cwd: string): string;
|
|
32
|
+
/** Baseline key of a file: relative to the directory the gate runs in, POSIX separators. */
|
|
33
|
+
export declare function baselineKey(cwd: string, file: string): string;
|
|
34
|
+
/**
|
|
35
|
+
* The threshold: env `GUARDRAILS_MAX_FILE_SLOC`, else `[metrics] max_file_sloc`
|
|
36
|
+
* in .agentvibes/project.toml, else 500. A value that is not a positive
|
|
37
|
+
* integer throws FileSlocConfigError (exit 2) — never a silent default.
|
|
38
|
+
*/
|
|
39
|
+
export declare function maxFileSloc(cwd: string): number;
|
|
40
|
+
export type BaselineRead = {
|
|
41
|
+
kind: "absent";
|
|
42
|
+
} | {
|
|
43
|
+
kind: "present";
|
|
44
|
+
baseline: FileSlocBaseline;
|
|
45
|
+
};
|
|
46
|
+
export declare function readFileSlocBaseline(path: string): BaselineRead;
|
|
47
|
+
export declare function writeFileSlocBaseline(path: string, baseline: FileSlocBaseline): void;
|
|
48
|
+
/**
|
|
49
|
+
* Judge measured files. `measured` maps baseline key → SLOC. `renamedFrom`
|
|
50
|
+
* maps a renamed file's key to the key it had before, so a renamed listed
|
|
51
|
+
* file keeps its ceiling.
|
|
52
|
+
*/
|
|
53
|
+
export declare function checkFileSloc(measured: Map<string, number>, baseline: Record<string, number>, threshold: number, renamedFrom?: Map<string, string>): FileSlocViolation[];
|
|
54
|
+
export interface FileSlocUpdate {
|
|
55
|
+
next: FileSlocBaseline;
|
|
56
|
+
/** ceiling lowered to the file's current SLOC */
|
|
57
|
+
tightened: {
|
|
58
|
+
file: string;
|
|
59
|
+
from: number;
|
|
60
|
+
to: number;
|
|
61
|
+
}[];
|
|
62
|
+
/** dropped: back under the threshold, or the file is gone */
|
|
63
|
+
dropped: string[];
|
|
64
|
+
/** newly listed (only on creation or --force) */
|
|
65
|
+
added: string[];
|
|
66
|
+
/** over their ceiling or over the threshold unlisted — kept as they were */
|
|
67
|
+
held: FileSlocViolation[];
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* The next baseline. `old` undefined = creation: every file over the threshold
|
|
71
|
+
* is listed at its current SLOC. `force` = the same from scratch over the
|
|
72
|
+
* measured files. Otherwise ceilings only go down. Entries for files that were
|
|
73
|
+
* not measured (outside the targets of this run) are kept unless the file no
|
|
74
|
+
* longer exists. A listed file that was renamed (`renamedFrom`: new key → old
|
|
75
|
+
* key) carries its ceiling to the new key.
|
|
76
|
+
*/
|
|
77
|
+
export declare function updateFileSloc(old: FileSlocBaseline | undefined, measured: Map<string, number>, threshold: number, force: boolean, exists: (key: string) => boolean, renamedFrom?: Map<string, string>): FileSlocUpdate;
|
|
78
|
+
export declare function describeViolation(v: FileSlocViolation, baselineRel: string): string;
|