@orkestrel/scaffold 0.0.115 → 0.0.117

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.
Files changed (70) hide show
  1. package/dist/bin/main.js +138 -16
  2. package/dist/bin/main.js.map +1 -1
  3. package/dist/host/agents/skills/orkestrel-publish/references/wave.md +1 -1
  4. package/dist/host/claude/agents/orkestrel.md +2 -2
  5. package/dist/host/claude/rules/names.md +3 -1
  6. package/dist/host/guides/abort.md +17 -17
  7. package/dist/host/guides/agent.md +445 -445
  8. package/dist/host/guides/brief.md +143 -143
  9. package/dist/host/guides/browser.md +731 -731
  10. package/dist/host/guides/budget.md +39 -39
  11. package/dist/host/guides/capture.md +298 -298
  12. package/dist/host/guides/console.md +109 -109
  13. package/dist/host/guides/contract.md +335 -335
  14. package/dist/host/guides/csv.md +30 -30
  15. package/dist/host/guides/database.md +163 -163
  16. package/dist/host/guides/emitter.md +17 -17
  17. package/dist/host/guides/form.md +99 -99
  18. package/dist/host/guides/guide.md +368 -183
  19. package/dist/host/guides/html.md +49 -49
  20. package/dist/host/guides/indexeddb.md +40 -40
  21. package/dist/host/guides/interpret.md +139 -139
  22. package/dist/host/guides/lsp.md +114 -114
  23. package/dist/host/guides/markdown.md +68 -68
  24. package/dist/host/guides/mcp.md +3745 -3745
  25. package/dist/host/guides/middleware.md +170 -170
  26. package/dist/host/guides/msg.md +95 -95
  27. package/dist/host/guides/ndjson.md +8 -8
  28. package/dist/host/guides/ollama.md +56 -56
  29. package/dist/host/guides/pool.md +21 -21
  30. package/dist/host/guides/probe.md +82 -82
  31. package/dist/host/guides/process.md +99 -99
  32. package/dist/host/guides/program.md +98 -96
  33. package/dist/host/guides/qualifier.md +70 -70
  34. package/dist/host/guides/queue.md +37 -37
  35. package/dist/host/guides/rater.md +38 -38
  36. package/dist/host/guides/reason.md +308 -308
  37. package/dist/host/guides/relation.md +50 -50
  38. package/dist/host/guides/router.md +58 -58
  39. package/dist/host/guides/scaffold.md +558 -419
  40. package/dist/host/guides/sea.md +128 -128
  41. package/dist/host/guides/server.md +100 -100
  42. package/dist/host/guides/sqlite.md +28 -28
  43. package/dist/host/guides/sse.md +20 -20
  44. package/dist/host/guides/study.md +444 -444
  45. package/dist/host/guides/table.md +82 -82
  46. package/dist/host/guides/template.md +41 -41
  47. package/dist/host/guides/terminal.md +121 -121
  48. package/dist/host/guides/test.md +273 -273
  49. package/dist/host/guides/timeout.md +18 -18
  50. package/dist/host/guides/tool.md +27 -27
  51. package/dist/host/guides/toolbox.md +166 -166
  52. package/dist/host/guides/websocket.md +54 -54
  53. package/dist/host/guides/worker.md +24 -24
  54. package/dist/host/guides/workflow.md +187 -187
  55. package/dist/host/guides/workspace.md +55 -55
  56. package/dist/host/manifest.json +55 -55
  57. package/dist/host/tests/setupPolicy.ts +5 -3
  58. package/dist/src/core/index.cjs +90 -4
  59. package/dist/src/core/index.cjs.map +1 -1
  60. package/dist/src/core/index.d.cts +229 -144
  61. package/dist/src/core/index.d.ts +229 -144
  62. package/dist/src/core/index.js +88 -5
  63. package/dist/src/core/index.js.map +1 -1
  64. package/dist/src/server/index.cjs +295 -66
  65. package/dist/src/server/index.cjs.map +1 -1
  66. package/dist/src/server/index.d.cts +193 -6
  67. package/dist/src/server/index.d.ts +193 -6
  68. package/dist/src/server/index.js +290 -69
  69. package/dist/src/server/index.js.map +1 -1
  70. package/package.json +5 -4
@@ -31,25 +31,25 @@ optional field is absent rather than empty.
31
31
 
