@review-agent/core 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/dist/index.d.ts +393 -0
- package/dist/index.js +887 -0
- package/package.json +36 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Cristian Moldovan
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,393 @@
|
|
|
1
|
+
type Tier = 'basic' | 'normal' | 'thorough';
|
|
2
|
+
type Effort = 'low' | 'medium' | 'high' | 'xhigh' | 'max';
|
|
3
|
+
type ReportMode = 'inline+summary' | 'summary-only' | 'check-only' | 'silent';
|
|
4
|
+
type SkillSource = {
|
|
5
|
+
kind: 'dir';
|
|
6
|
+
path: string;
|
|
7
|
+
} | {
|
|
8
|
+
kind: 'git';
|
|
9
|
+
repo: string;
|
|
10
|
+
ref: string;
|
|
11
|
+
path?: string;
|
|
12
|
+
};
|
|
13
|
+
type TierSettings = {
|
|
14
|
+
agents: number;
|
|
15
|
+
effort: Effort;
|
|
16
|
+
check: boolean;
|
|
17
|
+
budgetUsd: number;
|
|
18
|
+
};
|
|
19
|
+
type SeverityBands = {
|
|
20
|
+
critical: number;
|
|
21
|
+
high: number;
|
|
22
|
+
medium: number;
|
|
23
|
+
};
|
|
24
|
+
type DeploymentConfig = {
|
|
25
|
+
command: string;
|
|
26
|
+
model: string;
|
|
27
|
+
effort: Effort;
|
|
28
|
+
tiers: Record<Tier, TierSettings>;
|
|
29
|
+
severity: {
|
|
30
|
+
bands: SeverityBands;
|
|
31
|
+
postInlineAtOrAbove: number;
|
|
32
|
+
};
|
|
33
|
+
report: {
|
|
34
|
+
mode: ReportMode;
|
|
35
|
+
maxInline: number;
|
|
36
|
+
maxFindings: number;
|
|
37
|
+
repeatNits: boolean;
|
|
38
|
+
firstReviewLowBandCap: number;
|
|
39
|
+
/** The name GitHub shows on the check run this deployment writes — the last of the three
|
|
40
|
+
* interface requirements the product owed its first deployment (plan 2, Task 2).
|
|
41
|
+
* A setting rather than a constant for two reasons: a branch protection rule keys on this
|
|
42
|
+
* exact string, so an adopter who already gates on a name of their own must be able to keep
|
|
43
|
+
* it; and two deployments against the same repository — staging beside production, or a
|
|
44
|
+
* second reviewer — are indistinguishable on the pull request if they share a name. */
|
|
45
|
+
checkRunName: string;
|
|
46
|
+
/** The severity at or above which the check run concludes `failure` instead of `success`.
|
|
47
|
+
* `null` is the gate off, and off is the default: a reviewer that fails builds on the day it
|
|
48
|
+
* is installed gets uninstalled. Deployment-only — `RepoConfig` has no equivalent, so a pull
|
|
49
|
+
* request cannot lower or lift its own gate.
|
|
50
|
+
* What it is compared against is the CHECK-ADJUSTED set: the disprove-it pass's severities,
|
|
51
|
+
* never a refuted finding (design §4.6, Criss 2026-09-14 decision 6). */
|
|
52
|
+
failAtOrAbove: number | null;
|
|
53
|
+
/** Whether only a finding the disprove-it pass CONFIRMED may fail a build. Off by default;
|
|
54
|
+
* a deployment turns it on when it wants the gate that strict. With it on, an `uncertain`
|
|
55
|
+
* verdict reports but cannot gate.
|
|
56
|
+
* A deployment that turns this on while the tier's check pass is off has disarmed its own
|
|
57
|
+
* gate — nothing is ever confirmed — and the check run's output says so rather than pretending
|
|
58
|
+
* the gate is armed. */
|
|
59
|
+
gateRequiresConfirmed: boolean;
|
|
60
|
+
};
|
|
61
|
+
skills: SkillSource[];
|
|
62
|
+
/** Extra review instructions from the deployment. Composed after the fixed safety rules by
|
|
63
|
+
* `reviewSystemPrompt` (design §4.7); it can never replace them. */
|
|
64
|
+
instructions?: string;
|
|
65
|
+
autoReview: 'open+ready' | 'off';
|
|
66
|
+
};
|
|
67
|
+
type RepoConfig = {
|
|
68
|
+
instructions?: string;
|
|
69
|
+
postInlineAtOrAbove?: number;
|
|
70
|
+
mode?: ReportMode;
|
|
71
|
+
skills?: string[];
|
|
72
|
+
};
|
|
73
|
+
type ReviewRequest = {
|
|
74
|
+
repo: string;
|
|
75
|
+
pr: number;
|
|
76
|
+
headSha: string;
|
|
77
|
+
tier?: Tier;
|
|
78
|
+
multi?: boolean;
|
|
79
|
+
model?: string;
|
|
80
|
+
effort?: Effort;
|
|
81
|
+
check?: boolean;
|
|
82
|
+
brief?: string;
|
|
83
|
+
budgetUsd?: number;
|
|
84
|
+
requestedBy?: string;
|
|
85
|
+
requestId?: string;
|
|
86
|
+
};
|
|
87
|
+
type ResolvedSettings = {
|
|
88
|
+
tier: Tier;
|
|
89
|
+
model: string;
|
|
90
|
+
effort: Effort;
|
|
91
|
+
check: boolean;
|
|
92
|
+
multi: boolean;
|
|
93
|
+
budget: BudgetPolicy;
|
|
94
|
+
report: DeploymentConfig['report'];
|
|
95
|
+
severity: DeploymentConfig['severity'];
|
|
96
|
+
skills: SkillSource[];
|
|
97
|
+
deploymentInstructions: string | null;
|
|
98
|
+
instructions: string | null;
|
|
99
|
+
brief: string | null;
|
|
100
|
+
droppedRequestKeys: string[];
|
|
101
|
+
};
|
|
102
|
+
/** The built-in defaults: design §3.1's table, and §3's tier presets.
|
|
103
|
+
* `thorough`'s numbers are provisional — design §3 leaves its budget "set when built" and the
|
|
104
|
+
* measured three-reviewer runs cost $2.84 and $5.91 (§8), so $8 is a target with headroom, and
|
|
105
|
+
* `agents: 3` is the three lenses that were actually measured: intent, impact, security.
|
|
106
|
+
* `maxFindings` is not in the design text; it is the cap the findings schema puts on the model,
|
|
107
|
+
* 50 being well above the 5 findings the most productive measured review returned, so it is a
|
|
108
|
+
* runaway guard and not a quality lever.
|
|
109
|
+
* `firstReviewLowBandCap` is not in the design text either; it is defined here as: the most
|
|
110
|
+
* findings below `severity.bands.medium` that the FIRST review of a pull request MENTIONS AT ALL —
|
|
111
|
+
* inline or in the summary. Later reviews mention none of them unless `report.repeatNits` is true.
|
|
112
|
+
* It bounds what a human has to read, not only where it appears: low-band findings are already kept
|
|
113
|
+
* out of inline comments by `postInlineAtOrAbove`, so a cap on inline alone would cap nothing.
|
|
114
|
+
* (Corrected 2026-09-13: this comment used to say "may post inline", which is not what report.ts
|
|
115
|
+
* does and would have invited someone to change the code to match it.)
|
|
116
|
+
* `packages/github/src/report.ts` (Task 10b) implements those two sentences and no other reading
|
|
117
|
+
* of them. */
|
|
118
|
+
declare const defaultDeploymentConfig: () => DeploymentConfig;
|
|
119
|
+
/** The string a repo writes in `.review-agent/review.md` to select a source the deployment already
|
|
120
|
+
* allows, and the key Task 5b caches a materialised source under. `SkillSource` carries no name,
|
|
121
|
+
* so the id is derived from what identifies it: a directory is its path; a git source is repo,
|
|
122
|
+
* ref and sub-path. */
|
|
123
|
+
declare const skillSourceId: (s: SkillSource) => string;
|
|
124
|
+
declare const resolveSettings: (a: {
|
|
125
|
+
deployment: DeploymentConfig;
|
|
126
|
+
repo: RepoConfig | null;
|
|
127
|
+
request: ReviewRequest;
|
|
128
|
+
}) => ResolvedSettings;
|
|
129
|
+
|
|
130
|
+
type BudgetPolicy = {
|
|
131
|
+
targetUsd: number;
|
|
132
|
+
wrapUpAtUsd: number;
|
|
133
|
+
ceilingUsd: number;
|
|
134
|
+
};
|
|
135
|
+
/** Money, to whole cents. Exported because `resolveSettings` compares a requested budget
|
|
136
|
+
* against the resolved one and must round it the same way. */
|
|
137
|
+
declare const roundUsd: (n: number) => number;
|
|
138
|
+
declare const budgetFor: (tier: TierSettings, requestBudgetUsd?: number) => BudgetPolicy;
|
|
139
|
+
|
|
140
|
+
type Severity = number;
|
|
141
|
+
type Category = 'intent' | 'correctness' | 'impact' | 'security';
|
|
142
|
+
type Finding = {
|
|
143
|
+
file: string;
|
|
144
|
+
line: number;
|
|
145
|
+
endLine: number | null;
|
|
146
|
+
severity: Severity;
|
|
147
|
+
category: Category;
|
|
148
|
+
title: string;
|
|
149
|
+
explanation: string;
|
|
150
|
+
evidence: string[];
|
|
151
|
+
suggestion: string | null;
|
|
152
|
+
};
|
|
153
|
+
type Inconclusive = {
|
|
154
|
+
question: string;
|
|
155
|
+
whatWouldSettleIt: string;
|
|
156
|
+
};
|
|
157
|
+
type IntentVerdict = 'matches' | 'partial' | 'diverges' | 'unclear';
|
|
158
|
+
type ReviewOutput = {
|
|
159
|
+
summary: string;
|
|
160
|
+
intent: {
|
|
161
|
+
verdict: IntentVerdict;
|
|
162
|
+
note: string;
|
|
163
|
+
};
|
|
164
|
+
findings: Finding[];
|
|
165
|
+
inconclusive: Inconclusive[];
|
|
166
|
+
};
|
|
167
|
+
declare class ParseError extends Error {
|
|
168
|
+
readonly raw: unknown;
|
|
169
|
+
constructor(message: string, raw: unknown);
|
|
170
|
+
}
|
|
171
|
+
declare const parseReviewOutput: (raw: unknown) => ReviewOutput;
|
|
172
|
+
/** The schema handed to `claude -p --json-schema`. It is the schema that was measured on
|
|
173
|
+
* 2026-09-12 (spike/review-schema.json), unchanged, plus an optional cap on the findings array.
|
|
174
|
+
* Deliberately no `additionalProperties: false` anywhere: the measured schema had none and
|
|
175
|
+
* produced valid output on every successful run, and the one schema failure in the set came from
|
|
176
|
+
* a schema that was too strict, not too loose. Unknown keys are dropped by `parseReviewOutput`
|
|
177
|
+
* instead, where dropping them costs nothing. */
|
|
178
|
+
declare const reviewJsonSchema: (opts?: {
|
|
179
|
+
maxFindings?: number;
|
|
180
|
+
}) => object;
|
|
181
|
+
|
|
182
|
+
type EngineInput = {
|
|
183
|
+
checkoutDir: string;
|
|
184
|
+
prompt: string;
|
|
185
|
+
systemPrompt: string;
|
|
186
|
+
settings: ResolvedSettings;
|
|
187
|
+
schema: object;
|
|
188
|
+
/** Resolved, real paths. Task 5b's `materialiseSkills` produces them; nothing here fetches. */
|
|
189
|
+
skillDirs: string[];
|
|
190
|
+
signal?: AbortSignal;
|
|
191
|
+
};
|
|
192
|
+
type Usage = {
|
|
193
|
+
costUsd: number;
|
|
194
|
+
inputTokens: number;
|
|
195
|
+
outputTokens: number;
|
|
196
|
+
cacheReadTokens: number;
|
|
197
|
+
cacheWriteTokens: number;
|
|
198
|
+
turns: number;
|
|
199
|
+
durationMs: number;
|
|
200
|
+
};
|
|
201
|
+
type EngineFailure = {
|
|
202
|
+
kind: 'budget';
|
|
203
|
+
spentUsd: number;
|
|
204
|
+
} | {
|
|
205
|
+
kind: 'schema';
|
|
206
|
+
} | {
|
|
207
|
+
kind: 'refusal';
|
|
208
|
+
} | {
|
|
209
|
+
kind: 'crashed';
|
|
210
|
+
code: number | null;
|
|
211
|
+
stderr: string;
|
|
212
|
+
}
|
|
213
|
+
/** The CLI ran and reported an error before the model produced anything: no login, an API error.
|
|
214
|
+
* Distinct from `refusal`, which means the model answered and declined. `message` is the CLI's own
|
|
215
|
+
* text (e.g. "Not logged in · Please run /login"), shown to the user because they can act on it. */
|
|
216
|
+
| {
|
|
217
|
+
kind: 'cli-error';
|
|
218
|
+
terminalReason: string;
|
|
219
|
+
message: string;
|
|
220
|
+
};
|
|
221
|
+
type EngineResult = {
|
|
222
|
+
output: ReviewOutput | null;
|
|
223
|
+
usage: Usage;
|
|
224
|
+
cutShort: boolean;
|
|
225
|
+
wrapUpFired: boolean;
|
|
226
|
+
failure: EngineFailure | null;
|
|
227
|
+
};
|
|
228
|
+
declare const buildArgv: (i: EngineInput) => string[];
|
|
229
|
+
declare const runEngine: (i: EngineInput) => Promise<EngineResult>;
|
|
230
|
+
|
|
231
|
+
type CheckVerdict = {
|
|
232
|
+
index: number;
|
|
233
|
+
verdict: 'confirmed' | 'refuted' | 'uncertain';
|
|
234
|
+
severity: Severity;
|
|
235
|
+
reason: string;
|
|
236
|
+
evidence: string[];
|
|
237
|
+
};
|
|
238
|
+
declare const runCheckPass: (a: {
|
|
239
|
+
findings: Finding[];
|
|
240
|
+
input: EngineInput;
|
|
241
|
+
}) => Promise<{
|
|
242
|
+
verdicts: CheckVerdict[];
|
|
243
|
+
usage: Usage;
|
|
244
|
+
}>;
|
|
245
|
+
|
|
246
|
+
/** Criss, 2026-09-14 (decision 10): the reviewer refuses to run when ANTHROPIC_BASE_URL is set.
|
|
247
|
+
* Not forwarding it (the allow-list above) is silent — an operator who pointed the CLI at a gateway
|
|
248
|
+
* would get a review from Anthropic and believe it came from somewhere else. One sentence, one
|
|
249
|
+
* place: spawnClaude uses it, `review-agent review` uses it before any GitHub call, and the
|
|
250
|
+
* trigger.dev task (plan 2, Task 13) imports it. Names the variable, never its value. */
|
|
251
|
+
declare const gatewayBaseUrlRefusal: (env: Record<string, string | undefined>) => string | null;
|
|
252
|
+
|
|
253
|
+
/** The version recorded on every review (design §4.7). Bump it in the same commit as any change to
|
|
254
|
+
* the text in this file: `prompt.test.ts` holds a digest of the shipped text and fails until the
|
|
255
|
+
* two move together, so a recorded version always names the exact words that produced a review.
|
|
256
|
+
*
|
|
257
|
+
* 1.0.0 — the measured instructions of 2026-09-12 (scratchpad/spike/reviewer-system.md and
|
|
258
|
+
* verifier-system.md), which produced the costs and findings of design §8. One deviation from the
|
|
259
|
+
* recorded text: the name of the deployment it was written for became "the pull request reviewer",
|
|
260
|
+
* because that is one deployment of three shapes (§1) and its name was never a measured variable. The
|
|
261
|
+
* severity sentence is generated from the configured bands (§3.1) and renders the measured
|
|
262
|
+
* sentence character-for-character at the default bands. */
|
|
263
|
+
declare const REVIEW_INSTRUCTIONS_VERSION = "1.0.0";
|
|
264
|
+
declare const REVIEW_LENSES: readonly ["intent", "impact", "security"];
|
|
265
|
+
type Lens = (typeof REVIEW_LENSES)[number];
|
|
266
|
+
declare const reviewSystemPrompt: (a: {
|
|
267
|
+
settings: ResolvedSettings;
|
|
268
|
+
lens?: string;
|
|
269
|
+
}) => string;
|
|
270
|
+
/** The verification pass (design §4.6), as measured. It takes no settings: it returns a number on
|
|
271
|
+
* the 1-10 scale, and the deployment's band *names* are a reporting concern applied later by
|
|
272
|
+
* `packages/github/src/report.ts`. The bands quoted here are the defaults, as description of the
|
|
273
|
+
* scale — moving them does not change what a 7 means to this pass. */
|
|
274
|
+
declare const checkPassSystemPrompt: () => string;
|
|
275
|
+
/** What the prompt needs from a pull request. `github`'s `PullRequestContext` (Task 9) has all of
|
|
276
|
+
* these and is assignable as-is, which is how `core` stays free of a dependency on `github`. */
|
|
277
|
+
type PromptPullRequest = {
|
|
278
|
+
owner: string;
|
|
279
|
+
repo: string;
|
|
280
|
+
number: number;
|
|
281
|
+
headSha: string;
|
|
282
|
+
baseSha: string;
|
|
283
|
+
title: string;
|
|
284
|
+
body: string;
|
|
285
|
+
diff: string;
|
|
286
|
+
};
|
|
287
|
+
/** The user message, as measured (scratchpad/spike/input-pr16.md). Everything here is written to the
|
|
288
|
+
* child process's stdin by `spawnClaude`; nothing in it ever reaches argv, a shell or a path, and
|
|
289
|
+
* the only identifier interpolated from outside — the commit sha — is pattern-checked first. */
|
|
290
|
+
declare const buildPrompt: (a: {
|
|
291
|
+
pr: PromptPullRequest;
|
|
292
|
+
brief: string | null;
|
|
293
|
+
}) => string;
|
|
294
|
+
/** Sixteen hex characters of sha256 over the shipped text. Recorded next to the version so two
|
|
295
|
+
* reviews claiming the same version can be shown to have run the same words. */
|
|
296
|
+
declare const REVIEW_INSTRUCTIONS_DIGEST: string;
|
|
297
|
+
|
|
298
|
+
type MaterialisedSkill = {
|
|
299
|
+
id: string;
|
|
300
|
+
path: string;
|
|
301
|
+
};
|
|
302
|
+
declare class SkillError extends Error {
|
|
303
|
+
readonly id: string;
|
|
304
|
+
constructor(id: string, message: string);
|
|
305
|
+
}
|
|
306
|
+
type SkillFetch = (a: {
|
|
307
|
+
repo: string;
|
|
308
|
+
ref: string;
|
|
309
|
+
}) => Promise<NodeJS.ReadableStream>;
|
|
310
|
+
declare const materialiseSkills: (sources: SkillSource[], cacheDir: string, deps?: {
|
|
311
|
+
fetch?: SkillFetch;
|
|
312
|
+
}) => Promise<MaterialisedSkill[]>;
|
|
313
|
+
|
|
314
|
+
declare const RECORD_VERSION: 1;
|
|
315
|
+
/** The version of this engine, on every record it writes. Kept in step with
|
|
316
|
+
* `packages/core/package.json` by `record.test.ts` — a record whose engine version is a guess is
|
|
317
|
+
* worth less than no record at all (design §4.7). */
|
|
318
|
+
declare const ENGINE_VERSION = "0.1.0";
|
|
319
|
+
type RecordedSkill = {
|
|
320
|
+
id: string;
|
|
321
|
+
path: string;
|
|
322
|
+
};
|
|
323
|
+
type ReviewRecord = {
|
|
324
|
+
recordVersion: 1;
|
|
325
|
+
engineVersion: string;
|
|
326
|
+
instructions: {
|
|
327
|
+
version: string;
|
|
328
|
+
digest: string;
|
|
329
|
+
};
|
|
330
|
+
request: {
|
|
331
|
+
repo: string;
|
|
332
|
+
pr: number;
|
|
333
|
+
headSha: string;
|
|
334
|
+
requestedBy: string | null;
|
|
335
|
+
requestId: string | null;
|
|
336
|
+
droppedRequestKeys: string[];
|
|
337
|
+
};
|
|
338
|
+
settings: {
|
|
339
|
+
tier: Tier;
|
|
340
|
+
model: string;
|
|
341
|
+
effort: Effort;
|
|
342
|
+
check: boolean;
|
|
343
|
+
multi: boolean;
|
|
344
|
+
budget: BudgetPolicy;
|
|
345
|
+
report: DeploymentConfig['report'];
|
|
346
|
+
severity: DeploymentConfig['severity'];
|
|
347
|
+
};
|
|
348
|
+
skills: RecordedSkill[];
|
|
349
|
+
usage: Usage;
|
|
350
|
+
checkUsage: Usage | null;
|
|
351
|
+
costUsd: number;
|
|
352
|
+
wrapUpFired: boolean;
|
|
353
|
+
cutShort: boolean;
|
|
354
|
+
failure: EngineFailure | null;
|
|
355
|
+
output: ReviewOutput | null;
|
|
356
|
+
checkVerdicts: CheckVerdict[] | null;
|
|
357
|
+
/** Credential files deleted from the working copy before the model started (github/archive.ts).
|
|
358
|
+
* Always present: a review whose inputs had files taken out of them must say which. */
|
|
359
|
+
checkout: {
|
|
360
|
+
removedCredentialFiles: string[];
|
|
361
|
+
};
|
|
362
|
+
timings: {
|
|
363
|
+
startedAt: string;
|
|
364
|
+
finishedAt: string;
|
|
365
|
+
durationMs: number;
|
|
366
|
+
};
|
|
367
|
+
};
|
|
368
|
+
declare const buildReviewRecord: (a: {
|
|
369
|
+
request: ReviewRequest;
|
|
370
|
+
settings: ResolvedSettings;
|
|
371
|
+
result: EngineResult;
|
|
372
|
+
skills: MaterialisedSkill[];
|
|
373
|
+
check: {
|
|
374
|
+
verdicts: CheckVerdict[];
|
|
375
|
+
usage: Usage;
|
|
376
|
+
} | null;
|
|
377
|
+
removedFromCheckout: string[];
|
|
378
|
+
startedAt: Date;
|
|
379
|
+
finishedAt: Date;
|
|
380
|
+
}) => ReviewRecord;
|
|
381
|
+
|
|
382
|
+
type SecretHit = {
|
|
383
|
+
pattern: string;
|
|
384
|
+
where: string;
|
|
385
|
+
};
|
|
386
|
+
declare const scanForSecrets: (text: string) => SecretHit[];
|
|
387
|
+
declare class SecretLeak extends Error {
|
|
388
|
+
readonly hits: SecretHit[];
|
|
389
|
+
constructor(hits: SecretHit[]);
|
|
390
|
+
}
|
|
391
|
+
declare const assertNoSecrets: (o: ReviewOutput) => void;
|
|
392
|
+
|
|
393
|
+
export { type BudgetPolicy, type Category, type CheckVerdict, type DeploymentConfig, ENGINE_VERSION, type Effort, type EngineFailure, type EngineInput, type EngineResult, type Finding, type Inconclusive, type IntentVerdict, type Lens, type MaterialisedSkill, ParseError, type PromptPullRequest, RECORD_VERSION, REVIEW_INSTRUCTIONS_DIGEST, REVIEW_INSTRUCTIONS_VERSION, REVIEW_LENSES, type RecordedSkill, type RepoConfig, type ReportMode, type ResolvedSettings, type ReviewOutput, type ReviewRecord, type ReviewRequest, type SecretHit, SecretLeak, type Severity, type SeverityBands, SkillError, type SkillFetch, type SkillSource, type Tier, type TierSettings, type Usage, assertNoSecrets, budgetFor, buildArgv, buildPrompt, buildReviewRecord, checkPassSystemPrompt, defaultDeploymentConfig, gatewayBaseUrlRefusal, materialiseSkills, parseReviewOutput, resolveSettings, reviewJsonSchema, reviewSystemPrompt, roundUsd, runCheckPass, runEngine, scanForSecrets, skillSourceId };
|