@orkestrel/scaffold 0.0.126 → 0.0.128
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/dist/bin/main.js +5 -2
- package/dist/bin/main.js.map +1 -1
- package/dist/host/AGENTS.md +1 -1
- package/dist/host/agents/orchestration.md +3 -3
- package/dist/host/claude/AGENTS.md +2 -2
- package/dist/host/claude/agents/orkestrel.md +14 -14
- package/dist/host/claude/agents/planner.md +2 -2
- package/dist/host/claude/rules/workspace.md +7 -6
- package/dist/host/codex/agents/planner.toml +2 -2
- package/dist/host/guides/capture.md +123 -123
- package/dist/host/guides/database.md +18 -7
- package/dist/host/guides/relation.md +71 -31
- package/dist/host/guides/scaffold.md +67 -49
- package/dist/host/guides/toolbox.md +8 -1
- package/dist/host/manifest.json +14 -14
- package/dist/host/tests/config.test.ts +95 -44
- package/dist/src/core/index.cjs +128 -75
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +27 -6
- package/dist/src/core/index.d.ts +27 -6
- package/dist/src/core/index.js +128 -76
- package/dist/src/core/index.js.map +1 -1
- package/package.json +2 -2
|
@@ -36,7 +36,7 @@ Protocol shapes from [`types.ts`](../src/core/types.ts).
|
|
|
36
36
|
| `CaptureErrorOptions` | interface | `{ code, context?, cause? }` | Configures one capture failure's condition, optional context, and optional cause. |
|
|
37
37
|
| `CaptureSelection` | interface | `{ selector, case?, state? }` | Carries the selection fields a request and a parking check read. |
|
|
38
38
|
| `CaptureIdentity` | interface | `{ id, stage, pid, config }` | Identifies one runner invocation's producing stage and configuration. |
|
|
39
|
-
| `CaptureRequest` | interface | `{ version, command, variants, args }`
|
|
39
|
+
| `CaptureRequest` | interface | `{ version, command, mode?, variants, args }` | Carries a runner request through Vitest's provided-context protocol. |
|
|
40
40
|
| `CaptureSources` | interface | `{ own, shared, tests }` | Attributes product ownership and behavioral inputs separately. |
|
|
41
41
|
| `CaptureDigest` | interface | `{ patterns, files, digest }` | Records declared patterns, expanded file hashes, and their combined digest. |
|
|
42
42
|
| `CaptureDestination` | interface | `{ portfolio, state, scope, part, section?, variant, project, file, case, sources }` | Identifies one required output pair and its declaring case. |
|
|
@@ -148,126 +148,126 @@ Pure leaves from [`helpers.ts`](../src/core/helpers.ts). A helper that refuses a
|
|
|
148
148
|
|
|
149
149
|
Engine, runner, preflight, and contact-sheet contracts from [`types.ts`](../src/server/types.ts).
|
|
150
150
|
|
|
151
|
-
| Name | Kind | Signature | Summary
|
|
152
|
-
| -------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
153
|
-
| `CaptureCommand` | type | `CaptureRequest['command'] \| 'stale'` | Names one command the runner executes: a journey, a frame capture, or a stale reading.
|
|
154
|
-
| `CapturePortfolioRoot` | interface | `{ portfolio, directory, scoped }` | Supplies a host-authorized physical portfolio root without repeating its states or variants.
|
|
155
|
-
| `CaptureHashHandler` | type | `(bytes: Uint8Array) => string` | Digests the exact bytes of one file reading and returns the lowercase hexadecimal digest.
|
|
156
|
-
| `CaptureIntegrityOptions` | interface | `{ inputs, root, directory, manifest, registry, lookups, portfolios, hash? }` | Configures the engine's workspace and separate evidence documents.
|
|
157
|
-
| `CaptureStageProject` | interface | `{ name, variant, record, inputs }` | Supplies one selected project's expected final record and bounded input population.
|
|
158
|
-
| `CaptureParsedArguments` | type | `{ readonly [Key in keyof ReturnType<typeof parseArgs<{ readonly options: Options; readonly tokens: true; readonly strict: true; readonly allowPositionals: true; }>>]: Readonly<ReturnType<typeof parseArgs<{ readonly options: Options; readonly tokens: true; readonly strict: true; readonly allowPositionals: true; }>>[Key]>; }` | Carries the typed values and tokens of a strictly parsed capture command line.
|
|
159
|
-
| `CaptureExecutionResult` | interface | `{ code, signal, pid?, expired? }` | Carries the supervised child outcome without treating a signal as a successful exit.
|
|
160
|
-
| `CaptureExecutionHandler` | type | `() => Promise<CaptureExecutionResult>` | Executes the runner's child after the engine captures its input snapshot.
|
|
161
|
-
| `CaptureStageOptions` | interface | `{ request, projects, report, execute, signal? }` | Binds a stage transaction to its exact request, projects, reporter, and process boundary.
|
|
162
|
-
| `CaptureFileSnapshot` | interface | `{ file, image, changed }` | Records one physical file's bytes and native modification readings at a stage boundary.
|
|
163
|
-
| `CaptureProjectSnapshot` | interface | `{ project, inputs }` | Preserves one project's declared patterns and sorted expansion before execution.
|
|
164
|
-
| `CaptureSnapshot` | interface | `{ time, projects, files }` | Holds a stage boundary's input populations and existing output identities.
|
|
165
|
-
| `CaptureProjectResult` | interface | `{ project, variant, record, declarations, passed }` | Reports validated project evidence, retaining empty successful selections explicitly.
|
|
166
|
-
| `CaptureStageResult` | interface | `{ request, projects, entries, lookups, duration }` | Reports the successful stage's committed stamps and validated lookup evidence.
|
|
167
|
-
| `CaptureReadOptions` | interface | `{ variants?, portfolio? }` | Selects a declaration population without requiring current images or passing state lookups.
|
|
168
|
-
| `CaptureStaleOptions` | interface | `{ declared? }` | Selects a freshness population and names the producing variants the host wrapper declares.
|
|
169
|
-
| `CaptureCheckOptions` | interface | `{ variants, portfolio? }` | Selects required output pairs and attributable extras for a freshness reading.
|
|
170
|
-
| `CaptureReadResult` | interface | `{ registry, entries }` | Returns the exact current declaration destinations and their complete-anchor identity.
|
|
171
|
-
| `CaptureCheckResult` | interface | `{ required, entries, warnings, duration }` | Reports the exact judged population, every mismatch reason, and conservative test warnings.
|
|
172
|
-
| `CaptureLookupOptions` | interface | `{ state, variants, portfolio? }` | Requests a state-to-case resolution before the runner starts any selected project.
|
|
173
|
-
| `CaptureLookupResult` | interface | `{ case, entries, lookups }` | Resolves one declaring case and its actual output pairs with their passing evidence.
|
|
174
|
-
| `CaptureRunEvidence` | interface | `{ file, run }` | Binds a decoded run record to the physical file whose digest authenticated it.
|
|
175
|
-
| `CaptureDirectoryResult` | interface | `{ directory, ancestors }` | Carries one physical-directory ancestry while enumerating logical portfolio paths.
|
|
176
|
-
| `CaptureEvidence` | interface | `{ registry, collections, manifest?, lookups, runs }` | Carries accepted registry anchors and separately persisted passing run evidence.
|
|
177
|
-
| `CaptureCollectionEvidence` | interface | `{ receipt }` | Carries the authenticated external record beside its collection receipt.
|
|
178
|
-
| `CaptureReceiptInput` | interface | `{ receipt, report, outcome, capped }` | Supplies a verifier's actual process outcome and exact reporter bytes for registry import.
|
|
179
|
-
| `CaptureIntegrityInterface` | interface | `{ changed(), read(), stamp(), check(), lookup() }` | Defines the shared stage transaction, freshness reading, and state resolution engine.
|
|
180
|
-
| `CaptureProject` | interface | `{ name, variant, tags, variants, directory, record, inputs, final, first, uniform?, portfolios, standalone }` | Preserves the wrapper's host declarations, including optional uniform scopes, for consumers.
|
|
181
|
-
| `CaptureRunnerOptions` | interface | `{ command, root, config, requests, argv, stdout?, stderr?, integrity?, deadline? }` | Configures one runner invocation: its command, its workspace, and the command line it reads.
|
|
182
|
-
| `CaptureRunnerArguments` | interface | `{ selector?, changed?, plan?, config, variants, case?, state?, portfolio? }`
|
|
183
|
-
| `CaptureRunnerInterface` | interface | `{ execute() }` | Drives selected owners through one journey stage or staged frame captures.
|
|
184
|
-
| `CaptureChange` | interface | `{ path, classification, owners }` | Classifies one changed Git path against accepted source attribution.
|
|
185
|
-
| `CaptureChangePlan` | interface | `{ changes, owners }` | Holds changed paths and the stable owner selection reduced by ancestry.
|
|
186
|
-
| `CaptureOwnerOutcome` | interface | `{ owner, code, ran }` | Records one changed owner's exit and whether an execution child started.
|
|
187
|
-
| `CaptureWriteHandler` | type | `(text: string) => unknown` | Writes one chunk of runner output to the stream the host chooses.
|
|
188
|
-
| `CaptureCLIOptions` | interface | `{ root?, stdout?, stderr? }` | Configures the executable's workspace and its report and diagnostic writers.
|
|
189
|
-
| `CaptureCLIInterface` | interface | `{ execute() }` | Runs capture command lines through injected output writers.
|
|
190
|
-
| `CaptureIntegrityHandler` | type | `(options: CaptureIntegrityOptions) => CaptureIntegrityInterface` | Creates the integrity engine the runner reads and stamps through, from the options it derives.
|
|
191
|
-
| `CaptureStagePlan` | interface | `{ name, variants }` | Names one planned stage and the variants it runs in one Vitest process.
|
|
192
|
-
| `CaptureArgumentsOptions` | interface | `{ entry, config, report, projects, filter, case?, final, mode?, titles? }` | Configures the Vitest argument list one stage spawns with.
|
|
193
|
-
| `CaptureRequestOptions` | interface | `{ ppid, argv, directory?, config, owners, variants }` | Configures how a wrapper reads the runner's request for its own Vitest process.
|
|
194
|
-
| `CaptureOutcome` | interface | `{ project, variant, count }` | Carries one project's owner-bearing passed work count from a finished stage.
|
|
195
|
-
| `CaptureRunPlan` | interface | `{ command, projects, selector, filter, case?, state?, final, directory, config }`
|
|
196
|
-
| `CaptureInvocationOptions` | interface | `{ command, root, requests, stdout, stderr, terminate?, ownership? }` | Configures one runner invocation's identity, workspace, and output.
|
|
197
|
-
| `CaptureChildTerminationHandler` | type | `(child: DuplexInterface) => Promise<boolean>` | Terminates one supervised child and reports whether its exit was confirmed.
|
|
198
|
-
| `CaptureInvocationInterface` | interface | `{ id, request, directory, signal, interrupted, attach(), release(), prepare(), holders(), publish(), retract(), launched(), spawn() }` | Owns one runner invocation's identity, request file, children, and interruption.
|
|
199
|
-
| `CaptureDiscoveryRequest` | interface | `{ version, phase, id, nonce, config, pid, args }`
|
|
200
|
-
| `CaptureHostEntry` | interface | `{ project, viewport? }` | Describes one wrapper project to the runner: its host declarations and, when it has one, its viewport.
|
|
201
|
-
| `CaptureHostDescription` | interface | `{ version, id, nonce, config, parent, pid, projects }` | Carries the description a wrapper writes back to the runner that discovered it.
|
|
202
|
-
| `CaptureDescriptionExpectation` | interface | `{ id, nonce, config, parent, pid }` | Names what a description must echo for the runner to accept it.
|
|
203
|
-
| `CaptureDiscoveryOptions` | interface | `{ ppid, argv, directory?, config, projects }` | Configures how a wrapper answers the runner's discovery request.
|
|
204
|
-
| `CaptureDiscoveryRunOptions` | interface | `{ root, config, invocation, mode?, deadline? }` | Configures one discovery: the workspace, the wrapper, the invocation that owns the child, and its bounds.
|
|
205
|
-
| `CaptureDiscoveryInterface` | interface | `{ describe() }` | Reads a consumer's wrapper by running its installed Vitest in discovery mode.
|
|
206
|
-
| `CapturePicture` | interface | `{ width, height, pixels }` | Carries a decoded RGB image for the image checks and the contact sheets.
|
|
207
|
-
| `CaptureReaderOptions` | interface | `{ root, config, selection, journeys, checks?, requests?, deadline?, stdout?, stderr? }`
|
|
208
|
-
| `CaptureProducer` | interface | `{ project }` | Declares the viewport one wrapper project produces beside the project's own name.
|
|
209
|
-
| `CaptureReaderDefaults` | interface | `{ config, journeys, requests? }` | Supplies the wrapper path, the journey artifact directory, and the request directory a reader command line falls back to.
|
|
210
|
-
| `CaptureReaderSelection` | interface | `{ integrity, population, variants, directory, uniform? }` | Returns a reader's authenticated selection, uniform scopes, and engine for pixel classification.
|
|
211
|
-
| `CaptureArtifactResult` | interface | `{ record, run, file, text }` | Carries a judged run record and the verified text of the journey artifact it names.
|
|
212
|
-
| `CaptureJudgedRecord` | interface | `{ record, case }` | Names the run record a judged frame's stamp points at and the case that stamped it.
|
|
213
|
-
| `CaptureJudgedFrame` | interface | `{ entry, artifact, issues }` | Pairs a judged frame with its verified artifact, when one was read, and its coverage issues.
|
|
214
|
-
| `CaptureDecodedImage` | interface | `{ entry, picture, digest, size }` | Records one selected image's real bytes, geometry, and canonical destination.
|
|
215
|
-
| `CaptureImageResult` | interface | `{ picture, thumbnail }` | Retains source geometry and a bounded sheet thumbnail after a full frame has been judged.
|
|
216
|
-
| `CaptureOwnership` | interface | `{ pid, id }` | Identifies the process and invocation that own a request directory.
|
|
217
|
-
| `CaptureOwnershipHost` | interface | `{ platform, read, write, link, remove, alive }` | Supplies the filesystem and liveness boundary for ownership arbitration.
|
|
218
|
-
| `CapturePngLimits` | interface | `{ pixels, side, bytes }` | Bounds a PNG's decoded pixels, side length, and encoded bytes.
|
|
219
|
-
| `CaptureCheckFrame` | interface | `{ entry, picture, artifact }` | Carries one judged frame to a host check: its destination, its decoded pixels, and its artifact.
|
|
220
|
-
| `CaptureCheckHandler` | type | `(frame: CaptureCheckFrame) => readonly string[]` | Reads one judged frame against a host rule and returns the issues it finds, none when it passes.
|
|
221
|
-
| `CapturePreflightResult` | interface | `{ mixed, variants, directory, selection, freshness, images, issues }` | Reports selected image checks without upgrading their engine freshness classifications.
|
|
222
|
-
| `CapturePreflightInterface` | interface | `{ read(), check(), execute() }` | Reads the selected population's frames and reports their freshness, mixed observations, and coverage.
|
|
223
|
-
| `CaptureSheetOptions` | interface | `{ reader, output }` | Carries a contact-sheet output request separately from the population selection.
|
|
224
|
-
| `CaptureSheetCell` | interface | `{ entry, picture, source, factor, clipped, freshness }` | Holds one contact-sheet cell: a frame's destination, its shrunk picture, and what the sheet reports about it.
|
|
225
|
-
| `CaptureSheetGroup` | interface | `{ identity, cells, picture }` | Holds the cells of one portfolio, owner, and state side by side as one composite picture.
|
|
226
|
-
| `CaptureSheetRow` | interface | `{ groups, picture }` | Holds a pair of groups side by side as one composite picture.
|
|
227
|
-
| `CaptureSheetPage` | interface | `{ file, rows, picture }` | Holds one written sheet: its file name, the rows it stacks, and the composite picture.
|
|
228
|
-
| `CaptureReaderCommand` | interface | `{ reader, output? }` | Carries parsed reader arguments and an optional contact-sheet output directory.
|
|
229
|
-
| `CaptureSheetsInterface` | interface | `{ execute() }` | Composes exactly the authenticated sparse state and output pairs for iteration review.
|
|
230
|
-
| `CaptureRegistryArguments` | interface | `{ config, variants, mode? }` | Carries the parsed registry command line: the wrapper, the variants to refresh, and the mode.
|
|
231
|
-
| `CaptureRegistrarOptions` | interface | `{ root, config, requests, argv, stdout?, stderr?, deadline? }` | Configures one registry refresh: its workspace, wrapper default, request directory, and command line.
|
|
232
|
-
| `CaptureRegistrarInterface` | interface | `{ execute() }` | Refreshes the accepted registry from one complete capture-free journey per producing variant.
|
|
233
|
-
| `CaptureInputHandler` | type | `(file: string) => string \| undefined` | Reads a contained input through an owning operation's file snapshot memo.
|
|
234
|
-
| `CaptureRetractionHandler` | type | `() => void` | Removes one invocation's published request during shutdown.
|
|
235
|
-
| `CaptureTerminationHandler` | type | `() => Promise<boolean>` | Begins one independent child termination only after request removal has been attempted.
|
|
151
|
+
| Name | Kind | Signature | Summary |
|
|
152
|
+
| -------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
153
|
+
| `CaptureCommand` | type | `CaptureRequest['command'] \| 'stale'` | Names one command the runner executes: a journey, a frame capture, or a stale reading. |
|
|
154
|
+
| `CapturePortfolioRoot` | interface | `{ portfolio, directory, scoped }` | Supplies a host-authorized physical portfolio root without repeating its states or variants. |
|
|
155
|
+
| `CaptureHashHandler` | type | `(bytes: Uint8Array) => string` | Digests the exact bytes of one file reading and returns the lowercase hexadecimal digest. |
|
|
156
|
+
| `CaptureIntegrityOptions` | interface | `{ inputs, root, directory, manifest, registry, lookups, portfolios, hash? }` | Configures the engine's workspace and separate evidence documents. |
|
|
157
|
+
| `CaptureStageProject` | interface | `{ name, variant, record, inputs }` | Supplies one selected project's expected final record and bounded input population. |
|
|
158
|
+
| `CaptureParsedArguments` | type | `{ readonly [Key in keyof ReturnType<typeof parseArgs<{ readonly options: Options; readonly tokens: true; readonly strict: true; readonly allowPositionals: true; }>>]: Readonly<ReturnType<typeof parseArgs<{ readonly options: Options; readonly tokens: true; readonly strict: true; readonly allowPositionals: true; }>>[Key]>; }` | Carries the typed values and tokens of a strictly parsed capture command line. |
|
|
159
|
+
| `CaptureExecutionResult` | interface | `{ code, signal, pid?, expired? }` | Carries the supervised child outcome without treating a signal as a successful exit. |
|
|
160
|
+
| `CaptureExecutionHandler` | type | `() => Promise<CaptureExecutionResult>` | Executes the runner's child after the engine captures its input snapshot. |
|
|
161
|
+
| `CaptureStageOptions` | interface | `{ request, projects, report, execute, signal? }` | Binds a stage transaction to its exact request, projects, reporter, and process boundary. |
|
|
162
|
+
| `CaptureFileSnapshot` | interface | `{ file, image, changed }` | Records one physical file's bytes and native modification readings at a stage boundary. |
|
|
163
|
+
| `CaptureProjectSnapshot` | interface | `{ project, inputs }` | Preserves one project's declared patterns and sorted expansion before execution. |
|
|
164
|
+
| `CaptureSnapshot` | interface | `{ time, projects, files }` | Holds a stage boundary's input populations and existing output identities. |
|
|
165
|
+
| `CaptureProjectResult` | interface | `{ project, variant, record, declarations, passed }` | Reports validated project evidence, retaining empty successful selections explicitly. |
|
|
166
|
+
| `CaptureStageResult` | interface | `{ request, projects, entries, lookups, duration }` | Reports the successful stage's committed stamps and validated lookup evidence. |
|
|
167
|
+
| `CaptureReadOptions` | interface | `{ variants?, portfolio? }` | Selects a declaration population without requiring current images or passing state lookups. |
|
|
168
|
+
| `CaptureStaleOptions` | interface | `{ declared? }` | Selects a freshness population and names the producing variants the host wrapper declares. |
|
|
169
|
+
| `CaptureCheckOptions` | interface | `{ variants, portfolio? }` | Selects required output pairs and attributable extras for a freshness reading. |
|
|
170
|
+
| `CaptureReadResult` | interface | `{ registry, entries }` | Returns the exact current declaration destinations and their complete-anchor identity. |
|
|
171
|
+
| `CaptureCheckResult` | interface | `{ required, entries, warnings, duration }` | Reports the exact judged population, every mismatch reason, and conservative test warnings. |
|
|
172
|
+
| `CaptureLookupOptions` | interface | `{ state, variants, portfolio? }` | Requests a state-to-case resolution before the runner starts any selected project. |
|
|
173
|
+
| `CaptureLookupResult` | interface | `{ case, entries, lookups }` | Resolves one declaring case and its actual output pairs with their passing evidence. |
|
|
174
|
+
| `CaptureRunEvidence` | interface | `{ file, run }` | Binds a decoded run record to the physical file whose digest authenticated it. |
|
|
175
|
+
| `CaptureDirectoryResult` | interface | `{ directory, ancestors }` | Carries one physical-directory ancestry while enumerating logical portfolio paths. |
|
|
176
|
+
| `CaptureEvidence` | interface | `{ registry, collections, manifest?, lookups, runs }` | Carries accepted registry anchors and separately persisted passing run evidence. |
|
|
177
|
+
| `CaptureCollectionEvidence` | interface | `{ receipt }` | Carries the authenticated external record beside its collection receipt. |
|
|
178
|
+
| `CaptureReceiptInput` | interface | `{ receipt, report, outcome, capped }` | Supplies a verifier's actual process outcome and exact reporter bytes for registry import. |
|
|
179
|
+
| `CaptureIntegrityInterface` | interface | `{ changed(), read(), stamp(), check(), lookup() }` | Defines the shared stage transaction, freshness reading, and state resolution engine. |
|
|
180
|
+
| `CaptureProject` | interface | `{ name, variant, tags, variants, directory, record, inputs, final, first, uniform?, portfolios, standalone }` | Preserves the wrapper's host declarations, including optional uniform scopes, for consumers. |
|
|
181
|
+
| `CaptureRunnerOptions` | interface | `{ command, root, config, requests, argv, stdout?, stderr?, integrity?, deadline? }` | Configures one runner invocation: its command, its workspace, and the command line it reads. |
|
|
182
|
+
| `CaptureRunnerArguments` | interface | `{ selector?, changed?, plan?, config, mode?, variants, case?, state?, portfolio? }` | Carries parsed runner arguments, including an optional wrapper mode, while leaving omitted selectors available to the usage diagnostic. |
|
|
183
|
+
| `CaptureRunnerInterface` | interface | `{ execute() }` | Drives selected owners through one journey stage or staged frame captures. |
|
|
184
|
+
| `CaptureChange` | interface | `{ path, classification, owners }` | Classifies one changed Git path against accepted source attribution. |
|
|
185
|
+
| `CaptureChangePlan` | interface | `{ changes, owners }` | Holds changed paths and the stable owner selection reduced by ancestry. |
|
|
186
|
+
| `CaptureOwnerOutcome` | interface | `{ owner, code, ran }` | Records one changed owner's exit and whether an execution child started. |
|
|
187
|
+
| `CaptureWriteHandler` | type | `(text: string) => unknown` | Writes one chunk of runner output to the stream the host chooses. |
|
|
188
|
+
| `CaptureCLIOptions` | interface | `{ root?, stdout?, stderr? }` | Configures the executable's workspace and its report and diagnostic writers. |
|
|
189
|
+
| `CaptureCLIInterface` | interface | `{ execute() }` | Runs capture command lines through injected output writers. |
|
|
190
|
+
| `CaptureIntegrityHandler` | type | `(options: CaptureIntegrityOptions) => CaptureIntegrityInterface` | Creates the integrity engine the runner reads and stamps through, from the options it derives. |
|
|
191
|
+
| `CaptureStagePlan` | interface | `{ name, variants }` | Names one planned stage and the variants it runs in one Vitest process. |
|
|
192
|
+
| `CaptureArgumentsOptions` | interface | `{ entry, config, report, projects, filter, case?, final, mode?, titles? }` | Configures the Vitest argument list one stage spawns with. |
|
|
193
|
+
| `CaptureRequestOptions` | interface | `{ ppid, argv, directory?, config, owners, variants }` | Configures how a wrapper reads the runner's request for its own Vitest process. |
|
|
194
|
+
| `CaptureOutcome` | interface | `{ project, variant, count }` | Carries one project's owner-bearing passed work count from a finished stage. |
|
|
195
|
+
| `CaptureRunPlan` | interface | `{ command, projects, selector, filter, case?, state?, final, directory, config, mode? }` | Carries everything every stage of one invocation shares. |
|
|
196
|
+
| `CaptureInvocationOptions` | interface | `{ command, root, requests, stdout, stderr, terminate?, ownership? }` | Configures one runner invocation's identity, workspace, and output. |
|
|
197
|
+
| `CaptureChildTerminationHandler` | type | `(child: DuplexInterface) => Promise<boolean>` | Terminates one supervised child and reports whether its exit was confirmed. |
|
|
198
|
+
| `CaptureInvocationInterface` | interface | `{ id, request, directory, signal, interrupted, attach(), release(), prepare(), holders(), publish(), retract(), launched(), spawn() }` | Owns one runner invocation's identity, request file, children, and interruption. |
|
|
199
|
+
| `CaptureDiscoveryRequest` | interface | `{ version, phase, id, nonce, config, mode?, pid, args }` | Carries the request the runner publishes for the discovery child that reads its wrapper. |
|
|
200
|
+
| `CaptureHostEntry` | interface | `{ project, viewport? }` | Describes one wrapper project to the runner: its host declarations and, when it has one, its viewport. |
|
|
201
|
+
| `CaptureHostDescription` | interface | `{ version, id, nonce, config, parent, pid, projects }` | Carries the description a wrapper writes back to the runner that discovered it. |
|
|
202
|
+
| `CaptureDescriptionExpectation` | interface | `{ id, nonce, config, parent, pid }` | Names what a description must echo for the runner to accept it. |
|
|
203
|
+
| `CaptureDiscoveryOptions` | interface | `{ ppid, argv, directory?, config, projects }` | Configures how a wrapper answers the runner's discovery request. |
|
|
204
|
+
| `CaptureDiscoveryRunOptions` | interface | `{ root, config, invocation, mode?, deadline? }` | Configures one discovery: the workspace, the wrapper, the invocation that owns the child, and its bounds. |
|
|
205
|
+
| `CaptureDiscoveryInterface` | interface | `{ describe() }` | Reads a consumer's wrapper by running its installed Vitest in discovery mode. |
|
|
206
|
+
| `CapturePicture` | interface | `{ width, height, pixels }` | Carries a decoded RGB image for the image checks and the contact sheets. |
|
|
207
|
+
| `CaptureReaderOptions` | interface | `{ root, config, mode?, selection, journeys, checks?, requests?, deadline?, stdout?, stderr? }` | Configures a read-only capture consumer using the wrapper's host declarations. |
|
|
208
|
+
| `CaptureProducer` | interface | `{ project }` | Declares the viewport one wrapper project produces beside the project's own name. |
|
|
209
|
+
| `CaptureReaderDefaults` | interface | `{ config, journeys, requests? }` | Supplies the wrapper path, the journey artifact directory, and the request directory a reader command line falls back to. |
|
|
210
|
+
| `CaptureReaderSelection` | interface | `{ integrity, population, variants, directory, uniform? }` | Returns a reader's authenticated selection, uniform scopes, and engine for pixel classification. |
|
|
211
|
+
| `CaptureArtifactResult` | interface | `{ record, run, file, text }` | Carries a judged run record and the verified text of the journey artifact it names. |
|
|
212
|
+
| `CaptureJudgedRecord` | interface | `{ record, case }` | Names the run record a judged frame's stamp points at and the case that stamped it. |
|
|
213
|
+
| `CaptureJudgedFrame` | interface | `{ entry, artifact, issues }` | Pairs a judged frame with its verified artifact, when one was read, and its coverage issues. |
|
|
214
|
+
| `CaptureDecodedImage` | interface | `{ entry, picture, digest, size }` | Records one selected image's real bytes, geometry, and canonical destination. |
|
|
215
|
+
| `CaptureImageResult` | interface | `{ picture, thumbnail }` | Retains source geometry and a bounded sheet thumbnail after a full frame has been judged. |
|
|
216
|
+
| `CaptureOwnership` | interface | `{ pid, id }` | Identifies the process and invocation that own a request directory. |
|
|
217
|
+
| `CaptureOwnershipHost` | interface | `{ platform, read, write, link, remove, alive }` | Supplies the filesystem and liveness boundary for ownership arbitration. |
|
|
218
|
+
| `CapturePngLimits` | interface | `{ pixels, side, bytes }` | Bounds a PNG's decoded pixels, side length, and encoded bytes. |
|
|
219
|
+
| `CaptureCheckFrame` | interface | `{ entry, picture, artifact }` | Carries one judged frame to a host check: its destination, its decoded pixels, and its artifact. |
|
|
220
|
+
| `CaptureCheckHandler` | type | `(frame: CaptureCheckFrame) => readonly string[]` | Reads one judged frame against a host rule and returns the issues it finds, none when it passes. |
|
|
221
|
+
| `CapturePreflightResult` | interface | `{ mixed, variants, directory, selection, freshness, images, issues }` | Reports selected image checks without upgrading their engine freshness classifications. |
|
|
222
|
+
| `CapturePreflightInterface` | interface | `{ read(), check(), execute() }` | Reads the selected population's frames and reports their freshness, mixed observations, and coverage. |
|
|
223
|
+
| `CaptureSheetOptions` | interface | `{ reader, output }` | Carries a contact-sheet output request separately from the population selection. |
|
|
224
|
+
| `CaptureSheetCell` | interface | `{ entry, picture, source, factor, clipped, freshness }` | Holds one contact-sheet cell: a frame's destination, its shrunk picture, and what the sheet reports about it. |
|
|
225
|
+
| `CaptureSheetGroup` | interface | `{ identity, cells, picture }` | Holds the cells of one portfolio, owner, and state side by side as one composite picture. |
|
|
226
|
+
| `CaptureSheetRow` | interface | `{ groups, picture }` | Holds a pair of groups side by side as one composite picture. |
|
|
227
|
+
| `CaptureSheetPage` | interface | `{ file, rows, picture }` | Holds one written sheet: its file name, the rows it stacks, and the composite picture. |
|
|
228
|
+
| `CaptureReaderCommand` | interface | `{ reader, output? }` | Carries parsed reader arguments and an optional contact-sheet output directory. |
|
|
229
|
+
| `CaptureSheetsInterface` | interface | `{ execute() }` | Composes exactly the authenticated sparse state and output pairs for iteration review. |
|
|
230
|
+
| `CaptureRegistryArguments` | interface | `{ config, variants, mode? }` | Carries the parsed registry command line: the wrapper, the variants to refresh, and the mode. |
|
|
231
|
+
| `CaptureRegistrarOptions` | interface | `{ root, config, requests, argv, stdout?, stderr?, deadline? }` | Configures one registry refresh: its workspace, wrapper default, request directory, and command line. |
|
|
232
|
+
| `CaptureRegistrarInterface` | interface | `{ execute() }` | Refreshes the accepted registry from one complete capture-free journey per producing variant. |
|
|
233
|
+
| `CaptureInputHandler` | type | `(file: string) => string \| undefined` | Reads a contained input through an owning operation's file snapshot memo. |
|
|
234
|
+
| `CaptureRetractionHandler` | type | `() => void` | Removes one invocation's published request during shutdown. |
|
|
235
|
+
| `CaptureTerminationHandler` | type | `() => Promise<boolean>` | Begins one independent child termination only after request removal has been attempted. |
|
|
236
236
|
|
|
237
237
|
### Server constants
|
|
238
238
|
|
|
239
239
|
The runner's names and bounds from [`constants.ts`](../src/server/constants.ts).
|
|
240
240
|
|
|
241
|
-
| Name | Kind | Signature
|
|
242
|
-
| ------------------------- | ----- |
|
|
243
|
-
| `CAPTURE_COMMAND_NAMES` | const | `Readonly<{ readonly journey: 'journey'; readonly capture: 'frames'; readonly stale: 'stale'; }>`
|
|
244
|
-
| `CAPTURE_COMMAND_OPTIONS` | const | `Readonly<{ readonly journey: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; changed: Readonly<{ type: "string"; }>; plan: Readonly<{ type: "boolean"; }>; }>; readonly capture: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; state: Readonly<{ type: "string"; }>; changed: Readonly<{ type: "string"; }>; plan: Readonly<{ type: "boolean"; }>; }>; readonly stale: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; state: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; }>; readonly preflight: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; state: Readonly<{ type: "string"; }>; case: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; config: Readonly<{ type: "string"; }>; journeys: Readonly<{ type: "string"; }>; checks: Readonly<{ type: "string"; }>; }>; readonly sheets: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; state: Readonly<{ type: "string"; }>; case: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; config: Readonly<{ type: "string"; }>; journeys: Readonly<{ type: "string"; }>; checks: Readonly<{ type: "string"; }>; output: Readonly<{ type: "string"; }>; }>; readonly registry: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; config: Readonly<{ type: "string"; }>; mode: Readonly<{ type: "string"; }>; }>; }>` | Defines each command's frozen options for Node's standard argument parser. |
|
|
245
|
-
| `CAPTURE_EXIT` | const | `Readonly<{ readonly passed: 0; readonly failed: 1; readonly usage: 64; }>`
|
|
246
|
-
| `CAPTURE_OWNER_FILE` | const | `".capture-owner"`
|
|
247
|
-
| `CAPTURE_REFUSAL_LIMIT` | const | `16`
|
|
248
|
-
| `CAPTURE_STAGES` | const | `Readonly<{ readonly selected: 'selected'; readonly first: 'narrow'; readonly rest: 'rest'; }>`
|
|
249
|
-
| `CAPTURE_TAG_OPERATORS` | const | `readonly string[]`
|
|
250
|
-
| `CAPTURE_OWNER_PREFIX` | const | `"owner:"`
|
|
251
|
-
| `CAPTURE_FLAG` | const | `"CAPTURE"`
|
|
252
|
-
| `CAPTURE_FLAG_VALUE` | const | `"1"`
|
|
253
|
-
| `CAPTURE_VITEST_ENTRY` | const | `"node_modules/vitest/vitest.mjs"`
|
|
254
|
-
| `CAPTURE_RUNS_DIRECTORY` | const | `"runs"`
|
|
255
|
-
| `CAPTURE_SURVIVORS_FILE` | const | `"survivors.json"`
|
|
256
|
-
| `CAPTURE_MINIMUM_IMAGE` | const | `4000`
|
|
257
|
-
| `CAPTURE_REPORT_LINES` | const | `Readonly<{ readonly preflight: 'READER'; readonly sheets: 'SHEETS'; }>`
|
|
258
|
-
| `CAPTURE_SHEET` | const | `Readonly<{ readonly cell: 320; readonly limit: 400; readonly mark: Readonly<{ width: 160; height: 20; present: 220; absent: 20; }>; readonly gap: 12; readonly pairs: 2; readonly rows: 4; }>`
|
|
259
|
-
| `CAPTURE_SHEET_FILES` | const | `Readonly<{ readonly prefix: 'sheet-'; readonly digits: 3; readonly index: 'index.json'; readonly notes: 'index.md'; }>`
|
|
260
|
-
| `CAPTURE_REGISTRY_STAGE` | const | `"registry"`
|
|
261
|
-
| `CAPTURE_REGISTRY_LINE` | const | `"REGISTRY"`
|
|
262
|
-
| `CAPTURE_REQUESTS_FLAG` | const | `"CAPTURE_REQUESTS"`
|
|
263
|
-
| `CAPTURE_DISCOVERY` | const | `Readonly<{ readonly phase: 'discover'; readonly description: 'description.json'; readonly arguments: readonly string[]; readonly deadline: 60000; }>`
|
|
264
|
-
| `CAPTURE_SUBCOMMANDS` | const | `readonly string[]`
|
|
265
|
-
| `CAPTURE_DEFAULTS` | const | `Readonly<{ readonly config: 'configs/app/vite.journey.config.ts'; readonly requests: 'tmp/capture'; readonly journeys: 'tmp/journey'; }>`
|
|
266
|
-
| `CAPTURE_USAGE` | const | `string`
|
|
267
|
-
| `CAPTURE_PNG_LIMITS` | const | `Readonly<{ readonly pixels: number; readonly side: 131072; readonly bytes: number; }>`
|
|
268
|
-
| `CAPTURE_OWNER_TIMEOUT` | const | `1000`
|
|
269
|
-
| `CAPTURE_OWNER_BACKOFF` | const | `10`
|
|
270
|
-
| `CAPTURE_MESSAGE_LIMIT` | const | `1024`
|
|
241
|
+
| Name | Kind | Signature | Summary |
|
|
242
|
+
| ------------------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
243
|
+
| `CAPTURE_COMMAND_NAMES` | const | `Readonly<{ readonly journey: 'journey'; readonly capture: 'frames'; readonly stale: 'stale'; }>` | Names the executable subcommand each runner command answers to. |
|
|
244
|
+
| `CAPTURE_COMMAND_OPTIONS` | const | `Readonly<{ readonly journey: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; changed: Readonly<{ type: "string"; }>; plan: Readonly<{ type: "boolean"; }>; mode: Readonly<{ type: "string"; }>; }>; readonly capture: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; state: Readonly<{ type: "string"; }>; changed: Readonly<{ type: "string"; }>; plan: Readonly<{ type: "boolean"; }>; mode: Readonly<{ type: "string"; }>; }>; readonly stale: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; state: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; mode: Readonly<{ type: "string"; }>; }>; readonly preflight: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; state: Readonly<{ type: "string"; }>; case: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; config: Readonly<{ type: "string"; }>; journeys: Readonly<{ type: "string"; }>; checks: Readonly<{ type: "string"; }>; mode: Readonly<{ type: "string"; }>; }>; readonly sheets: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; state: Readonly<{ type: "string"; }>; case: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; config: Readonly<{ type: "string"; }>; journeys: Readonly<{ type: "string"; }>; checks: Readonly<{ type: "string"; }>; mode: Readonly<{ type: "string"; }>; output: Readonly<{ type: "string"; }>; }>; readonly registry: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; config: Readonly<{ type: "string"; }>; mode: Readonly<{ type: "string"; }>; }>; }>` | Defines each command's frozen options for Node's standard argument parser. |
|
|
245
|
+
| `CAPTURE_EXIT` | const | `Readonly<{ readonly passed: 0; readonly failed: 1; readonly usage: 64; }>` | Holds the exit status each runner outcome maps to. |
|
|
246
|
+
| `CAPTURE_OWNER_FILE` | const | `".capture-owner"` | Names the exclusive workspace invocation marker. |
|
|
247
|
+
| `CAPTURE_REFUSAL_LIMIT` | const | `16` | Caps each refusal population so hostile records cannot flood a terminal or agent context. |
|
|
248
|
+
| `CAPTURE_STAGES` | const | `Readonly<{ readonly selected: 'selected'; readonly first: 'narrow'; readonly rest: 'rest'; }>` | Names the selected journey stage and the narrow and remaining frame stages. |
|
|
249
|
+
| `CAPTURE_TAG_OPERATORS` | const | `readonly string[]` | Lists the words a tag name can never be, because a tag filter reads them as operators. |
|
|
250
|
+
| `CAPTURE_OWNER_PREFIX` | const | `"owner:"` | Names the tag prefix that marks a case's owner path and each ancestor of it. |
|
|
251
|
+
| `CAPTURE_FLAG` | const | `"CAPTURE"` | Names the environment variable that turns frame capture on for a Vitest child. |
|
|
252
|
+
| `CAPTURE_FLAG_VALUE` | const | `"1"` | Holds the one value of the capture variable that turns frame capture on. |
|
|
253
|
+
| `CAPTURE_VITEST_ENTRY` | const | `"node_modules/vitest/vitest.mjs"` | Names the repository-relative path of the Vitest entry the runner spawns through Node. |
|
|
254
|
+
| `CAPTURE_RUNS_DIRECTORY` | const | `"runs"` | Names the directory beneath a portfolio or request directory that holds one invocation's records. |
|
|
255
|
+
| `CAPTURE_SURVIVORS_FILE` | const | `"survivors.json"` | Names the create-only child record beneath an invocation's run directory. |
|
|
256
|
+
| `CAPTURE_MINIMUM_IMAGE` | const | `4000` | Holds the byte count under which an image is too small to be a real frame. |
|
|
257
|
+
| `CAPTURE_REPORT_LINES` | const | `Readonly<{ readonly preflight: 'READER'; readonly sheets: 'SHEETS'; }>` | Names the first word of the line a reader prints, followed by its JSON report. |
|
|
258
|
+
| `CAPTURE_SHEET` | const | `Readonly<{ readonly cell: 320; readonly limit: 400; readonly mark: Readonly<{ width: 160; height: 20; present: 220; absent: 20; }>; readonly gap: 12; readonly pairs: 2; readonly rows: 4; }>` | Holds the contact-sheet geometry: how wide a cell shrinks toward, how tall it may grow, the mark that stands in for an unreadable image, the gap between neighbors, and how many cells, rows, and pairs a row and a sheet hold. |
|
|
259
|
+
| `CAPTURE_SHEET_FILES` | const | `Readonly<{ readonly prefix: 'sheet-'; readonly digits: 3; readonly index: 'index.json'; readonly notes: 'index.md'; }>` | Names the contact-sheet files: the sheet prefix and digits, and the two index documents. |
|
|
260
|
+
| `CAPTURE_REGISTRY_STAGE` | const | `"registry"` | Names the stage each producing variant's complete journey runs in, ahead of the variant's name. |
|
|
261
|
+
| `CAPTURE_REGISTRY_LINE` | const | `"REGISTRY"` | Names the first word of the line the registry refresh prints, followed by its JSON summary. |
|
|
262
|
+
| `CAPTURE_REQUESTS_FLAG` | const | `"CAPTURE_REQUESTS"` | Names the environment variable that carries the absolute request directory to a Vitest child. |
|
|
263
|
+
| `CAPTURE_DISCOVERY` | const | `Readonly<{ readonly phase: 'discover'; readonly description: 'description.json'; readonly arguments: readonly string[]; readonly deadline: 60000; }>` | Holds the discovery exchange's fixed names and bound. |
|
|
264
|
+
| `CAPTURE_SUBCOMMANDS` | const | `readonly string[]` | Names the executable's subcommands in the order its usage text lists them. |
|
|
265
|
+
| `CAPTURE_DEFAULTS` | const | `Readonly<{ readonly config: 'configs/app/vite.journey.config.ts'; readonly requests: 'tmp/capture'; readonly journeys: 'tmp/journey'; }>` | Holds the repository-relative paths the executable falls back to when the command line names none. |
|
|
266
|
+
| `CAPTURE_USAGE` | const | `string` | Holds the usage text the executable prints when it is given no subcommand or an unknown one. |
|
|
267
|
+
| `CAPTURE_PNG_LIMITS` | const | `Readonly<{ readonly pixels: number; readonly side: 131072; readonly bytes: number; }>` | Bounds decoded image memory, row metadata, and PNG input bytes independently of untrusted headers. |
|
|
268
|
+
| `CAPTURE_OWNER_TIMEOUT` | const | `1000` | Bounds a synchronous ownership retry sequence in milliseconds, including host contention. |
|
|
269
|
+
| `CAPTURE_OWNER_BACKOFF` | const | `10` | Yields between ownership probes in milliseconds so filesystem contention can settle. |
|
|
270
|
+
| `CAPTURE_MESSAGE_LIMIT` | const | `1024` | Bounds external diagnostic text while retaining the number of omitted characters. |
|
|
271
271
|
|
|
272
272
|
### Server helpers
|
|
273
273
|
|
|
@@ -318,7 +318,7 @@ Leaves from [`helpers.ts`](../src/server/helpers.ts): hashing, digests, registry
|
|
|
318
318
|
| `collectCaptureIdentical` | function | `(images: readonly CaptureImageResult[]) => ReadonlyArray<readonly string[]>` | Groups the selected images whose bytes are identical. |
|
|
319
319
|
| `collectCaptureErrors` | function | `(file: string, text: string) => readonly string[]` | Finds the journey artifact lines that report an uncaught, unhandled, or logged error. |
|
|
320
320
|
| `readCaptureRunning` | function | `(pid: number) => boolean` | Checks whether a process with this id is running, counting one the caller may not signal. |
|
|
321
|
-
| `resolveCaptureWrapperProject` | function | `(input: unknown) => Promise<unknown>`
|
|
321
|
+
| `resolveCaptureWrapperProject` | function | `(input: unknown, mode?: string) => Promise<unknown>` | Resolves one entry of a wrapper's project list to the project it declares. |
|
|
322
322
|
| `readCaptureEntry` | function | `(value: unknown) => CaptureHostEntry` | Reads one wrapper project, as the description file holds it, into its host declarations and viewport. |
|
|
323
323
|
| `resolveCaptureRequests` | function | `(directory?: string) => string` | Resolves the directory that holds the runner's request files for the process that reads them. |
|
|
324
324
|
| `buildCaptureDiscoveryConfig` | function | `() => { readonly test: { readonly include: string[]; readonly passWithNoTests: boolean; readonly watch: boolean; }; }` | Builds the empty Node configuration a wrapper returns once it has answered a discovery request. |
|
|
@@ -646,7 +646,7 @@ A module that cannot be loaded, exports no list of functions, or holds a reader
|
|
|
646
646
|
|
|
647
647
|
### Registry refresh
|
|
648
648
|
|
|
649
|
-
The command that bootstraps or replaces the accepted registry. The stage transaction refuses to run until a registry exists, so the refresh cannot stamp through the engine: it imports complete runs instead. `createCaptureRegistrar` takes the same options as the runner minus the command, and `execute` reads the wrapper through the same `CaptureDiscovery` the runner uses, forwarding `--mode` to
|
|
649
|
+
The command that bootstraps or replaces the accepted registry. The stage transaction refuses to run until a registry exists, so the refresh cannot stamp through the engine: it imports complete runs instead. `createCaptureRegistrar` takes the same options as the runner minus the command, and `execute` reads the wrapper through the same `CaptureDiscovery` the runner uses, forwarding `--mode` to discovery, the factory, and each execution child. It takes the same invocation entity and request file, and runs one stage per producing variant with the `all` selector, the `journey` command, and no capture variable.
|
|
650
650
|
|
|
651
651
|
Refresh a selected producing variant through the registrar:
|
|
652
652
|
|
|
@@ -761,11 +761,11 @@ checks live request-file holders.
|
|
|
761
761
|
|
|
762
762
|
The `capture` executable dispatches the following subcommands through the server implementations:
|
|
763
763
|
|
|
764
|
-
- `capture journey <selector>` calls `createCaptureRunner` with the `journey` command and reads `--variant` (repeats), `--case`, and `--config`. Replace the selector with `--changed <ref>` and optionally add `--plan`.
|
|
765
|
-
- `capture frames <selector>` calls `createCaptureRunner` with the `capture` command and reads `--variant` (repeats), `--case`, `--state`, and `--config`. Replace the selector with `--changed <ref>` and optionally add `--plan`.
|
|
766
|
-
- `capture stale <selector>` calls `createCaptureRunner` with the `stale` command and reads `--variant` (repeats), `--case`, `--state`, `--portfolio`, and `--config`.
|
|
767
|
-
- `capture preflight <selector>` calls `createCapturePreflight` and reads `--variant` (repeats), `--state`, `--case`, `--portfolio`, `--config`, `--journeys`, and `--checks`.
|
|
768
|
-
- `capture sheets <selector> --output <directory>` calls `createCaptureSheets` with the preflight's flags and a required `--output`.
|
|
764
|
+
- `capture journey <selector>` calls `createCaptureRunner` with the `journey` command and reads `--variant` (repeats), `--case`, `--mode`, and `--config`. Replace the selector with `--changed <ref>` and optionally add `--plan`.
|
|
765
|
+
- `capture frames <selector>` calls `createCaptureRunner` with the `capture` command and reads `--variant` (repeats), `--case`, `--state`, `--mode`, and `--config`. Replace the selector with `--changed <ref>` and optionally add `--plan`.
|
|
766
|
+
- `capture stale <selector>` calls `createCaptureRunner` with the `stale` command and reads `--variant` (repeats), `--case`, `--state`, `--portfolio`, `--mode`, and `--config`.
|
|
767
|
+
- `capture preflight <selector>` calls `createCapturePreflight` and reads `--variant` (repeats), `--state`, `--case`, `--portfolio`, `--mode`, `--config`, `--journeys`, and `--checks`.
|
|
768
|
+
- `capture sheets <selector> --output <directory>` calls `createCaptureSheets` with the preflight's flags, including `--mode`, and a required `--output`.
|
|
769
769
|
- `capture registry` calls `createCaptureRegistrar` and reads `--variant` (repeats), `--mode`, and `--config`.
|
|
770
770
|
|
|
771
771
|
`frames` runs the request command `capture`, because `capture capture` would stutter. Node's `node:util` `parseArgs` reads one frozen option table per command. Every flag except the valueless `--plan` takes one nonempty value, either `--flag value` or `--flag=value`. A value beginning with `-` must use equals form, such as `--case=-draft`. Only `--variant` repeats; a repeated boolean, a repeated single-value option (including mixed forms), an empty value, an unknown or command-inappropriate option, and the `--` terminator are refused. Runner flags may precede or follow the selector; preflight and sheets retain a leading selector; registry takes no positional arguments. Parser refusals carry `USAGE`, the parser diagnostic, and the command's usage text. The executable falls back to `CAPTURE_DEFAULTS` when the command line names none: the wrapper `configs/app/vite.journey.config.ts`, the request directory `tmp/capture`, and the journey artifact directory `tmp/journey`. The request directory reaches the wrapper through `CAPTURE_REQUESTS`, so the wrapper repeats nothing.
|