32
32
  A `Shape` cell holds an interface's data members as bare names in braces, `?` marking an optional member and `plus` introducing its call-signature members, and a type alias's own type literal with a union's arms escaped as `\|`. An extended interface's name comes before `plus`, with the members it adds after.
33
33
 
34
- | Name | Kind | Shape | Summary |
35
- | ------------------- | --------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
36
- | `Stage` | type | `'type' \| 'lint' \| 'runtime'` | Names an inspection a claim passes through, derived from `PROBE_STAGES`. |
37
- | `Draft` | interface | `{ path, text }` | Carries one proposed file's location and its contents. |
38
- | `Case` | interface | `{ files, test }` | Carries the candidate drafts a claim asserts about and the test that exercises them. |
39
- | `Control` | interface | `Case plus { stage, reason }` | Extends a case with the stage it must fail at and the reason it must fail there. |
40
- | `Claim` | interface | `{ project, case, control }` | Carries everything the service needs to produce one verdict. |
41
- | `Party` | type | `'claimant' \| 'workspace' \| 'instrument'` | Names who must act on an issue or probe failure. |
42
- | `Issue` | interface | `{ origin, path, message, range? }` | Carries one message a stage reported, where it reported it, and whose fault it names. |
43
- | `Check` | interface | `{ stage, elapsed, issues }` | Carries one stage's outcome: what it cost and what it reported. |
44
- | `Toolchain` | interface | `{ typescript, oxlint, vitest }` | Names the tool versions a verdict was produced with. |
45
- | `Project` | interface | `{ path, digest }` | Names the TypeScript project that judged a verdict's candidate drafts. |
46
- | `Verdict` | interface | `{ id, digest, toolchain, project, reason?, case, control, elapsed, receipt? }` | Carries the full result of one claim: every stage, for both the case and its control. |
47
- | `ProbeEventMap` | type | `{ arm, prove, expire, error }` | Reports what a probe observes while it serves. |
48
- | `ProbeOptions` | interface | `{ on?, error?, workspace?, deadline?, warm? }` | Configures a probe. |
49
- | `ProbeInterface` | interface | `{ emitter, toolchain } plus start, prove, destroy` | Answers a claim with type, lint, and runtime evidence in one call. |
50
- | `ProbeErrorCode` | type | `'refused' \| 'missing' \| 'malformed' \| 'destroyed' \| 'deadline'` | Names the condition that ended a probe operation, derived from `PROBE_ERROR_CODES`. |
51
- | `ProbeErrorContext` | interface | `{ stage?, path?, project?, name?, deadline?, value? }` | Carries the structured detail one probe failure reports beside its message. |
52
- | `ProbeErrorOptions` | interface | `{ origin, code, context?, cause? }` | Configures one probe failure at construction. |
34
+ | Name | Kind | Signature | Summary |
35
+ | ------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
36
+ | `Stage` | type | `(typeof PROBE_STAGES)[number]` | Names an inspection a claim passes through, derived from `PROBE_STAGES`. |
37
+ | `Draft` | interface | `{ path, text }` | Carries one proposed file's location and its contents. |
38
+ | `Case` | interface | `{ files, test }` | Carries the candidate drafts a claim asserts about and the test that exercises them. |
39
+ | `Control` | interface | `{ stage, reason }` | Extends a case with the stage it must fail at and the reason it must fail there. |
40
+ | `Claim` | interface | `{ project, case, control }` | Carries everything the service needs to produce one verdict. |
41
+ | `Party` | type | `(typeof PROBE_PARTIES)[number]` | Names who must act on an issue or probe failure. |
42
+ | `Issue` | interface | `{ origin, path, message, range? }` | Carries one message a stage reported, where it reported it, and whose fault it names. |
43
+ | `Check` | interface | `{ stage, elapsed, issues }` | Carries one stage's outcome: what it cost and what it reported. |
44
+ | `Toolchain` | interface | `{ typescript, oxlint, vitest }` | Names the tool versions a verdict was produced with. |
45
+ | `Project` | interface | `{ path, digest }` | Names the TypeScript project that judged a verdict's candidate drafts. |
46
+ | `Verdict` | interface | `{ id, digest, toolchain, project, reason?, case, control, elapsed, receipt? }` | Carries the full result of one claim: every stage, for both the case and its control. |
47
+ | `ProbeEventMap` | type | `{ readonly arm: readonly [toolchain: Toolchain]; readonly prove: readonly [verdict: Verdict]; readonly expire: readonly [claim: Claim]; readonly error: readonly [error: unknown]; }` | Reports what a probe observes while it serves. |
48
+ | `ProbeOptions` | interface | `{ on?, error?, workspace?, deadline?, warm? }` | Configures a probe. |
49
+ | `ProbeInterface` | interface | `{ emitter, toolchain, start(), prove(), destroy() }` | Answers a claim with type, lint, and runtime evidence in one call. |
50
+ | `ProbeErrorCode` | type | `(typeof PROBE_ERROR_CODES)[number]` | Names the condition that ended a probe operation, derived from `PROBE_ERROR_CODES`. |
51
+ | `ProbeErrorContext` | interface | `{ stage?, path?, project?, name?, deadline?, value? }` | Carries the structured detail one probe failure reports beside its message. |
52
+ | `ProbeErrorOptions` | interface | `{ origin, code, context?, cause? }` | Configures one probe failure at construction. |
53
53
 
