vouchington-tooling 0.13.1 → 0.13.3
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 +26 -0
- package/dist/ast-grep-examples/companion-parity.d.mts +19 -0
- package/dist/ast-grep-examples/companion-parity.mjs +156 -0
- package/dist/ast-grep-examples/index.d.mts +2 -1
- package/dist/ast-grep-examples/index.mjs +1 -0
- package/dist/gha-check-run/cli.d.mts +2 -0
- package/dist/gha-check-run/cli.mjs +81 -0
- package/dist/gha-check-run/github.d.mts +30 -0
- package/dist/gha-check-run/github.mjs +63 -0
- package/dist/gha-check-run/index.d.mts +2 -0
- package/dist/gha-check-run/index.mjs +2 -0
- package/dist/gha-post-review/cli.mjs +1 -1
- package/dist/gha-post-review/github.d.mts +6 -22
- package/dist/gha-post-review/github.mjs +8 -92
- package/dist/gha-post-review/post.d.mts +7 -1
- package/dist/gha-post-review/post.mjs +11 -3
- package/dist/gha-post-review/pull-io.d.mts +13 -0
- package/dist/gha-post-review/pull-io.mjs +88 -0
- package/dist/index.d.mts +4 -3
- package/dist/index.mjs +2 -2
- package/dist/markdown/ast.d.mts +8 -0
- package/dist/markdown/ast.mjs +29 -0
- package/dist/markdown/index.d.mts +6 -0
- package/dist/markdown/index.mjs +5 -0
- package/dist/markdown/loose-pipe-rows.d.mts +2 -0
- package/dist/markdown/loose-pipe-rows.mjs +31 -0
- package/dist/markdown/sections.d.mts +2 -0
- package/dist/markdown/sections.mjs +25 -0
- package/dist/markdown/tables.d.mts +3 -0
- package/dist/markdown/tables.mjs +43 -0
- package/dist/markdown/text.d.mts +2 -0
- package/dist/markdown/text.mjs +22 -0
- package/dist/markdown/types.d.mts +35 -0
- package/dist/markdown/types.mjs +1 -0
- package/dist/scc-complexity/baseline.d.mts +6 -0
- package/dist/scc-complexity/baseline.mjs +90 -0
- package/dist/scc-complexity/constants.d.mts +1 -0
- package/dist/scc-complexity/constants.mjs +1 -0
- package/dist/scc-complexity/index.d.mts +6 -14
- package/dist/scc-complexity/index.mjs +64 -39
- package/dist/scc-complexity/parser.d.mts +2 -0
- package/dist/scc-complexity/parser.mjs +21 -0
- package/dist/scc-complexity/paths.d.mts +4 -0
- package/dist/scc-complexity/paths.mjs +44 -0
- package/dist/scc-complexity/scope-config.d.mts +3 -0
- package/dist/scc-complexity/scope-config.mjs +35 -0
- package/dist/scc-complexity/types.d.mts +32 -0
- package/dist/scc-complexity/types.mjs +1 -0
- package/dist/scc-complexity/workflow-command.d.mts +2 -0
- package/dist/scc-complexity/workflow-command.mjs +6 -0
- package/package.json +15 -1
package/README.md
CHANGED
|
@@ -93,6 +93,11 @@ ancestor of `HEAD`. `gitleaks-directory-scan` builds and scans isolated staged-i
|
|
|
93
93
|
nonignored-working-tree mirrors with an explicit config; `--directory` selects the repository root.
|
|
94
94
|
`ast-grep-examples` runs native `ast-grep test`, then validates each scoped rule's `files:` and
|
|
95
95
|
`ignores:` examples with project `languageGlobs` replay from its root `--config`.
|
|
96
|
+
`compareAstGrepCompanions` compares recursive `<name>.yml`/`.yaml` and `<name>-tsx` companion
|
|
97
|
+
rules across every YAML field, returns stable JSON-pointer differences, and rejects unsafe or
|
|
98
|
+
ambiguous rule paths. The supplied rule path and every ancestor must be physical directories; YAML
|
|
99
|
+
aliases and non-JSON tagged values are rejected before comparison. Callers own any explicit
|
|
100
|
+
normalization for language-specific differences.
|
|
96
101
|
`ast-grep-pack` prints JSON `{ rules, config }` for the shipped unconditional rule pack. Point a
|
|
97
102
|
consumer `sgconfig.yml` `ruleDirs` at `rules` and keep product-specific YAML locally.
|
|
98
103
|
`gha-workspace-policy` checks tracked workflow and composite-action files in the current repository;
|
|
@@ -186,6 +191,13 @@ import {
|
|
|
186
191
|
import { buildOpenApiDocument, writeOpenApi } from 'vouchington-tooling/openapi-document'
|
|
187
192
|
import { decide, deriveRetryAttempt } from 'vouchington-tooling/transient-retry'
|
|
188
193
|
import { parseCsvRows, streamCsvRows } from 'vouchington-tooling/csv'
|
|
194
|
+
import {
|
|
195
|
+
extractLooseMarkdownTableRows,
|
|
196
|
+
extractMarkdownTables,
|
|
197
|
+
markdownSectionBetweenHeadings,
|
|
198
|
+
parseGfmMarkdown,
|
|
199
|
+
parseMarkdownTables,
|
|
200
|
+
} from 'vouchington-tooling/markdown'
|
|
189
201
|
import { readResponseBody } from 'vouchington-tooling/http-body'
|
|
190
202
|
import { runAstGrepRule } from 'vouchington-tooling/ast-grep-rule'
|
|
191
203
|
import { parseReviewPayload, remapReviewComments } from 'vouchington-tooling/gha-review-payload'
|
|
@@ -228,6 +240,13 @@ import {
|
|
|
228
240
|
} from 'vouchington-tooling/gh-api-shell-quoting'
|
|
229
241
|
```
|
|
230
242
|
|
|
243
|
+
`checkSccComplexity` keeps its single repository-wide scan when `scopes` is omitted. Consumers
|
|
244
|
+
that need separately ratcheted areas may provide named scopes with positional `includePaths`; SCC
|
|
245
|
+
runs once per scope and reports the scope in each diagnostic. Parse a consumer-owned JSON baseline
|
|
246
|
+
with `parseSccComplexityBaseline` and pass it as `baseline`. Baselines are versioned, record the
|
|
247
|
+
maximum permitted complexity for each `{ scope, file }`, suppress only values at or below that
|
|
248
|
+
ceiling, and reject malformed, duplicate, untracked, stale, or out-of-scope entries.
|
|
249
|
+
|
|
231
250
|
`shellScriptViolations`/`workflowYamlViolations` flag a `gh api` call whose argument carries an
|
|
232
251
|
unquoted `?` or `&`: an unquoted `&` silently backgrounds the command and truncates the query
|
|
233
252
|
(the call still exits 0), and an unquoted `?` fails loudly under zsh glob-nomatch but passes
|
|
@@ -241,6 +260,13 @@ shell script or a workflow/action YAML file is left to the caller.
|
|
|
241
260
|
code-point limit without altering it. Its result includes the UTF-8 byte count for diagnostics; that
|
|
242
261
|
byte count is not a validation limit.
|
|
243
262
|
|
|
263
|
+
`vouchington-tooling/markdown` parses GFM into standard mdast/unist nodes, provides pre-order
|
|
264
|
+
walking and typed searches, normalizes node text, and extracts positioned tables or heading-bounded
|
|
265
|
+
source sections. `parseMarkdownTables` preserves its compact `{ cells, line }[][]` compatibility
|
|
266
|
+
shape, including short table delimiters. `extractLooseMarkdownTableRows` is intentionally literal
|
|
267
|
+
recovery for malformed pipe rows; callers supply table positions to exclude and retain ownership of
|
|
268
|
+
their policy interpretation.
|
|
269
|
+
|
|
244
270
|
`agent-harness-config` merges classifier-auto and sandbox keys into Claude, Codex, Grok, and Cursor
|
|
245
271
|
config files. See [docs/agent-harness-config.md](./docs/agent-harness-config.md). `--global` updates
|
|
246
272
|
home-directory configs; `--repo` updates a checkout. It does not copy allowlists, hooks, or plugins.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export interface AstGrepCompanionDifference {
|
|
2
|
+
readonly baseFile: string;
|
|
3
|
+
readonly companionFile: string;
|
|
4
|
+
readonly path: string;
|
|
5
|
+
readonly base: unknown;
|
|
6
|
+
readonly companion: unknown;
|
|
7
|
+
}
|
|
8
|
+
export interface AstGrepCompanionParityOptions {
|
|
9
|
+
readonly rules: string;
|
|
10
|
+
readonly companionSuffix?: string;
|
|
11
|
+
readonly normalize?: (document: unknown, context: AstGrepCompanionContext) => unknown;
|
|
12
|
+
}
|
|
13
|
+
export interface AstGrepCompanionContext {
|
|
14
|
+
readonly file: string;
|
|
15
|
+
readonly role: 'base' | 'companion';
|
|
16
|
+
}
|
|
17
|
+
export declare function compareCodeUnits(left: string, right: string): number;
|
|
18
|
+
/** Compares recursive `<name>.yml`/`.yaml` rules with `<name>-tsx` companions. */
|
|
19
|
+
export declare function compareAstGrepCompanions(options: AstGrepCompanionParityOptions): AstGrepCompanionDifference[];
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import * as fs from 'node:fs';
|
|
2
|
+
import { dirname, join, resolve } from 'node:path';
|
|
3
|
+
import { parse as yamlLoad } from 'yaml';
|
|
4
|
+
const YAML_EXTENSION = /\.ya?ml$/u;
|
|
5
|
+
export function compareCodeUnits(left, right) {
|
|
6
|
+
if (left < right)
|
|
7
|
+
return -1;
|
|
8
|
+
if (left > right)
|
|
9
|
+
return 1;
|
|
10
|
+
return 0;
|
|
11
|
+
}
|
|
12
|
+
function assertPhysicalPath(path) {
|
|
13
|
+
let ancestor = path;
|
|
14
|
+
while (true) {
|
|
15
|
+
if (fs.lstatSync(ancestor).isSymbolicLink())
|
|
16
|
+
throw new Error('rules: symbolic links are not allowed');
|
|
17
|
+
const parent = dirname(ancestor);
|
|
18
|
+
if (parent === ancestor)
|
|
19
|
+
return;
|
|
20
|
+
ancestor = parent;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
function yamlFiles(directory, relative = '') {
|
|
24
|
+
const entries = fs
|
|
25
|
+
.readdirSync(directory, { withFileTypes: true })
|
|
26
|
+
.toSorted((a, b) => compareCodeUnits(a.name, b.name));
|
|
27
|
+
const files = [];
|
|
28
|
+
for (const entry of entries) {
|
|
29
|
+
const file = relative ? `${relative}/${entry.name}` : entry.name;
|
|
30
|
+
if (entry.isSymbolicLink())
|
|
31
|
+
throw new Error(`${file}: symbolic links are not allowed`);
|
|
32
|
+
if (entry.isDirectory())
|
|
33
|
+
files.push(...yamlFiles(join(directory, entry.name), file));
|
|
34
|
+
else if (entry.isFile() && YAML_EXTENSION.test(entry.name))
|
|
35
|
+
files.push(file);
|
|
36
|
+
}
|
|
37
|
+
return files;
|
|
38
|
+
}
|
|
39
|
+
function loadDocument(rules, file) {
|
|
40
|
+
try {
|
|
41
|
+
const document = yamlLoad(fs.readFileSync(join(rules, file), 'utf8'), { maxAliasCount: 0 });
|
|
42
|
+
assertJsonValue(document);
|
|
43
|
+
return document;
|
|
44
|
+
}
|
|
45
|
+
catch (error) {
|
|
46
|
+
throw new Error(`${file}: invalid YAML: ${String(error)}`);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
function stem(file) {
|
|
50
|
+
return file.replace(YAML_EXTENSION, '');
|
|
51
|
+
}
|
|
52
|
+
function pointer(path, key) {
|
|
53
|
+
const segment = String(key).replaceAll('~', '~0').replaceAll('/', '~1');
|
|
54
|
+
return `${path}/${segment}`;
|
|
55
|
+
}
|
|
56
|
+
function isRecord(value) {
|
|
57
|
+
if (value === null || typeof value !== 'object' || Array.isArray(value))
|
|
58
|
+
return false;
|
|
59
|
+
const prototype = Object.getPrototypeOf(value);
|
|
60
|
+
return prototype === null || prototype === Object.prototype;
|
|
61
|
+
}
|
|
62
|
+
function assertJsonValue(value, ancestors = new WeakSet()) {
|
|
63
|
+
if (value === null || typeof value === 'string' || typeof value === 'boolean')
|
|
64
|
+
return;
|
|
65
|
+
if (typeof value === 'number' && Number.isFinite(value))
|
|
66
|
+
return;
|
|
67
|
+
if (Array.isArray(value)) {
|
|
68
|
+
if (ancestors.has(value))
|
|
69
|
+
throw new Error('unsupported cyclic YAML value');
|
|
70
|
+
ancestors.add(value);
|
|
71
|
+
for (const item of value)
|
|
72
|
+
assertJsonValue(item, ancestors);
|
|
73
|
+
ancestors.delete(value);
|
|
74
|
+
return;
|
|
75
|
+
}
|
|
76
|
+
if (isRecord(value)) {
|
|
77
|
+
if (ancestors.has(value))
|
|
78
|
+
throw new Error('unsupported cyclic YAML value');
|
|
79
|
+
ancestors.add(value);
|
|
80
|
+
for (const item of Object.values(value))
|
|
81
|
+
assertJsonValue(item, ancestors);
|
|
82
|
+
ancestors.delete(value);
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
throw new Error('unsupported non-JSON YAML value');
|
|
86
|
+
}
|
|
87
|
+
function compare(base, companion, path, difference) {
|
|
88
|
+
if (Object.is(base, companion))
|
|
89
|
+
return;
|
|
90
|
+
if (Array.isArray(base) && Array.isArray(companion)) {
|
|
91
|
+
const length = Math.max(base.length, companion.length);
|
|
92
|
+
for (let index = 0; index < length; index++)
|
|
93
|
+
compare(base[index], companion[index], pointer(path, index), difference);
|
|
94
|
+
return;
|
|
95
|
+
}
|
|
96
|
+
if (isRecord(base) && isRecord(companion)) {
|
|
97
|
+
for (const key of [...new Set([...Object.keys(base), ...Object.keys(companion)])].toSorted(compareCodeUnits))
|
|
98
|
+
compare(base[key], companion[key], pointer(path, key), difference);
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
difference(path, base, companion);
|
|
102
|
+
}
|
|
103
|
+
function assertSuffix(suffix) {
|
|
104
|
+
if (!suffix || /[\\/]/u.test(suffix))
|
|
105
|
+
throw new Error('companionSuffix must be a non-empty filename suffix');
|
|
106
|
+
}
|
|
107
|
+
/** Compares recursive `<name>.yml`/`.yaml` rules with `<name>-tsx` companions. */
|
|
108
|
+
export function compareAstGrepCompanions(options) {
|
|
109
|
+
const suffix = options.companionSuffix ?? '-tsx';
|
|
110
|
+
assertSuffix(suffix);
|
|
111
|
+
const rules = resolve(options.rules);
|
|
112
|
+
assertPhysicalPath(rules);
|
|
113
|
+
const files = yamlFiles(rules);
|
|
114
|
+
const basesByStem = new Map();
|
|
115
|
+
const companions = [];
|
|
116
|
+
for (const file of files) {
|
|
117
|
+
const fileStem = stem(file);
|
|
118
|
+
if (fileStem.endsWith(suffix))
|
|
119
|
+
companions.push({ file, baseStem: fileStem.slice(0, -suffix.length) });
|
|
120
|
+
else
|
|
121
|
+
basesByStem.set(fileStem, [...(basesByStem.get(fileStem) ?? []), file]);
|
|
122
|
+
}
|
|
123
|
+
const companionsByStem = new Map();
|
|
124
|
+
for (const { file, baseStem } of companions)
|
|
125
|
+
companionsByStem.set(baseStem, [...(companionsByStem.get(baseStem) ?? []), file]);
|
|
126
|
+
for (const [baseStem, companionFiles] of companionsByStem)
|
|
127
|
+
if (companionFiles.length > 1)
|
|
128
|
+
throw new Error(`${baseStem}: duplicate companion rules: ${companionFiles.toSorted(compareCodeUnits).join(', ')}`);
|
|
129
|
+
const differences = [];
|
|
130
|
+
for (const { file: companionFile, baseStem } of companions) {
|
|
131
|
+
const bases = basesByStem.get(baseStem) ?? [];
|
|
132
|
+
if (!bases.length)
|
|
133
|
+
throw new Error(`${companionFile}: missing base companion`);
|
|
134
|
+
if (bases.length > 1)
|
|
135
|
+
throw new Error(`${companionFile}: duplicate base companions: ${bases.toSorted(compareCodeUnits).join(', ')}`);
|
|
136
|
+
const baseFile = bases[0];
|
|
137
|
+
const normalize = options.normalize ?? ((document) => document);
|
|
138
|
+
const base = normalize(loadDocument(rules, baseFile), { file: baseFile, role: 'base' });
|
|
139
|
+
const companion = normalize(loadDocument(rules, companionFile), {
|
|
140
|
+
file: companionFile,
|
|
141
|
+
role: 'companion',
|
|
142
|
+
});
|
|
143
|
+
assertJsonValue(base);
|
|
144
|
+
assertJsonValue(companion);
|
|
145
|
+
compare(base, companion, '', (path, baseValue, companionValue) => {
|
|
146
|
+
differences.push({
|
|
147
|
+
baseFile,
|
|
148
|
+
companionFile,
|
|
149
|
+
path,
|
|
150
|
+
base: baseValue,
|
|
151
|
+
companion: companionValue,
|
|
152
|
+
});
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
return differences;
|
|
156
|
+
}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
export { compareAstGrepCompanions } from './companion-parity.mts';
|
|
2
|
+
export type { AstGrepCompanionContext, AstGrepCompanionDifference, AstGrepCompanionParityOptions, } from './companion-parity.mts';
|
|
1
3
|
interface AstGrepResult {
|
|
2
4
|
status: number | null;
|
|
3
5
|
stdout?: string;
|
|
@@ -12,4 +14,3 @@ export interface AstGrepExamplesOptions {
|
|
|
12
14
|
}
|
|
13
15
|
export declare function astGrepExamplesArguments(options: AstGrepExamplesOptions): string[];
|
|
14
16
|
export declare function runAstGrepExamples(options: AstGrepExamplesOptions): number;
|
|
15
|
-
export {};
|
|
@@ -4,6 +4,7 @@ import { tmpdir } from 'node:os';
|
|
|
4
4
|
import { dirname, isAbsolute, join, resolve } from 'node:path';
|
|
5
5
|
import picomatch from 'picomatch';
|
|
6
6
|
import { parse as yamlLoad, stringify as yamlDump } from 'yaml';
|
|
7
|
+
export { compareAstGrepCompanions } from './companion-parity.mjs';
|
|
7
8
|
export function astGrepExamplesArguments(options) {
|
|
8
9
|
return [
|
|
9
10
|
'test',
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { appendFileSync } from 'node:fs';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
import { createGhExec } from '../gha-post-review/github.mjs';
|
|
4
|
+
import { completeCheckRun, createCheckRun, CheckRunError, } from './github.mjs';
|
|
5
|
+
function requireEnv(name, env) {
|
|
6
|
+
const value = env[name];
|
|
7
|
+
if (!value)
|
|
8
|
+
throw new CheckRunError(`${name} is required.`);
|
|
9
|
+
return value;
|
|
10
|
+
}
|
|
11
|
+
function parseStatus(value) {
|
|
12
|
+
if (value !== 'in_progress' && value !== 'completed') {
|
|
13
|
+
throw new CheckRunError(`STATUS must be "in_progress" or "completed" (got "${value}").`);
|
|
14
|
+
}
|
|
15
|
+
return value;
|
|
16
|
+
}
|
|
17
|
+
function parseConclusion(value) {
|
|
18
|
+
if (value !== 'success' && value !== 'neutral') {
|
|
19
|
+
throw new CheckRunError(`CONCLUSION must be "success" or "neutral" (got "${value}").`);
|
|
20
|
+
}
|
|
21
|
+
return value;
|
|
22
|
+
}
|
|
23
|
+
function appendOutput(name, value, outputPath) {
|
|
24
|
+
if (!outputPath)
|
|
25
|
+
return;
|
|
26
|
+
appendFileSync(outputPath, `${name}=${value}\n`);
|
|
27
|
+
}
|
|
28
|
+
/** Builds a create-check-run input from env, requiring CONCLUSION only when STATUS is completed. */
|
|
29
|
+
function readCreateInput(env) {
|
|
30
|
+
const status = parseStatus(requireEnv('STATUS', env));
|
|
31
|
+
const shared = {
|
|
32
|
+
repository: requireEnv('GITHUB_REPOSITORY', env),
|
|
33
|
+
name: requireEnv('CHECK_NAME', env),
|
|
34
|
+
headSha: requireEnv('HEAD_SHA', env),
|
|
35
|
+
title: requireEnv('TITLE', env),
|
|
36
|
+
summary: requireEnv('SUMMARY', env),
|
|
37
|
+
};
|
|
38
|
+
if (status === 'completed') {
|
|
39
|
+
return { ...shared, status, conclusion: parseConclusion(requireEnv('CONCLUSION', env)) };
|
|
40
|
+
}
|
|
41
|
+
return { ...shared, status };
|
|
42
|
+
}
|
|
43
|
+
function runCreate(env, exec) {
|
|
44
|
+
const id = createCheckRun(readCreateInput(env), exec);
|
|
45
|
+
appendOutput('check_run_id', id, env.GITHUB_OUTPUT);
|
|
46
|
+
}
|
|
47
|
+
/** No-ops when CHECK_RUN_ID is unset: the create step may have already finalized the check. */
|
|
48
|
+
function runComplete(env, exec) {
|
|
49
|
+
const checkRunId = env.CHECK_RUN_ID ?? '';
|
|
50
|
+
if (checkRunId === '')
|
|
51
|
+
return;
|
|
52
|
+
completeCheckRun({
|
|
53
|
+
repository: requireEnv('GITHUB_REPOSITORY', env),
|
|
54
|
+
checkRunId,
|
|
55
|
+
conclusion: parseConclusion(requireEnv('CONCLUSION', env)),
|
|
56
|
+
title: requireEnv('TITLE', env),
|
|
57
|
+
summary: requireEnv('SUMMARY', env),
|
|
58
|
+
}, exec);
|
|
59
|
+
}
|
|
60
|
+
export function runCheckRunCli(argv = process.argv, env = process.env, exec = createGhExec()) {
|
|
61
|
+
const subcommand = argv[2];
|
|
62
|
+
try {
|
|
63
|
+
if (subcommand === 'create') {
|
|
64
|
+
runCreate(env, exec);
|
|
65
|
+
return 0;
|
|
66
|
+
}
|
|
67
|
+
if (subcommand === 'complete') {
|
|
68
|
+
runComplete(env, exec);
|
|
69
|
+
return 0;
|
|
70
|
+
}
|
|
71
|
+
throw new CheckRunError(`Unknown subcommand "${String(subcommand)}". Use create or complete.`);
|
|
72
|
+
}
|
|
73
|
+
catch (error) {
|
|
74
|
+
process.stderr.write(`Error: ${error instanceof Error ? error.message : String(error)}\n`);
|
|
75
|
+
return 1;
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
/* v8 ignore next 3 */
|
|
79
|
+
if (process.argv[1] === fileURLToPath(import.meta.url)) {
|
|
80
|
+
process.exitCode = runCheckRunCli();
|
|
81
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { GhExec } from '../gha-post-review/github.mts';
|
|
2
|
+
export declare class CheckRunError extends Error {
|
|
3
|
+
constructor(message: string);
|
|
4
|
+
}
|
|
5
|
+
export type CheckRunStatus = 'in_progress' | 'completed';
|
|
6
|
+
export type CheckRunConclusion = 'success' | 'neutral';
|
|
7
|
+
export type CreateCheckRunInput = {
|
|
8
|
+
repository: string;
|
|
9
|
+
name: string;
|
|
10
|
+
headSha: string;
|
|
11
|
+
title: string;
|
|
12
|
+
summary: string;
|
|
13
|
+
} & ({
|
|
14
|
+
status: 'in_progress';
|
|
15
|
+
conclusion?: undefined;
|
|
16
|
+
} | {
|
|
17
|
+
status: 'completed';
|
|
18
|
+
conclusion: CheckRunConclusion;
|
|
19
|
+
});
|
|
20
|
+
export type CompleteCheckRunInput = {
|
|
21
|
+
repository: string;
|
|
22
|
+
checkRunId: string;
|
|
23
|
+
conclusion: CheckRunConclusion;
|
|
24
|
+
title: string;
|
|
25
|
+
summary: string;
|
|
26
|
+
};
|
|
27
|
+
/** Creates a GitHub check run, returning the API-assigned check run id. */
|
|
28
|
+
export declare function createCheckRun(input: CreateCheckRunInput, exec: GhExec): string;
|
|
29
|
+
/** Transitions an existing check run to `completed` with a final conclusion. */
|
|
30
|
+
export declare function completeCheckRun(input: CompleteCheckRunInput, exec: GhExec): void;
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
export class CheckRunError extends Error {
|
|
2
|
+
constructor(message) {
|
|
3
|
+
super(message);
|
|
4
|
+
this.name = 'CheckRunError';
|
|
5
|
+
}
|
|
6
|
+
}
|
|
7
|
+
function isFullCommitSha(value) {
|
|
8
|
+
return /^[0-9a-f]{40}$/u.test(value);
|
|
9
|
+
}
|
|
10
|
+
function isCheckRunId(value) {
|
|
11
|
+
return /^[0-9]+$/u.test(value);
|
|
12
|
+
}
|
|
13
|
+
function parseCheckRunId(raw) {
|
|
14
|
+
let parsed;
|
|
15
|
+
try {
|
|
16
|
+
parsed = JSON.parse(raw);
|
|
17
|
+
}
|
|
18
|
+
catch {
|
|
19
|
+
throw new CheckRunError('Check run creation response was not valid JSON.');
|
|
20
|
+
}
|
|
21
|
+
const id = parsed !== null && typeof parsed === 'object' ? parsed.id : undefined;
|
|
22
|
+
if (typeof id !== 'number' && typeof id !== 'string') {
|
|
23
|
+
throw new CheckRunError('Check run creation response did not include an id.');
|
|
24
|
+
}
|
|
25
|
+
return String(id);
|
|
26
|
+
}
|
|
27
|
+
/** Creates a GitHub check run, returning the API-assigned check run id. */
|
|
28
|
+
export function createCheckRun(input, exec) {
|
|
29
|
+
if (!isFullCommitSha(input.headSha)) {
|
|
30
|
+
throw new CheckRunError('headSha must be a full lowercase 40-character commit SHA.');
|
|
31
|
+
}
|
|
32
|
+
const body = {
|
|
33
|
+
name: input.name,
|
|
34
|
+
head_sha: input.headSha,
|
|
35
|
+
status: input.status,
|
|
36
|
+
output: { title: input.title, summary: input.summary },
|
|
37
|
+
};
|
|
38
|
+
if (input.status === 'completed')
|
|
39
|
+
body.conclusion = input.conclusion;
|
|
40
|
+
const raw = exec(['api', '--method', 'POST', `repos/${input.repository}/check-runs`, '--input', '-'], {
|
|
41
|
+
input: JSON.stringify(body),
|
|
42
|
+
});
|
|
43
|
+
return parseCheckRunId(raw);
|
|
44
|
+
}
|
|
45
|
+
/** Transitions an existing check run to `completed` with a final conclusion. */
|
|
46
|
+
export function completeCheckRun(input, exec) {
|
|
47
|
+
if (!isCheckRunId(input.checkRunId)) {
|
|
48
|
+
throw new CheckRunError('checkRunId must be a positive integer.');
|
|
49
|
+
}
|
|
50
|
+
const body = {
|
|
51
|
+
status: 'completed',
|
|
52
|
+
conclusion: input.conclusion,
|
|
53
|
+
output: { title: input.title, summary: input.summary },
|
|
54
|
+
};
|
|
55
|
+
exec([
|
|
56
|
+
'api',
|
|
57
|
+
'--method',
|
|
58
|
+
'PATCH',
|
|
59
|
+
`repos/${input.repository}/check-runs/${input.checkRunId}`,
|
|
60
|
+
'--input',
|
|
61
|
+
'-',
|
|
62
|
+
], { input: JSON.stringify(body) });
|
|
63
|
+
}
|
|
@@ -3,7 +3,7 @@ import { writePostedOutput, postReviewFromEnv } from './github.mjs';
|
|
|
3
3
|
export async function runPostReviewCli(env = process.env) {
|
|
4
4
|
try {
|
|
5
5
|
const result = await postReviewFromEnv(env);
|
|
6
|
-
writePostedOutput(result.posted, env.GITHUB_OUTPUT);
|
|
6
|
+
writePostedOutput(result.posted, result.commentCount, env.GITHUB_OUTPUT);
|
|
7
7
|
return 0;
|
|
8
8
|
}
|
|
9
9
|
catch (error) {
|
|
@@ -1,29 +1,13 @@
|
|
|
1
1
|
import { execFileSync } from 'node:child_process';
|
|
2
|
-
import { type
|
|
2
|
+
import { type PostReviewResult } from './post.mts';
|
|
3
|
+
export { createGhPostReviewIo, postWithGh } from './pull-io.mts';
|
|
3
4
|
export type GhExec = (args: readonly string[], options?: {
|
|
4
5
|
input?: string;
|
|
5
6
|
env?: NodeJS.ProcessEnv;
|
|
6
7
|
}) => string;
|
|
7
8
|
export declare function createGhExec(exec?: typeof execFileSync): GhExec;
|
|
8
|
-
export declare function
|
|
9
|
-
export declare function writePostedOutput(posted: boolean, outputPath?: string | undefined): void;
|
|
10
|
-
export declare function createGhPostReviewIo(options: {
|
|
11
|
-
repository: string;
|
|
12
|
-
prNumber: string;
|
|
13
|
-
payloadPath: string;
|
|
14
|
-
payloadBytes: Buffer;
|
|
15
|
-
token: string;
|
|
16
|
-
exec: GhExec;
|
|
17
|
-
expectedHeadSha?: string;
|
|
18
|
-
expectedBaseSha?: string;
|
|
19
|
-
}): PostReviewIo;
|
|
9
|
+
export declare function writePostedOutput(posted: boolean, commentCount: number, outputPath?: string | undefined): void;
|
|
20
10
|
/** @deprecated Use postReviewWithTokenFromEnv or postClaudeReviewFromEnv explicitly. */
|
|
21
|
-
export declare function postReviewFromEnv(env?: NodeJS.ProcessEnv, exec?: GhExec, claudeIo?: import("./claude-token.mts").ClaudeTokenIo): Promise<
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
export declare function postReviewWithTokenFromEnv(env?: NodeJS.ProcessEnv, exec?: GhExec, token?: string | undefined): {
|
|
25
|
-
posted: boolean;
|
|
26
|
-
};
|
|
27
|
-
export declare function postClaudeReviewFromEnv(env?: NodeJS.ProcessEnv, exec?: GhExec, claudeIo?: import("./claude-token.mts").ClaudeTokenIo): Promise<{
|
|
28
|
-
posted: boolean;
|
|
29
|
-
}>;
|
|
11
|
+
export declare function postReviewFromEnv(env?: NodeJS.ProcessEnv, exec?: GhExec, claudeIo?: import("./claude-token.mts").ClaudeTokenIo): Promise<PostReviewResult>;
|
|
12
|
+
export declare function postReviewWithTokenFromEnv(env?: NodeJS.ProcessEnv, exec?: GhExec, token?: string | undefined): PostReviewResult;
|
|
13
|
+
export declare function postClaudeReviewFromEnv(env?: NodeJS.ProcessEnv, exec?: GhExec, claudeIo?: import("./claude-token.mts").ClaudeTokenIo): Promise<PostReviewResult>;
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { execFileSync } from 'node:child_process';
|
|
2
|
-
import { appendFileSync
|
|
3
|
-
import { parseReviewFilesJson } from '../gha-review-payload/index.mjs';
|
|
2
|
+
import { appendFileSync } from 'node:fs';
|
|
4
3
|
import { ReviewPayloadError } from '../gha-review-payload/index.mjs';
|
|
4
|
+
import { readRegularReviewPayload } from '../gha-review-payload/index.mjs';
|
|
5
5
|
import { createActionsClaudeTokenIo, withClaudeAppToken } from './claude-token.mjs';
|
|
6
6
|
import { runPostReview } from './post.mjs';
|
|
7
|
+
import { createGhPostReviewIo } from './pull-io.mjs';
|
|
7
8
|
import { requireEnv, resolveReviewPostToken } from './token.mjs';
|
|
8
|
-
|
|
9
|
+
export { createGhPostReviewIo, postWithGh } from './pull-io.mjs';
|
|
9
10
|
export function createGhExec(exec = execFileSync) {
|
|
10
11
|
return (args, options) => exec('gh', [...args], {
|
|
11
12
|
encoding: 'utf8',
|
|
@@ -13,96 +14,10 @@ export function createGhExec(exec = execFileSync) {
|
|
|
13
14
|
env: options?.env ?? process.env,
|
|
14
15
|
}).trim();
|
|
15
16
|
}
|
|
16
|
-
export function
|
|
17
|
-
try {
|
|
18
|
-
exec(['api', '--method', 'POST', `repos/${repository}/pulls/${prNumber}/reviews`, '--input', '-'], {
|
|
19
|
-
input: JSON.stringify(payload),
|
|
20
|
-
env: { ...process.env, GH_TOKEN: token, GITHUB_TOKEN: token },
|
|
21
|
-
});
|
|
22
|
-
return { ok: true, status: 201, body: '' };
|
|
23
|
-
}
|
|
24
|
-
catch (error) {
|
|
25
|
-
// oxlint-disable-next-line no-mistakes/ts-no-const-aliases -- isolate the process-error shape assertion at the catch boundary
|
|
26
|
-
const err = error;
|
|
27
|
-
const text = `${err.stdout ?? ''}${err.stderr ?? ''}${err.message ?? ''}`;
|
|
28
|
-
const status = Number(/HTTP\s+(\d{3})/u.exec(text)?.[1] ?? 0);
|
|
29
|
-
return { ok: false, status, body: text };
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
export function writePostedOutput(posted, outputPath = process.env.GITHUB_OUTPUT) {
|
|
17
|
+
export function writePostedOutput(posted, commentCount, outputPath = process.env.GITHUB_OUTPUT) {
|
|
33
18
|
if (!outputPath)
|
|
34
19
|
return;
|
|
35
|
-
appendFileSync(outputPath, `posted=${posted ? 'true' : 'false'}\n`);
|
|
36
|
-
}
|
|
37
|
-
function readPullState(repository, prNumber, exec) {
|
|
38
|
-
let lastError;
|
|
39
|
-
for (let attempt = 1; attempt <= 3; attempt += 1) {
|
|
40
|
-
try {
|
|
41
|
-
return exec([
|
|
42
|
-
'api',
|
|
43
|
-
`repos/${repository}/pulls/${prNumber}`,
|
|
44
|
-
'--jq',
|
|
45
|
-
'[.head.sha, .base.sha, .draft, .state] | @tsv',
|
|
46
|
-
]).split('\t');
|
|
47
|
-
}
|
|
48
|
-
catch (error) {
|
|
49
|
-
lastError = error;
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
throw lastError;
|
|
53
|
-
}
|
|
54
|
-
export function createGhPostReviewIo(options) {
|
|
55
|
-
const { repository, prNumber, payloadBytes, token, exec, expectedHeadSha, expectedBaseSha } = options;
|
|
56
|
-
return {
|
|
57
|
-
readFile() {
|
|
58
|
-
return payloadBytes;
|
|
59
|
-
},
|
|
60
|
-
removeFile(path) {
|
|
61
|
-
rmSync(path, { force: true });
|
|
62
|
-
},
|
|
63
|
-
getHeadSha() {
|
|
64
|
-
if (!/^[1-9][0-9]*$/u.test(prNumber)) {
|
|
65
|
-
throw new ReviewPayloadError('PR_NUMBER must be a positive integer.');
|
|
66
|
-
}
|
|
67
|
-
if (Boolean(expectedHeadSha) !== Boolean(expectedBaseSha)) {
|
|
68
|
-
throw new ReviewPayloadError('EXPECTED_HEAD_SHA and EXPECTED_BASE_SHA must be provided together.');
|
|
69
|
-
}
|
|
70
|
-
if (expectedHeadSha && !/^[0-9a-f]{40}$/u.test(expectedHeadSha)) {
|
|
71
|
-
throw new ReviewPayloadError('EXPECTED_HEAD_SHA must be a full lowercase commit SHA.');
|
|
72
|
-
}
|
|
73
|
-
if (expectedBaseSha && !/^[0-9a-f]{40}$/u.test(expectedBaseSha)) {
|
|
74
|
-
throw new ReviewPayloadError('EXPECTED_BASE_SHA must be a full lowercase commit SHA.');
|
|
75
|
-
}
|
|
76
|
-
const state = readPullState(repository, prNumber, exec);
|
|
77
|
-
const [headSha = '', baseSha = '', draft = '', pullState = ''] = state;
|
|
78
|
-
if (!/^[0-9a-f]{40}$/u.test(headSha)) {
|
|
79
|
-
throw new ReviewPayloadError(`Could not resolve PR head SHA (got "${headSha}").`);
|
|
80
|
-
}
|
|
81
|
-
if (!/^[0-9a-f]{40}$/u.test(baseSha)) {
|
|
82
|
-
throw new ReviewPayloadError(`Could not resolve PR base SHA (got "${baseSha}").`);
|
|
83
|
-
}
|
|
84
|
-
if (draft !== 'false') {
|
|
85
|
-
throw new ReviewPayloadError('Pull request became a draft before posting the review.');
|
|
86
|
-
}
|
|
87
|
-
if (pullState !== 'open') {
|
|
88
|
-
throw new ReviewPayloadError('Pull request closed before posting the review.');
|
|
89
|
-
}
|
|
90
|
-
if (expectedHeadSha && headSha !== expectedHeadSha) {
|
|
91
|
-
throw new ReviewPayloadError('PR head changed before posting the selected review.');
|
|
92
|
-
}
|
|
93
|
-
if (expectedBaseSha && baseSha !== expectedBaseSha) {
|
|
94
|
-
throw new ReviewPayloadError('PR base changed before posting the selected review.');
|
|
95
|
-
}
|
|
96
|
-
// Preserve the orchestrator-selected revision as the review commit_id after equality checks.
|
|
97
|
-
return expectedHeadSha || headSha;
|
|
98
|
-
},
|
|
99
|
-
listPullFiles() {
|
|
100
|
-
return parseReviewFilesJson(exec(['api', '--paginate', `repos/${repository}/pulls/${prNumber}/files?per_page=100`]));
|
|
101
|
-
},
|
|
102
|
-
postReview(payload) {
|
|
103
|
-
return postWithGh(repository, prNumber, payload, token, exec);
|
|
104
|
-
},
|
|
105
|
-
};
|
|
20
|
+
appendFileSync(outputPath, `posted=${posted ? 'true' : 'false'}\ncomment_count=${commentCount}\n`);
|
|
106
21
|
}
|
|
107
22
|
/** @deprecated Use postReviewWithTokenFromEnv or postClaudeReviewFromEnv explicitly. */
|
|
108
23
|
export async function postReviewFromEnv(env = process.env, exec = createGhExec(), claudeIo = createActionsClaudeTokenIo(env)) {
|
|
@@ -116,6 +31,7 @@ function createPostWithToken(env, exec) {
|
|
|
116
31
|
const prNumber = requireEnv('PR_NUMBER', env);
|
|
117
32
|
const payloadPath = requireEnv('CODE_REVIEW_PAYLOAD_PATH', env);
|
|
118
33
|
const payloadBytes = readRegularReviewPayload(payloadPath, 'required');
|
|
34
|
+
const providerName = env.PROVIDER_NAME || undefined;
|
|
119
35
|
return (token) => runPostReview(payloadPath, createGhPostReviewIo({
|
|
120
36
|
repository,
|
|
121
37
|
prNumber,
|
|
@@ -125,7 +41,7 @@ function createPostWithToken(env, exec) {
|
|
|
125
41
|
exec,
|
|
126
42
|
expectedHeadSha: env.EXPECTED_HEAD_SHA ?? '',
|
|
127
43
|
expectedBaseSha: env.EXPECTED_BASE_SHA ?? '',
|
|
128
|
-
}));
|
|
44
|
+
}), providerName);
|
|
129
45
|
}
|
|
130
46
|
function withTokenEnv(exec, env, token) {
|
|
131
47
|
const tokenEnv = { ...env, GH_TOKEN: token, GITHUB_TOKEN: token };
|
|
@@ -13,6 +13,12 @@ export type PostReviewIo = {
|
|
|
13
13
|
listPullFiles(): PullFile[];
|
|
14
14
|
postReview(payload: SanitizedReview): PostResult;
|
|
15
15
|
};
|
|
16
|
-
export
|
|
16
|
+
export type PostReviewResult = {
|
|
17
17
|
posted: boolean;
|
|
18
|
+
commentCount: number;
|
|
18
19
|
};
|
|
20
|
+
/**
|
|
21
|
+
* Posts a validated review, optionally prefixing the body with a provider attribution line.
|
|
22
|
+
* The attribution is cosmetic (final posted text only); it never affects staged payload bytes.
|
|
23
|
+
*/
|
|
24
|
+
export declare function runPostReview(payloadPath: string, io: PostReviewIo, providerName?: string): PostReviewResult;
|
|
@@ -6,7 +6,11 @@ MAX_REVIEW_COMMENTS as MAX_COMMENTS,
|
|
|
6
6
|
MAX_REVIEW_PAYLOAD_BYTES as MAX_PAYLOAD_BYTES,
|
|
7
7
|
// oxlint-disable-next-line no-mistakes/ts-no-export-renaming -- preserve the package's established public compatibility name
|
|
8
8
|
ReviewPayloadError as PostReviewError, } from '../gha-review-payload/index.mjs';
|
|
9
|
-
|
|
9
|
+
/**
|
|
10
|
+
* Posts a validated review, optionally prefixing the body with a provider attribution line.
|
|
11
|
+
* The attribution is cosmetic (final posted text only); it never affects staged payload bytes.
|
|
12
|
+
*/
|
|
13
|
+
export function runPostReview(payloadPath, io, providerName) {
|
|
10
14
|
try {
|
|
11
15
|
const selectedHeadSha = io.getHeadSha();
|
|
12
16
|
let review = parseReviewPayload(io.readFile(payloadPath), selectedHeadSha);
|
|
@@ -20,9 +24,13 @@ export function runPostReview(payloadPath, io) {
|
|
|
20
24
|
if (io.getHeadSha() !== selectedHeadSha) {
|
|
21
25
|
throw new ReviewPayloadError('PR head changed while preparing the selected review.');
|
|
22
26
|
}
|
|
23
|
-
const
|
|
27
|
+
const commentCount = review.comments.length;
|
|
28
|
+
const attributedReview = providerName
|
|
29
|
+
? { ...review, body: `**${providerName} review**\n\n${review.body}` }
|
|
30
|
+
: review;
|
|
31
|
+
const first = io.postReview(attributedReview);
|
|
24
32
|
if (first.ok)
|
|
25
|
-
return { posted: true };
|
|
33
|
+
return { posted: true, commentCount };
|
|
26
34
|
throw new ReviewPayloadError(`GitHub review POST failed (HTTP ${first.status}).`);
|
|
27
35
|
}
|
|
28
36
|
finally {
|