54
54
  A row whose `Shape` cell names call-signature members after `plus` carries those members in
55
55
  [`## Methods`](#methods); the data members before `plus` stay here.
@@ -60,33 +60,33 @@ From [`constants.ts`](../src/core/constants.ts). Each is frozen.
60
60
 
61
61
  A `Shape` cell holds the constant's declared type.
62
62
 
63
- | Name | Kind | Shape | Summary |
64
- | ---------------------- | ----- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
65
- | `PROBE_STAGES` | const | `readonly Stage[]` | Lists the stages a claim passes through, in the order a verdict reports them: `['type', 'lint', 'runtime']`. |
66
- | `PROBE_PARTIES` | const | `readonly Party[]` | Lists the parties that can own action on an issue or probe failure: `['claimant', 'workspace', 'instrument']`. |
67
- | `RECEIPT_PREFIX` | const | `string` | Names the leading token every receipt carries, `'probe'`. |
68
- | `RECEIPT_SEPARATOR` | const | `string` | Names the character joining a receipt's tokens, `':'`. |
69
- | `PROBE_ERROR_CODES` | const | `readonly ProbeErrorCode[]` | Lists the conditions that can end a probe operation: `['refused', 'missing', 'malformed', 'destroyed', 'deadline']`. |
70
- | `PROBE_DEADLINE` | const | `number` | Names the default inspection deadline a `Probe` applies when its construction omits one, 30,000 ms. |
71
- | `LINT_DEADLINE` | const | `number` | Names the 2,000 ms bound the lint stage holds over the lifecycle exchanges the protocol leaves to the server: the `initialize` reply warming waits for and the `shutdown` reply ending waits for. |
72
- | `PROBE_KEYS` | const | `number` | Names the total enumerable key bound `ProbeServer` applies to inbound metadata and to produced tool content alike, 4096. |
73
- | `PROBE_SPECIFICATIONS` | const | `number` | Names the specification lifetime the runtime stage replaces its resident Vitest service at, 64 specifications. |
74
- | `RUNTIME_PLUGIN` | const | `string` | Names the Vite plugin the runtime stage installs into a target workspace's Vitest configuration, `'orkestrel-runtime-overlay'`. |
75
- | `TYPE_MIRROR` | const | `string` | Names the workspace-relative directory the type stage keeps its workspace mirror under, `'tmp/type'`. |
76
- | `PROBE_RESTARTS` | const | `number` | Bounds consecutive failed warms or idle losses before a stage's floor is spent. |
77
- | `PROBE_WARM` | const | `number` | Bounds the default type warm at 90,000 ms, independently of active inspections. |
78
- | `LINT_TEARDOWN` | const | `number` | Bounds lint teardown at 16,000 ms, including protocol exchanges and process termination. |
63
+ | Name | Kind | Signature | Summary |
64
+ | ---------------------- | ----- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
65
+ | `PROBE_STAGES` | const | `readonly ["type", "lint", "runtime"]` | Lists the stages a claim passes through, in the order a verdict reports them: `['type', 'lint', 'runtime']`. |
66
+ | `PROBE_PARTIES` | const | `readonly ["claimant", "workspace", "instrument"]` | Lists the parties that can own action on an issue or probe failure: `['claimant', 'workspace', 'instrument']`. |
67
+ | `RECEIPT_PREFIX` | const | `"probe"` | Names the leading token every receipt carries, `'probe'`. |
68
+ | `RECEIPT_SEPARATOR` | const | `":"` | Names the character joining a receipt's tokens, `':'`. |
69
+ | `PROBE_ERROR_CODES` | const | `readonly ["refused", "missing", "malformed", "destroyed", "deadline"]` | Lists the conditions that can end a probe operation: `['refused', 'missing', 'malformed', 'destroyed', 'deadline']`. |
70
+ | `PROBE_DEADLINE` | const | `30000` | Names the default inspection deadline a `Probe` applies when its construction omits one, 30,000 ms. |
71
+ | `LINT_DEADLINE` | const | `2000` | Names the 2,000 ms bound the lint stage holds over the lifecycle exchanges the protocol leaves to the server: the `initialize` reply warming waits for and the `shutdown` reply ending waits for. |
72
+ | `PROBE_KEYS` | const | `4096` | Names the total enumerable key bound `ProbeServer` applies to inbound metadata and to produced tool content alike, 4096. |
73
+ | `PROBE_SPECIFICATIONS` | const | `64` | Names the specification lifetime the runtime stage replaces its resident Vitest service at, 64 specifications. |
74
+ | `RUNTIME_PLUGIN` | const | `"orkestrel-runtime-overlay"` | Names the Vite plugin the runtime stage installs into a target workspace's Vitest configuration, `'orkestrel-runtime-overlay'`. |
75
+ | `TYPE_MIRROR` | const | `"tmp/type"` | Names the workspace-relative directory the type stage keeps its workspace mirror under, `'tmp/type'`. |
76
+ | `PROBE_RESTARTS` | const | `1` | Bounds consecutive failed warms or idle losses before a stage's floor is spent. |
77
+ | `PROBE_WARM` | const | `90000` | Bounds the default type warm at 90,000 ms, independently of active inspections. |
78
+ | `LINT_TEARDOWN` | const | `number` | Bounds lint teardown at 16,000 ms, including protocol exchanges and process termination. |
79
79
 
80
80
  ### Errors
81
81
 
82
82
  The failure type every served claim reports through, and its guard, from
83
83
  [`errors.ts`](../src/core/errors.ts).
84
84
 
85
- | Name | Kind | Signature | Summary |
86
- | ---------------------- | -------- | --------------------------------------------------- | ----------------------------------------------------------------------------- |
87
- | `ProbeError` | class | `new (message: string, options: ProbeErrorOptions)` | Reports one probe failure under stable ownership and condition axes. |
88
- | `isProbeError` | function | `(value: unknown) => value is ProbeError` | Checks whether an unknown value is a `ProbeError`. |
89
- | `createDestroyedError` | function | `(subject: string) => ProbeError` | Creates the failure raised when an instrument is used after it was torn down. |
85
+ | Name | Kind | Signature | Summary |
86
+ | ---------------------- | -------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------- |
87
+ | `ProbeError` | class | `new (message: string, options: ProbeErrorOptions) => ProbeError` | Reports one probe failure under stable ownership and condition axes. |
88
+ | `isProbeError` | function | `(value: unknown) => value is ProbeError` | Checks whether an unknown value is a `ProbeError`. |
89
+ | `createDestroyedError` | function | `(subject: string) => ProbeError` | Creates the failure raised when an instrument is used after it was torn down. |
90
90
 
91
91
  ### Shapes
92
92
 
@@ -98,12 +98,12 @@ narrower on `Draft.path`: see
98
98
 
99
99
  A `Shape` cell holds the constant's declared type.
100
100
 
101
- | Name | Kind | Shape | Summary |
102
- | --------------- | ----- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
103
- | `DRAFT_SHAPE` | const | `ObjectShape<{ path, text }>` | Describes one proposed file a claim carries. |
104
- | `CASE_SHAPE` | const | `ObjectShape<{ files, test }>` | Describes the drafts a claim asserts about and the test that exercises them. |
105
- | `CONTROL_SHAPE` | const | `ObjectShape<{ files, test, stage, reason }>` | Describes the negative control, which is a case plus where and why it must break. |
106
- | `CLAIM_SHAPE` | const | `ObjectShape<{ project, case, control }>` | Describes one claim and is the sole source of both the published tool schema and the guard applied to an arriving claim. |
101
+ | Name | Kind | Signature | Summary |
102
+ | --------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
103
+ | `DRAFT_SHAPE` | const | `import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>` | Describes one proposed file a claim carries. |
104
+ | `CASE_SHAPE` | const | `import("@orkestrel/contract").ObjectShape<{ files: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>>; test: import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>; }, false>` | Describes the drafts a claim asserts about and the test that exercises them. |
105
+ | `CONTROL_SHAPE` | const | `import("@orkestrel/contract").ObjectShape<{ files: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>>; test: import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>; stage: import("@orkestrel/contract").LiteralShape<readonly ["type", "lint", "runtime"]>; reason: import("@orkestrel/contract").StringShape; }, false>` | Describes the negative control, which is a case plus where and why it must break. |
106
+ | `CLAIM_SHAPE` | const | `import("@orkestrel/contract").ObjectShape<{ project: import("@orkestrel/contract").StringShape; case: import("@orkestrel/contract").ObjectShape<{ files: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>>; test: import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>; }, false>; control: import("@orkestrel/contract").ObjectShape<{ files: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>>; test: import("@orkestrel/contract").ObjectShape<{ path: import("@orkestrel/contract").StringShape; text: import("@orkestrel/contract").StringShape; }, false>; stage: import("@orkestrel/contract").LiteralShape<readonly ["type", "lint", "runtime"]>; reason: import("@orkestrel/contract").StringShape; }, false>; }, false>` | Describes one claim and is the sole source of both the published tool schema and the guard applied to an arriving claim. |
107
107
 
108
108
  ### Validators
109
109
 
@@ -112,19 +112,19 @@ input and never throws.
112
112
 
113
113
  In a guard table a `Shape` cell holds the type the guard narrows to.
114
114
 
115
- | Name | Kind | Shape | Summary |
116
- | ------------- | ----- | ----------- | ----------------------------------------------------------------------------------------------- |
117
- | `isStage` | const | `Stage` | Checks whether a value names a stage. |
118
- | `isParty` | const | `Party` | Checks whether a value names a party an issue carries. |
119
- | `isDraft` | const | `Draft` | Checks whether a value carries a proposed file's path and text. |
120
- | `isCase` | const | `Case` | Checks whether a value carries a claim's candidate drafts and its test. |
121
- | `isControl` | const | `Control` | Checks whether a value carries a case plus the stage and reason it must fail for. |
122
- | `isClaim` | const | `Claim` | Checks whether a value carries a project, a case, and a control. |
123
- | `isIssue` | const | `Issue` | Checks whether a value carries one message, its location, and the origin of the fault it names. |
124
- | `isCheck` | const | `Check` | Checks whether a value carries one stage's outcome. |
125
- | `isToolchain` | const | `Toolchain` | Checks whether a value names every resolved tool version. |
126
- | `isProject` | const | `Project` | Checks whether a value names one resolved TypeScript project and what it contained. |
127
- | `isVerdict` | const | `Verdict` | Checks whether a value carries a complete verdict. |
115
+ | Name | Kind | Signature | Summary |
116
+ | ------------- | ----- | ------------------ | ----------------------------------------------------------------------------------------------- |
117
+ | `isStage` | const | `Guard<Stage>` | Checks whether a value names a stage. |
118
+ | `isParty` | const | `Guard<Party>` | Checks whether a value names a party an issue carries. |
119
+ | `isDraft` | const | `Guard<Draft>` | Checks whether a value carries a proposed file's path and text. |
120
+ | `isCase` | const | `Guard<Case>` | Checks whether a value carries a claim's candidate drafts and its test. |
121
+ | `isControl` | const | `Guard<Control>` | Checks whether a value carries a case plus the stage and reason it must fail for. |
122
+ | `isClaim` | const | `Guard<Claim>` | Checks whether a value carries a project, a case, and a control. |
123
+ | `isIssue` | const | `Guard<Issue>` | Checks whether a value carries one message, its location, and the origin of the fault it names. |
124
+ | `isCheck` | const | `Guard<Check>` | Checks whether a value carries one stage's outcome. |
125
+ | `isToolchain` | const | `Guard<Toolchain>` | Checks whether a value names every resolved tool version. |
126
+ | `isProject` | const | `Guard<Project>` | Checks whether a value names one resolved TypeScript project and what it contained. |
127
+ | `isVerdict` | const | `Guard<Verdict>` | Checks whether a value carries a complete verdict. |
128
128
 
129
129
  ### Formatters and the token
130
130
 
@@ -147,20 +147,20 @@ From [`types.ts`](../src/server/types.ts).
147
147
 
148
148
  A `Shape` cell holds an interface's data members as bare names in braces, `?` marking an optional member and `plus` introducing its call-signature members, and a type alias's own type literal with a union's arms escaped as `\|`. An extended interface's name comes before `plus`, with the members it adds after.
149
149
 
150
- | Name | Kind | Shape | Summary |
151
- | ---------------------- | --------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
152
- | `Inspection` | interface | `{ subject, claim }` | Carries one queued inspection: the case a stage reads and the claim it belongs to. |
153
- | `InspectionOptions` | interface | `{ signal }` | Carries the bound a caller holds over one stage inspection. |
154
- | `OverlayInterface` | interface | `{ revision, paths } plus set, text, covers, clear` | Holds the candidate drafts one inspection substitutes for the files a tool would read from disk. |
155
- | `StageInterface` | interface | `{ stage, progress } plus start, inspect, destroy` | Inspects one case with the workspace's own tool. |
156
- | `TypeStageInterface` | interface | `StageInterface plus inspect, resolve` | Inspects TypeScript source against a caller-named project and reports what that project is. |
157
- | `LintStageInterface` | interface | `StageInterface plus { exit } plus inspect` | Inspects one case under a bound the caller supplies. |
158
- | `WorkspaceManifest` | interface | `{ path, contents }` | Carries one parsed package manifest and the path it came from. |
159
- | `Diagnostic` | interface | `{ path?, range?, message }` | Carries one diagnostic line a compiler run reported, in this package's own coordinates. |
160
- | `ProjectConfig` | interface | `{ compilerOptions, files?, include? }` | Carries what one TypeScript project resolved to, as the compiler itself printed it. |
161
- | `Execution` | interface | `{ status?, stdout, stderr }` | Carries what one spawned workspace command reported when it closed. |
162
- | `ProbeServerInterface` | interface | `{} plus start, destroy` | Serves one probe over this process's Model Context Protocol stdio transport. |
163
- | `ListenerCapture` | type | `ReadonlyMap<string, readonly Function[]>` | Holds the listeners one emitter carried for a set of events at the moment it was captured. |
150
+ | Name | Kind | Signature | Summary |
151
+ | ---------------------- | --------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
152
+ | `Inspection` | interface | `{ subject, claim }` | Carries one queued inspection: the case a stage reads and the claim it belongs to. |
153
+ | `InspectionOptions` | interface | `{ signal }` | Carries the bound a caller holds over one stage inspection. |
154
+ | `OverlayInterface` | interface | `{ revision, paths, set(), text(), covers(), clear() }` | Holds the candidate drafts one inspection substitutes for the files a tool would read from disk. |
155
+ | `StageInterface` | interface | `{ stage, progress, start(), inspect(), destroy() }` | Inspects one case with the workspace's own tool. |
156
+ | `TypeStageInterface` | interface | `{ inspect(), resolve() }` | Inspects TypeScript source against a caller-named project and reports what that project is. |
157
+ | `LintStageInterface` | interface | `{ exit, inspect() }` | Inspects one case under a bound the caller supplies. |
158
+ | `WorkspaceManifest` | interface | `{ path, contents }` | Carries one parsed package manifest and the path it came from. |
159
+ | `Diagnostic` | interface | `{ path?, range?, message }` | Carries one diagnostic line a compiler run reported, in this package's own coordinates. |
160
+ | `ProjectConfig` | interface | `{ compilerOptions, files?, include? }` | Carries what one TypeScript project resolved to, as the compiler itself printed it. |
161
+ | `Execution` | interface | `{ status?, stdout, stderr }` | Carries what one spawned workspace command reported when it closed. |
162
+ | `ProbeServerInterface` | interface | `{ start(), destroy() }` | Serves one probe over this process's Model Context Protocol stdio transport. |
163
+ | `ListenerCapture` | type | `ReadonlyMap<string, readonly Function[]>` | Holds the listeners one emitter carried for a set of events at the moment it was captured. |
164
164
 
165
165
  `StageInterface.progress` is the seam a foreign coordinator reads to decide whose budget an expiry
166
166
  belongs to, and this is the proof behind it.
@@ -186,14 +186,14 @@ The classes, each exported from its own file, and the contract each one implemen
186
186
  [`RuntimeStage`](../src/server/stages/RuntimeStage.ts) implements `StageInterface`, and
187
187
  [`Overlay`](../src/server/Overlay.ts) implements `OverlayInterface`.
188
188
 
189
- | Name | Kind | Summary |
190
- | -------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
191
- | `Probe` | class | Answers claims through its type, lint, and runtime stages. |
192
- | `ProbeServer` | class | Implements `ProbeServerInterface` over a `PassThrough` stream this server owns, binding the published `prove` tool and the dual-era dispatcher to this process's Model Context Protocol stdio transport. Starting creates the probe and awaits its lint and runtime onset; type warming and the boot controls continue behind it. |
193
- | `TypeStage` | class | Inspects TypeScript source by running the target workspace's own compiler over a mirror of it. |
194
- | `LintStage` | class | Inspects virtual documents through one resident Oxlint language server. |
195
- | `RuntimeStage` | class | Inspects tests through one resident Vitest service from the target workspace. |
196
- | `Overlay` | class | Implements `OverlayInterface` over a private map from normalized absolute path to candidate text, minting at construction the `revision` a resident tool caches its answers against. |
189
+ | Name | Kind | Signature | Summary |
190
+ | -------------- | ----- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
191
+ | `Probe` | class | `new (options?: ProbeOptions) => ProbeInterface` | Answers claims through its type, lint, and runtime stages. |
192
+ | `ProbeServer` | class | `new (options?: ProbeOptions) => ProbeServerInterface` | Implements `ProbeServerInterface` over a `PassThrough` stream this server owns, binding the published `prove` tool and the dual-era dispatcher to this process's Model Context Protocol stdio transport. Starting creates the probe and awaits its lint and runtime onset; type warming and the boot controls continue behind it. |
193
+ | `TypeStage` | class | `new (workspace?: string) => TypeStageInterface` | Inspects TypeScript source by running the target workspace's own compiler over a mirror of it. |
194
+ | `LintStage` | class | `new (workspace?: string) => LintStageInterface` | Inspects virtual documents through one resident Oxlint language server. |
195
+ | `RuntimeStage` | class | `new (workspace?: string) => StageInterface` | Inspects tests through one resident Vitest service from the target workspace. |
196
+ | `Overlay` | class | `new () => OverlayInterface` | Implements `OverlayInterface` over a private map from normalized absolute path to candidate text, minting at construction the `revision` a resident tool caches its answers against. |
197
197
 
198
198
  Each stage takes one optional `workspace` argument and defaults to the working directory. A stage
199
199
  serves one inspection at a time and admits none itself, so drive stages through `Probe` unless you
@@ -245,7 +245,7 @@ Pure leaves and workspace readers, from [`helpers.ts`](../src/server/helpers.ts)
245
245
  | `relativeWorkspaceMessage` | function | `(workspace: string, message: string) => string` | Projects the paths one tool named in a message into the forms this package's issues expose. |
246
246
  | `scanDiagnostics` | function | `(text: string) => readonly Diagnostic[]` | Scans the plain-text output of one compiler run into the diagnostics it reported. |
247
247
  | `resolveWorkspaceModule` | function | `(workspace: string, specifier: string) => string` | Resolves one installed module from the target workspace. |
248
- | `loadWorkspaceVitest` | function | `(workspace: string) => typeof import('vitest/node')` | Loads the installed `vitest/node` module from a target workspace. |
248
+ | `loadWorkspaceVitest` | function | `(workspace: string) => typeof VitestNode` | Loads the installed `vitest/node` module from a target workspace. |
249
249
  | `readWorkspaceManifest` | function | `(workspace: string, name: string) => WorkspaceManifest` | Reads one installed package manifest from the target workspace. |
250
250
  | `resolveWorkspaceBinary` | function | `(workspace: string, name: string, command?: string) => string` | Resolves a package's portable JavaScript binary from the target workspace. |
251
251
  | `inferTypeProject` | function | `(path: string) => string` | Selects the scoped TypeScript project for one candidate draft path. |