@orkestrel/scaffold 0.0.134 → 0.0.136
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/agents/skills/orkestrel-parallel/scripts/lane.js +777 -83
- package/dist/agents/skills/orkestrel-publish/scripts/wave.js +327 -21
- package/dist/bin/main.js +254 -36
- package/dist/bin/main.js.map +1 -1
- package/dist/host/AGENTS.md +2 -2
- package/dist/host/agents/orchestration.md +2 -2
- package/dist/host/agents/skills/orkestrel-parallel/SKILL.md +1 -1
- package/dist/host/agents/skills/orkestrel-parallel/scripts/lane.ts +983 -123
- package/dist/host/agents/skills/orkestrel-publish/references/release.md +1 -0
- package/dist/host/agents/skills/orkestrel-publish/references/wave.md +22 -5
- package/dist/host/agents/skills/orkestrel-publish/scripts/wave.ts +403 -32
- package/dist/host/claude/agents/orkestrel.md +17 -17
- package/dist/host/claude/agents/reviewer.md +1 -1
- package/dist/host/claude/rules/architecture.md +1 -1
- package/dist/host/claude/rules/documentation.md +1 -1
- package/dist/host/claude/rules/patterns.md +4 -2
- package/dist/host/claude/rules/workspace.md +73 -67
- package/dist/host/configs/helpers.ts +109 -73
- package/dist/host/dotfiles/oxlintrc.json +1 -57
- package/dist/host/guides/agent.md +989 -395
- package/dist/host/guides/contract.md +198 -163
- package/dist/host/guides/database.md +978 -503
- package/dist/host/guides/indexeddb.md +80 -66
- package/dist/host/guides/middleware.md +5 -5
- package/dist/host/guides/ollama.md +41 -42
- package/dist/host/guides/relation.md +56 -32
- package/dist/host/guides/scaffold.md +185 -107
- package/dist/host/guides/sqlite.md +44 -23
- package/dist/host/guides/study.md +12 -12
- package/dist/host/guides/test.md +163 -47
- package/dist/host/guides/toolbox.md +127 -81
- package/dist/host/guides/workspace.md +21 -14
- package/dist/host/manifest.json +30 -30
- package/dist/host/scripts/browsers.sh +0 -0
- package/dist/host/scripts/codex.sh +0 -0
- package/dist/host/scripts/cursor.sh +0 -0
- package/dist/host/scripts/deps.sh +0 -0
- package/dist/host/scripts/npm.sh +0 -0
- package/dist/host/scripts/ollama.sh +0 -0
- package/dist/host/tests/config.test.ts +237 -115
- package/dist/src/core/index.cjs +591 -218
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +248 -29
- package/dist/src/core/index.d.ts +248 -29
- package/dist/src/core/index.js +581 -216
- package/dist/src/core/index.js.map +1 -1
- package/dist/src/server/index.cjs +18 -8
- package/dist/src/server/index.cjs.map +1 -1
- package/dist/src/server/index.d.cts +4 -3
- package/dist/src/server/index.d.ts +4 -3
- package/dist/src/server/index.js +19 -9
- package/dist/src/server/index.js.map +1 -1
- package/package.json +3 -3
|
@@ -82,39 +82,40 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
82
82
|
|
|
83
83
|
#### Interfaces
|
|
84
84
|
|
|
85
|
-
| Name | Kind | Signature
|
|
86
|
-
| ----------------------- | --------- |
|
|
87
|
-
| `AppDefinition` | interface | `{ configs, project, entry? }`
|
|
88
|
-
| `ArtifactBase` | interface | `{ path, group, ownership, environment? }`
|
|
89
|
-
| `ArtifactTemplateSet` | interface | `{ source, tests, docs, guides, orchestration }`
|
|
90
|
-
| `Audit` | interface | `{ findings, questions }`
|
|
91
|
-
| `Blueprint` | interface | `{ name, description?, keywords, src, app, extensions, styles, themes, dependencies, peers, extras, version, engines, overrides, bin,
|
|
92
|
-
| `BrowserExtension` | interface | `{ surface, name, axes }`
|
|
93
|
-
| `CompileFailure` | interface | `{ code, message }`
|
|
94
|
-
| `CompileRecord` | interface | `{ stage, input, output, failure? }`
|
|
95
|
-
| `CompilerInterface` | interface | `{ emitter, compile(), audit(), destroy() }`
|
|
96
|
-
| `CompilerOptions` | interface | `{ on?, error? }`
|
|
97
|
-
| `ConfigTemplateSet` | interface | `{ root, factories, tsconfigs, vites, browsers, commands }`
|
|
98
|
-
| `ContentArtifact` | interface | `{ origin, content, hex?, source? }`
|
|
99
|
-
| `Dependency` | interface | `{ name, range, optional? }`
|
|
100
|
-
| `DependencyPinSet` | interface | `{ runtime, development }`
|
|
101
|
-
| `FrameworkDefinition` | interface | `{ plugin, checker, suffixes, refused, dependencies }`
|
|
102
|
-
| `HostArtifact` | interface | `{ origin, ownership, source?, pointer?, hex?, content? }`
|
|
103
|
-
| `HydratedArtifact` | interface | `{ origin, ownership, source?, hex, content? }`
|
|
104
|
-
| `ManifestDependencySet` | interface | `{ runtime, development, peer }`
|
|
105
|
-
| `ManifestEdit` | interface | `{ start, end, text }`
|
|
106
|
-
| `
|
|
107
|
-
| `
|
|
108
|
-
| `
|
|
109
|
-
| `
|
|
110
|
-
| `
|
|
111
|
-
| `
|
|
112
|
-
| `
|
|
113
|
-
| `
|
|
114
|
-
| `
|
|
115
|
-
| `
|
|
116
|
-
| `
|
|
117
|
-
| `
|
|
85
|
+
| Name | Kind | Signature | Summary |
|
|
86
|
+
| ----------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
|
87
|
+
| `AppDefinition` | interface | `{ configs, project, entry? }` | Describes the configuration and runtime-entry settings one private `app` environment contributes. |
|
|
88
|
+
| `ArtifactBase` | interface | `{ path, group, ownership, environment? }` | Describes the fields every planned file carries. |
|
|
89
|
+
| `ArtifactTemplateSet` | interface | `{ source, tests, docs, guides, orchestration }` | Represents the source, test, document, guide, and service template text. |
|
|
90
|
+
| `Audit` | interface | `{ findings, questions }` | Represents the whole comparison of a plan against a target's current content. |
|
|
91
|
+
| `Blueprint` | interface | `{ name, description?, keywords, src, app, extensions, styles, themes, dependencies, peers, extras, version, engines, overrides, bin, setup, guides, integration, conformance, tree, service, vendors, studies, global, showcase, journey, base, skills }` | Represents the closed, JSON-serializable workspace specification. |
|
|
92
|
+
| `BrowserExtension` | interface | `{ surface, name, axes }` | Represents a browser framework and its physically occupied axes. |
|
|
93
|
+
| `CompileFailure` | interface | `{ code, message }` | Represents the coded reason one compile stage failed. |
|
|
94
|
+
| `CompileRecord` | interface | `{ stage, input, output, failure? }` | Holds the input and output snapshot of one compile stage. |
|
|
95
|
+
| `CompilerInterface` | interface | `{ emitter, compile(), audit(), destroy() }` | Describes the compilation contract: pure, synchronous, and host-independent. |
|
|
96
|
+
| `CompilerOptions` | interface | `{ on?, error? }` | Represents the options for the compiler. |
|
|
97
|
+
| `ConfigTemplateSet` | interface | `{ root, factories, tsconfigs, vites, browsers, commands }` | Represents the configuration template text, grouped by the artifact each template builds. |
|
|
98
|
+
| `ContentArtifact` | interface | `{ origin, content, hex?, source? }` | Represents a text file produced by the template or computed compilation path. |
|
|
99
|
+
| `Dependency` | interface | `{ name, range, optional? }` | Represents one runtime `@orkestrel/*` dependency of a generated workspace. |
|
|
100
|
+
| `DependencyPinSet` | interface | `{ runtime, development }` | Describes the runtime and development sections a range-writing operation may change. |
|
|
101
|
+
| `FrameworkDefinition` | interface | `{ plugin, checker, suffixes, refused, dependencies }` | Describes the tooling and package boundaries a browser framework contributes. |
|
|
102
|
+
| `HostArtifact` | interface | `{ origin, ownership, source?, pointer?, hex?, content? }` | Represents a file byte-copied from the vendored data root, planned before its bytes are read. |
|
|
103
|
+
| `HydratedArtifact` | interface | `{ origin, ownership, source?, hex, content? }` | Represents a vendored file whose exact bytes have been read, so its content can be compared. |
|
|
104
|
+
| `ManifestDependencySet` | interface | `{ runtime, development, peer }` | Describes the runtime, development, and peer sections read from an existing package manifest. |
|
|
105
|
+
| `ManifestEdit` | interface | `{ start, end, text }` | Represents one in-place replacement of manifest text. |
|
|
106
|
+
| `ManifestEntrySet` | interface | `{ bin, files, exports }` | Describes the `bin`, `files`, and `exports` entries a manifest carries. |
|
|
107
|
+
| `ManifestRegionSet` | interface | `{ pins, scripts, additions?, overrides?, entries? }` | Describes the manifest regions a writing operation may change. |
|
|
108
|
+
| `ManifestScript` | interface | `{ name, command, accepted }` | Represents one manifest script a region-writing operation may replace. |
|
|
109
|
+
| `ManifestToken` | interface | `{ text, index, depth, value }` | Represents one string or object brace found in manifest text. |
|
|
110
|
+
| `Override` | interface | `{ path, content }` | Represents one artifact override. |
|
|
111
|
+
| `Plan` | interface | `{ blueprint, groups, artifacts, hash? }` | Holds the compiled, ordered artifact list and the selection it covers. |
|
|
112
|
+
| `PlanSummary` | interface | `{ name, src, app, groups, host, template, computed }` | Represents the tally of one plan by artifact origin. |
|
|
113
|
+
| `Question` | interface | `{ field, message, blocking, candidates? }` | Represents one validation issue raised against a blueprint or a plan. |
|
|
114
|
+
| `CompileResult` | interface | `{ plan?, questions, stages }` | Represents the replayable outcome of one compile. |
|
|
115
|
+
| `SrcDefinition` | interface | `{ configs, project, path, formats }` | Describes the build and export settings one published `src` environment contributes. |
|
|
116
|
+
| `StylesExtension` | interface | `{ surface, name }` | Represents a named sheet face under `src/<name>`. |
|
|
117
|
+
| `ToolchainHold` | interface | `{ framework, range, reason }` | Represents one foreign tool range required by a browser framework. |
|
|
118
|
+
| `ViteMachinery` | interface | `{ browser, frameworks, output, showcase }` | Names which host-specific pipelines a generated root Vite configuration carries. |
|
|
118
119
|
|
|
119
120
|
| Name | Kind | Signature | Summary |
|
|
120
121
|
| ------------------- | --------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
@@ -141,7 +142,8 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
141
142
|
| `BARREL_CONFIGS` | const | `readonly string[]` | Lists the configuration file a workspace with studies and a server application adds, frozen. |
|
|
142
143
|
| `BASE_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Holds the baseline tooling versions, before framework holds apply. |
|
|
143
144
|
| `BIN_CONFIGS` | const | `readonly string[]` | Lists the configuration files a workspace that ships its own executable adds, frozen. |
|
|
144
|
-
| `BIN_ENTRY_PATH` | const | `"src/bin/main.ts"` | Names the executable entry
|
|
145
|
+
| `BIN_ENTRY_PATH` | const | `"src/bin/main.ts"` | Names the executable entry, the `main` module of `src/bin`. |
|
|
146
|
+
| `BIN_MODULE_PATTERN` | const | `RegExp` | Matches the stem of a `src/bin` module: lowercase letters and digits, letter first, no hyphen. |
|
|
145
147
|
| `BIN_OUTPUT_PATH` | const | `"dist/bin/main.js"` | Names the built executable a bin workspace's manifest command runs. |
|
|
146
148
|
| `BROWSE_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Names the development dependency a browser or styles surface adds. |
|
|
147
149
|
| `BROWSE_UPSTREAM` | const | `readonly string[]` | Lists the packages `@orkestrel/browser` depends on at runtime, directly or transitively, frozen. |
|
|
@@ -152,6 +154,7 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
152
154
|
| `CATALOG_AGENT_PATH` | const | `".claude/agents/orkestrel.md"` | Names the agent file whose marker-bounded package table the catalog verb alone owns. |
|
|
153
155
|
| `CATALOG_END_MARKER` | const | `"<!-- /orkestrel:catalog -->"` | Names the marker closing the package table inside `CATALOG_AGENT_PATH`. |
|
|
154
156
|
| `CATALOG_START_MARKER` | const | `"<!-- orkestrel:catalog -->"` | Names the marker opening the package table inside `CATALOG_AGENT_PATH`. |
|
|
157
|
+
| `CENTRAL_FILE_NAMES` | const | `readonly string[]` | Lists the stems of the centralized files the architecture kind table names, which no `src/bin` module takes, frozen. |
|
|
155
158
|
| `CONFIG_TEMPLATES` | const | `ConfigTemplateSet` | Holds formatter-stable template text for every configuration artifact. |
|
|
156
159
|
| `CONFORMANCE_TEST_PATH` | const | `"tests/conformance.test.ts"` | Names the official-tooling drift proof whose presence makes a workspace `conformance`. |
|
|
157
160
|
| `CONTROL_CHARACTER_PATTERN` | const | `RegExp` | Matches the Unicode controls, formatting controls, and line and paragraph separators rejected in text. |
|
|
@@ -177,6 +180,7 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
177
180
|
| `INTEGRATION_TEST_PATH` | const | `"tests/integration.test.ts"` | Names the cross-environment composition proof whose presence makes a workspace `integration`. |
|
|
178
181
|
| `INVALID_PATH_CHARACTER_PATTERN` | const | `RegExp` | Matches the visible characters a target-relative path and a Markdown path cell both forbid. |
|
|
179
182
|
| `JOURNEY_CONFIG_PATH` | const | `"configs/app/vite.journey.config.ts"` | Names the Vite wrapper whose presence makes a workspace `journey`. |
|
|
183
|
+
| `MANIFEST_KEY_ORDER` | const | `readonly string[]` | Lists the top-level manifest keys in the order a compiled manifest emits them. |
|
|
180
184
|
| `MANIFEST_PATH` | const | `"package.json"` | Names the manifest path every compiler plan emits with birth ownership. |
|
|
181
185
|
| `MAX_ARTIFACT_BYTES` | const | `5242880` | Caps the bytes accepted for one artifact. |
|
|
182
186
|
| `MAX_ARTIFACT_HEX_LENGTH` | const | `number` | Caps the length of the hexadecimal string carrying one artifact's bytes. |
|
|
@@ -200,9 +204,6 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
200
204
|
| `PRINT_WIDTH` | const | `100` | Caps the columns one emitted line may occupy, matching `printWidth` in `.oxfmtrc.json`. |
|
|
201
205
|
| `REFERENCE_PATHS` | const | `readonly string[]` | Lists the reference paths staged for offline reading, frozen. |
|
|
202
206
|
| `RELEASE_PROOF_COMMAND` | const | `"npm run test:distribution -- --mode release"` | Names the `prepublishOnly` row that runs the packed-package proof against a real registry. |
|
|
203
|
-
| `REPORTER_CONFIGS` | const | `readonly string[]` | Lists the configuration files a workspace that publishes a Vitest reporter adds, frozen. |
|
|
204
|
-
| `REPORTER_ENTRY_PATH` | const | `"src/reporter/main.ts"` | Names the reporter entry whose presence makes a workspace `reporter`. |
|
|
205
|
-
| `REPORTER_OUTPUT_PATH` | const | `"dist/reporter/main.js"` | Names the built reporter module a reporter workspace's `./reporter` export loads. |
|
|
206
207
|
| `RESERVED_SHEET_NAMES` | const | `readonly string[]` | Lists the names a styles extension cannot occupy, frozen. |
|
|
207
208
|
| `SEED_GUIDE_PATHS` | const | `readonly string[]` | Lists the guide paths a generated workspace starts with, frozen. |
|
|
208
209
|
| `SERVICE_SCRIPT_PATH` | const | `"scripts/service.sh"` | Names the inventory skeleton a workspace with declared service vendors is given once. |
|
|
@@ -234,36 +235,38 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
234
235
|
|
|
235
236
|
#### Guards
|
|
236
237
|
|
|
237
|
-
| Name | Kind | Signature
|
|
238
|
-
| -------------------- | -------- |
|
|
239
|
-
| `isArtifact` | const | `Guard<Artifact>`
|
|
240
|
-
| `isArtifactFinding` | const | `Guard<ArtifactFinding>`
|
|
241
|
-
| `isArtifactGroup` | const | `Guard<ArtifactGroup>`
|
|
242
|
-
| `isArtifactGroups` | const | `Guard<readonly ArtifactGroup[]>`
|
|
243
|
-
| `isAudit` | const | `Guard<Audit>`
|
|
244
|
-
| `isBlueprint` | const | `Guard<Blueprint>`
|
|
245
|
-
| `
|
|
246
|
-
| `
|
|
247
|
-
| `
|
|
248
|
-
| `
|
|
249
|
-
| `
|
|
250
|
-
| `
|
|
251
|
-
| `
|
|
252
|
-
| `
|
|
253
|
-
| `
|
|
254
|
-
| `
|
|
255
|
-
| `
|
|
256
|
-
| `
|
|
257
|
-
| `
|
|
258
|
-
| `
|
|
259
|
-
| `
|
|
260
|
-
| `
|
|
261
|
-
| `
|
|
262
|
-
| `
|
|
263
|
-
| `
|
|
264
|
-
| `
|
|
265
|
-
| `
|
|
266
|
-
| `
|
|
238
|
+
| Name | Kind | Signature | Summary |
|
|
239
|
+
| -------------------- | -------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
|
240
|
+
| `isArtifact` | const | `Guard<Artifact>` | Narrows a value to an `Artifact`. |
|
|
241
|
+
| `isArtifactFinding` | const | `Guard<ArtifactFinding>` | Narrows a value to an `ArtifactFinding`. |
|
|
242
|
+
| `isArtifactGroup` | const | `Guard<ArtifactGroup>` | Narrows a value to one `ArtifactGroup` a plan selects over. |
|
|
243
|
+
| `isArtifactGroups` | const | `Guard<readonly ArtifactGroup[]>` | Narrows a value to a bounded group selection. |
|
|
244
|
+
| `isAudit` | const | `Guard<Audit>` | Narrows a value to an `Audit`. |
|
|
245
|
+
| `isBlueprint` | const | `Guard<Blueprint>` | Narrows a value to a `Blueprint`. |
|
|
246
|
+
| `isBinModule` | function | `(value: unknown) => value is string` | Narrows a value to the stem of a `src/bin` module. |
|
|
247
|
+
| `isBrowserExtension` | const | `Guard<BrowserExtension>` | Narrows a value to a supported browser framework with distinct occupied axes. |
|
|
248
|
+
| `isCatalogEntry` | const | `Guard<CatalogEntry>` | Narrows a value to a `CatalogEntry`. |
|
|
249
|
+
| `isCollection` | function | `(value: unknown) => value is readonly unknown[]` | Narrows a value to an array within the limit one public collection accepts. |
|
|
250
|
+
| `isCompilerHooks` | const | `Guard<EmitterHooks<CompilerEventMap>>` | Narrows a value to the compiler's initial listener record. |
|
|
251
|
+
| `isCompilerOptions` | const | `Guard<CompilerOptions>` | Narrows a value to `CompilerOptions`. |
|
|
252
|
+
| `isContent` | const | `Guard<string>` | Narrows a value to text this package will accept as one artifact's content. |
|
|
253
|
+
| `isDependency` | const | `Guard<Dependency>` | Narrows a value to a `Dependency`. |
|
|
254
|
+
| `isDependencyName` | const | `Guard<string>` | Narrows a value to the scoped package name a runtime dependency carries. |
|
|
255
|
+
| `isEnvironment` | const | `Guard<Environment>` | Narrows a value to one `Environment` a workspace may select. |
|
|
256
|
+
| `isExtension` | const | `Guard<Extension>` | Narrows a value to an extension of a supported surface. |
|
|
257
|
+
| `isHexContent` | const | `Guard<string>` | Narrows a value to exact lowercase hexadecimal bytes within one artifact's limit. |
|
|
258
|
+
| `isManifestScript` | const | `Guard<ManifestScript>` | Narrows a value to a `ManifestScript`. |
|
|
259
|
+
| `isMirror` | const | `Guard<Mirror>` | Narrows a value to a `Mirror`. |
|
|
260
|
+
| `isOverride` | const | `Guard<Override>` | Narrows a value to an `Override`. |
|
|
261
|
+
| `isPath` | function | `(value: unknown) => value is string` | Narrows a value to a logical target-relative path. |
|
|
262
|
+
| `isPlan` | const | `Guard<Plan>` | Narrows a value to a `Plan`. |
|
|
263
|
+
| `isQuestion` | const | `Guard<Question>` | Narrows a value to a `Question`. |
|
|
264
|
+
| `isScaffoldError` | function | `(value: unknown) => value is ScaffoldError` | Narrows a caught value to a `ScaffoldError`. |
|
|
265
|
+
| `isSheetName` | function | `(value: unknown) => value is string` | Narrows a value to a non-reserved sheet face name. |
|
|
266
|
+
| `isSnapshot` | function | `(value: unknown) => value is Snapshot` | Narrows a value to a `Snapshot`. |
|
|
267
|
+
| `isStylesExtension` | const | `Guard<StylesExtension>` | Narrows a value to a named non-reserved stylesheet face. |
|
|
268
|
+
| `isSubpathMap` | function | `(value: unknown) => value is Readonly<Record<string, unknown>>` | Narrows a manifest `exports` value to a map of subpaths. |
|
|
269
|
+
| `isSurface` | const | `Guard<Surface>` | Narrows a value to a surface an extension can extend. |
|
|
267
270
|
|
|
268
271
|
#### Parsers
|
|
269
272
|
|
|
@@ -298,16 +301,20 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
298
301
|
| `isRetainedPath` | function | `(path: string) => boolean` | Checks whether another surface owns a target's present bytes at a path. |
|
|
299
302
|
| `iterateAnswers` | function | `<TValue, TAnswer>(source: Iterable<TValue>, answer: (value: TValue) => TAnswer \| undefined) => Generator<TAnswer \| undefined, void, undefined>` | Yields the answer to each value of a source and ends after the first refused answer. |
|
|
300
303
|
| `manifestToDependencies` | function | `(manifest: string) => ManifestDependencySet` | Projects a package manifest's text to the `@orkestrel/*` packages each dependency section declares. |
|
|
304
|
+
| `manifestToEntries` | function | `(manifest: string, planned: ManifestEntrySet) => ManifestEntrySet` | Projects a package manifest's text to the planned `bin`, `files`, and `exports` entries it lacks. |
|
|
301
305
|
| `manifestToName` | function | `(manifest: string) => string \| undefined` | Projects a package manifest's text to its own name. |
|
|
302
306
|
| `matchesArtifactDriftReachability` | function | `(ownership: Ownership, finding: ArtifactFinding) => boolean` | Tests whether `inferArtifactDrift` could have produced a finding for an ownership. |
|
|
303
307
|
| `matchesBarrel` | function | `(blueprint: Blueprint) => boolean` | Tests whether a workspace plans the application server barrel build. |
|
|
304
308
|
| `matchesEngines` | function | `(engines: string) => boolean` | Tests whether a declared engines floor is at or above the supported minimum. |
|
|
305
309
|
| `matchesOrchestrationPath` | function | `(path: string) => boolean` | Tests whether a path instructs or wires an agent rather than the toolchain. |
|
|
310
|
+
| `matchesPackedPath` | function | `(declared: string, planned: string) => boolean` | Checks whether a declared `files` entry packs a planned one. |
|
|
306
311
|
| `matchesPrintWidth` | function | `(line: string) => boolean` | Tests whether one emitted line fits the vendored formatter width. |
|
|
307
312
|
| `matchesRange` | function | `(range: string, latest: string) => boolean` | Tests whether a declared range already admits a published version. |
|
|
308
313
|
| `nameToGuide` | function | `(name: string) => string` | Derives the guide mirror path a package name answers for. |
|
|
314
|
+
| `normalizePackagePath` | function | `(path: string) => string` | Returns the canonical form of a path a manifest names inside its package. |
|
|
309
315
|
| `parseOwnedJSONValue` | function | `(value: unknown) => JSONValue \| undefined` | Snapshots an untrusted value into exact JSON data the caller owns. |
|
|
310
316
|
| `planToSummary` | function | `(plan: Plan) => PlanSummary` | Projects a plan into its tally by artifact origin. |
|
|
317
|
+
| `projectsToBenches` | function | `(projects: readonly string[]) => readonly string[]` | Lists the bench globs of the browser-hosted projects among a workspace's project labels. |
|
|
311
318
|
| `renderSkillPointer` | function | `(canonical: string, name: string) => string \| undefined` | Renders the `SKILL.md` pointer a target carries in place of a canonical skill. |
|
|
312
319
|
| `scanManifestTokens` | function | `(text: string) => readonly ManifestToken[] \| undefined` | Scans manifest text for its strings and object braces, in order. |
|
|
313
320
|
| `selectArtifactGroups` | function | `(groups?: readonly ArtifactGroup[]) => readonly ArtifactGroup[]` | Selects the groups a compile covers, in plan order. |
|
|
@@ -335,7 +342,8 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
335
342
|
| `blueprintToDevDependencies` | function | `(blueprint: Blueprint) => Readonly<Record<string, string>>` | Projects a blueprint into the development dependencies its manifest declares. |
|
|
336
343
|
| `blueprintToToolchainHolds` | function | `(blueprint: Blueprint) => Readonly<Record<string, ToolchainHold>>` | Projects a blueprint into the toolchain holds its browser frameworks require. |
|
|
337
344
|
| `blueprintToDocumentArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles the generated workspace's root documentation. |
|
|
338
|
-
| `
|
|
345
|
+
| `blueprintToEntries` | function | `(blueprint: Blueprint) => ManifestEntrySet` | Projects a blueprint into the `bin`, `files`, and `exports` entries its manifest carries. |
|
|
346
|
+
| `blueprintToExports` | function | `(blueprint: Blueprint) => Readonly<Record<string, unknown>>` | Projects published environments, sheets, and `src/bin` modules into the manifest export map. |
|
|
339
347
|
| `blueprintToFaces` | function | `(blueprint: Blueprint) => readonly BrowserExtension[]` | Projects a blueprint into browser extensions restricted to occupied browser axes. |
|
|
340
348
|
| `blueprintToGuideArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles the generated workspace's guide index. |
|
|
341
349
|
| `blueprintToHostArtifacts` | function | `(blueprint: Blueprint) => readonly Artifact[]` | Compiles the vendored host artifacts a workspace plans. |
|
|
@@ -355,6 +363,7 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
355
363
|
| `blueprintToWritableScripts` | function | `(blueprint: Blueprint) => readonly ManifestScript[]` | Projects a blueprint into the manifest scripts a region write may replace. |
|
|
356
364
|
| `dependenciesToQuestions` | function | `(dependencies: readonly Dependency[], field: string, name: RegExp, range: RegExp) => readonly Question[]` | Measures one declared package list against the name and range syntax it accepts. |
|
|
357
365
|
| `insertManifestDependencies` | function | `(manifest: string, additions: DependencyPinSet) => string \| undefined` | Inserts dependencies a package manifest does not declare into the section each one names. |
|
|
366
|
+
| `insertManifestEntries` | function | `(manifest: string, planned: ManifestEntrySet) => string \| undefined` | Inserts the planned `bin`, `files`, and `exports` entries a package manifest lacks. |
|
|
358
367
|
| `insertManifestSection` | function | `(manifest: string, section: 'dependencies' \| 'devDependencies', dependencies: readonly Dependency[], present: boolean) => string \| undefined` | Inserts dependencies into one section of package manifest text. |
|
|
359
368
|
| `overridesToQuestions` | function | `(overrides: readonly Override[], artifacts: readonly Artifact[]) => readonly Question[]` | Measures a blueprint's overrides against the artifacts drafted for it. |
|
|
360
369
|
| `pathToCondition` | function | `(path: string, formats: readonly BuildFormat[]) => Readonly<Record<string, unknown>>` | Builds one `exports` condition block for a built environment. |
|
|
@@ -701,20 +710,44 @@ answers a read and grant no verb write authority that it did not already have.
|
|
|
701
710
|
|
|
702
711
|
`new --bin` creates the executable entry, its test, and its scoped Vite and TypeScript wrappers.
|
|
703
712
|
|
|
704
|
-
A
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
`
|
|
709
|
-
|
|
710
|
-
`
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
713
|
+
A `src/bin` module takes no creation option. Write it as a direct child `src/bin/<name>.ts` whose
|
|
714
|
+
name `BIN_MODULE_PATTERN` admits and `CENTRAL_FILE_NAMES` does not name, as an import from a library
|
|
715
|
+
environment through its `@src/*` alias followed by `export default` of the imported value, because
|
|
716
|
+
a host tool such as Vitest's `--reporter=<specifier>` loads the module's default export. The reading
|
|
717
|
+
verbs list every direct `.ts` file whose name opens with a lowercase letter and names no
|
|
718
|
+
centralized file in `bin`, and the gate refuses one `isBinModule` rejects, such as `my-tool`.
|
|
719
|
+
`main` stays the executable. Each module other than
|
|
720
|
+
`main` builds through `srcBin` and `configs/src/vite.bin.config.ts` to the ES-only
|
|
721
|
+
`dist/bin/<name>.js` with its rolled-up `dist/bin/<name>.d.ts`, and the manifest exports it as
|
|
722
|
+
`./<name>`. Only `main.js` carries the `#!/usr/bin/env node` banner, and only `main` plans the `bin`
|
|
723
|
+
command. Every module shares `check:src:bin`, `build:src:bin`, `test:src:bin`, and the `src:bin`
|
|
724
|
+
project over `tests/src/bin`. The build keeps every `@src/*` specifier external and rewrites it
|
|
725
|
+
through `output.paths` to the built `../src/<environment>/index.js`, and `rewriteSourceSpecifier`
|
|
726
|
+
writes the same path into each declaration. The vendored `.oxlintrc.json` admits a default export
|
|
727
|
+
in `src/bin/*.ts` and refuses a relative import of `src/core` or `src/server` from `src/bin`, which
|
|
728
|
+
would bundle a second copy of the environment. The distribution proof reads `dist/bin` as its own
|
|
729
|
+
face and reports a library source copied into it. The gate refuses a module whose `./<name>`
|
|
730
|
+
subpath another planned subpath takes, such as `src/bin/server.ts` beside `src/server`, and names
|
|
731
|
+
both. A consumer loads a module by its subpath, as `--reporter=@orkestrel/test/reporter` loads the
|
|
732
|
+
`reporter` module of `@orkestrel/test`.
|
|
733
|
+
|
|
734
|
+
When an existing workspace adds a `src/bin` module, `overwrite` writes every row its manifest
|
|
735
|
+
lacks: `exports["./<name>"]`, `dist/bin` in `files`, `check:src:bin`, `build:src:bin`, and
|
|
736
|
+
`test:src:bin`. It extends `test:src`, `check:src`, and `build:src` where each still holds a value
|
|
737
|
+
an earlier plan generated. `repair` writes the scripts and none of the entries. Before the write,
|
|
738
|
+
`audit` reports the missing entries in its `entries` question and the missing scripts in its
|
|
739
|
+
`scripts` question. Where the package owns `check:src` or `build:src`, the `scripts` question asks
|
|
740
|
+
you to invoke `npm run check:src:bin` from the `check:src` chain and `npm run build:src:bin` from
|
|
741
|
+
the `build:src` chain. Where the manifest declares no `check:src` or `build:src`, the question names
|
|
742
|
+
the script to add and the `check` or `build` chain that invokes it. Where the package owns
|
|
743
|
+
`test:src`, the `projects` question asks you to add `--project src:bin` to it, and `overwrite`
|
|
744
|
+
refuses the `configs` group with that same step named until a chain from `test` reaches the
|
|
745
|
+
project. `src/bin/main.ts` adds the `bin` command to the same rows. An executable reaches `dist/src` only through
|
|
746
|
+
the `@src/*` specifiers its build rewrites, one per library environment, so `dist/src` is packed
|
|
747
|
+
only where a library environment or a sheet builds into it, and an executable beside neither packs
|
|
748
|
+
`dist/bin` and no `dist/src`. An added library environment follows the
|
|
749
|
+
same rule: `overwrite` writes its subpath, `check:src:<environment>`, `build:src:<environment>`,
|
|
750
|
+
and `test:src:<environment>`, and extends the generated aggregates.
|
|
718
751
|
|
|
719
752
|
The `new --app browser` command selects the journey axis, creates its birth-owned wrapper,
|
|
720
753
|
defines `appJourney` in the root configuration, and excludes the browser integration suite from
|
|
@@ -896,7 +929,7 @@ and the declared `@orkestrel/*` packages come from `package.json`. The environme
|
|
|
896
929
|
the directories the target actually ships, because a directory is the fact and a declaration beside
|
|
897
930
|
it could disagree. The styles surface, its themes target, the showcase, and every extension are
|
|
898
931
|
read from the markers Surfaces and extensions lists. The remaining facts come from exact-case
|
|
899
|
-
files: `src/bin
|
|
932
|
+
files: each direct `src/bin` module adds its name to `bin`, each root `tests/setup*.test.ts` match selects `setup`,
|
|
900
933
|
`tests/guides.test.ts` selects `guides`, `tests/integration.test.ts` selects `integration`,
|
|
901
934
|
`tests/conformance.test.ts` selects `conformance`, `tests/tree.test.ts` selects `tree`,
|
|
902
935
|
`tests/setupService.ts` selects `service`,
|
|
@@ -994,8 +1027,13 @@ A selection that excludes `configs` proceeds. An advisory alone does not make an
|
|
|
994
1027
|
drift.
|
|
995
1028
|
|
|
996
1029
|
The probe workbench separates ordinary probes from benchmarks by filename. `test:probe` collects
|
|
997
|
-
`tmp/probes/**/*.test.ts`. `test:bench`
|
|
998
|
-
|
|
1030
|
+
`tmp/probes/**/*.test.ts`. `test:bench` runs with the explicit `--mode benchmark` option. Its Node
|
|
1031
|
+
`probe` project collects `tmp/probes/**/*.bench.ts` and `tests/**/*.bench.ts` other than the browser
|
|
1032
|
+
benches: the `*.bench.ts` files beneath the test directory of each planned face that runs in
|
|
1033
|
+
Playwright Chromium, which `projectsToBenches` lists. Those faces are `src:browser`, `app:browser`,
|
|
1034
|
+
`src:vue`, `app:vue`, each sheet face, and the themes target. In a workspace with one, its
|
|
1035
|
+
`bench:browser` project runs those browser benches in Playwright Chromium.
|
|
1036
|
+
Neither script belongs to a gate. In a benchmark file,
|
|
999
1037
|
register a regular `it` or `test` callback that receives the context's `bench` fixture. Await
|
|
1000
1038
|
`bench(name, options, fn).run()` or `bench.compare(...)`; options precede the benchmark function.
|
|
1001
1039
|
The filename keeps the benchmark out of ordinary test runs, so no mode guard is required. The
|
|
@@ -1009,6 +1047,8 @@ Scaffold writes one part of the manifest rather than advising on it: the writabl
|
|
|
1009
1047
|
`repair` and `overwrite` write every direct `test:<project>` script the blueprint computes,
|
|
1010
1048
|
`test:probe`, and `test:bench`. A publishing workspace also receives `test:distribution`, `prepack`,
|
|
1011
1049
|
and `prepublishOnly`. Each sheet face adds its `check:src:<face>` and `build:src:<face>` scripts.
|
|
1050
|
+
Each library environment adds its `check:src:<environment>` and `build:src:<environment>` scripts.
|
|
1051
|
+
The `src/bin` modules add `check:src:bin` and `build:src:bin`.
|
|
1012
1052
|
Each occupied framework face adds `check:<axis>:vue` and `build:<axis>:vue`; the application face also adds `dev:vue`.
|
|
1013
1053
|
Selected showcase pages add `showcase`, `showcase:<framework>`, `build:showcase`, and `build:showcase:<framework>`; application journeys add `test:journey:<framework>`.
|
|
1014
1054
|
A workspace that plans the application server barrel adds `build:app:barrel`, which has no
|
|
@@ -1020,12 +1060,13 @@ predecessor of the chain that builds themes after it. A publishing `test` chain
|
|
|
1020
1060
|
it matches byte for byte the planned chain with the generated `test:app`, `test:journey`, and framework
|
|
1021
1061
|
journey invocations inserted after `test:src`, where that blueprint emitted them before.
|
|
1022
1062
|
`repair` and `overwrite` remove those helper invocations from that exact predecessor.
|
|
1023
|
-
When the `test` or `build:app` chain is a generated
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1063
|
+
When the `test`, `test:src`, `check:src`, `build:src`, or `build:app` chain is a generated
|
|
1064
|
+
predecessor, which runs fewer steps or names fewer `--project` values than the planned chain and
|
|
1065
|
+
runs only planned steps and projects in the planned order, that chain joins the region and `repair`
|
|
1066
|
+
and `overwrite` write the planned chain in its place. That write lands only when every step the
|
|
1067
|
+
planned chain adds runs a Vitest command or a script the manifest declares or the region writes. An
|
|
1068
|
+
absent aggregate is never written, and `test:app` sits outside the region. Only a private
|
|
1069
|
+
workspace's planned chain invokes `test:app`. A chain whose planned form adds an
|
|
1029
1070
|
aggregate the manifest lacks stays with the package, and the `projects` question keeps its remedy.
|
|
1030
1071
|
`audit` reports this `test` chain write only through the `projects` question, so a planned step that
|
|
1031
1072
|
registers no Vitest project, such as `npm run test:guides`, lands on the next `repair` without an
|
|
@@ -1033,8 +1074,12 @@ earlier advisory. `audit` reports no `build:app` chain write, so `repair` rewrit
|
|
|
1033
1074
|
`build:app` with no earlier advisory after `build:app:barrel` is declared, and before then only the
|
|
1034
1075
|
`scripts` question's report of a missing `build:app:barrel` script precedes that write. A
|
|
1035
1076
|
package-owned `build:app` chain that omits the barrel step stays with the package, and the `scripts`
|
|
1036
|
-
question reports that no chain from `build` reaches `build:app:barrel`. A
|
|
1037
|
-
|
|
1077
|
+
question reports that no chain from `build` reaches `build:app:barrel`. A package-owned `check:src`
|
|
1078
|
+
or `build:src` chain that omits an entry's step stays with the package, and the `scripts` question
|
|
1079
|
+
reports each of `check:src:bin` and `build:src:bin`
|
|
1080
|
+
that no chain from `check` or `build` reaches. A package-owned `test:src` that omits an entry's
|
|
1081
|
+
project raises the `projects` question, which names `test:src` and the missing `--project` value.
|
|
1082
|
+
A chain the region lists running any other step or order stays maintainer-owned, as do the
|
|
1038
1083
|
`check`, `build`, `dev`, `serve`, `format`, `lint`, `clean`, and `copy` gate chains. A
|
|
1039
1084
|
declared value is overwritten only when it is already the value being written or is a recognized
|
|
1040
1085
|
generated predecessor. The overwrite happens in place,
|
|
@@ -1060,6 +1105,38 @@ reconcile the declared ranges and write the script region on every run, whatever
|
|
|
1060
1105
|
names. A run scoped to `manifest` for a script write takes the reconciled `@orkestrel/*`
|
|
1061
1106
|
ranges with it, and a run that excludes `manifest` still takes the ranges and the scripts.
|
|
1062
1107
|
|
|
1108
|
+
`overwrite` also inserts each planned `bin` command, `files` path, and `exports` subpath the
|
|
1109
|
+
manifest lacks, whatever `--groups` selects, and `repair` inserts none. The entries land in the
|
|
1110
|
+
offline half beside the dependency declarations, so a catalog step that cannot complete keeps them.
|
|
1111
|
+
An inserted entry lands before the first declared entry the plan orders after it and copies the
|
|
1112
|
+
section's indentation; an absent section is created before the first declared key the born
|
|
1113
|
+
manifest orders after it. A declared entry keeps its value whatever the plan holds, and each
|
|
1114
|
+
section reads a planned entry as declared by its own rule:
|
|
1115
|
+
|
|
1116
|
+
- A planned command is declared when `bin` names it, or when any declared command runs the planned
|
|
1117
|
+
file, so a package that publishes its executable under another name, such as `browse`, keeps
|
|
1118
|
+
that name. A string `bin` declares the planned command when it names the planned file. Both
|
|
1119
|
+
forms read a path as npm does: a backslash is a separator and a run of separators is one, so
|
|
1120
|
+
`dist\bin\main.js` and `dist//bin/main.js` name `dist/bin/main.js`.
|
|
1121
|
+
- A planned `files` path is declared when a declared path equals it or names a directory above it,
|
|
1122
|
+
compared by path segments, so `dist` packs `dist/app` and `dist-old` does not. A declared path
|
|
1123
|
+
ending in `/**` or `/*` names the directory before it, so `dist/**` packs `dist/app`. No other
|
|
1124
|
+
glob is read: `dist/*.js` declares no planned path it does not equal. A negated path is declared
|
|
1125
|
+
only by an equal entry.
|
|
1126
|
+
- A planned subpath is declared when the `exports` map names it. A string `exports`, a fallback
|
|
1127
|
+
array, or an object whose keys are conditions such as `import` and `require` publishes the root
|
|
1128
|
+
export alone, so it declares `.` and takes no other subpath: Node refuses an object that mixes
|
|
1129
|
+
conditions with subpaths.
|
|
1130
|
+
|
|
1131
|
+
A `bin` value that is not an object, an `exports` value that is not a map of subpaths, or a
|
|
1132
|
+
`files` value that is not an array of strings takes no entry. `audit` reports every missing entry
|
|
1133
|
+
in its non-blocking `entries` question, which names each entry with its JSON value and each section
|
|
1134
|
+
whose shape refuses it, with the shape that admits the entry. The human report of `overwrite`
|
|
1135
|
+
prints one `Inserted <entry> in package.json.` line per entry it wrote. When a workspace plans an
|
|
1136
|
+
executable and declares `"sideEffects": false`, `audit` adds a non-blocking `sideEffects` note
|
|
1137
|
+
that a bundler may drop the imports the executable runs only for their side effects, and names
|
|
1138
|
+
the value a born manifest carries. No verb changes the declared value.
|
|
1139
|
+
|
|
1063
1140
|
Before resolving overwrite's version ranges, the declaration step lifts each planned foreign tool
|
|
1064
1141
|
whose `devDependencies` major is earlier than the canon's to the blueprint's planned range,
|
|
1065
1142
|
including selected framework holds. An equal or later declared major stays, as does a disjunction
|
|
@@ -1250,7 +1327,7 @@ import { createBlueprint } from '@orkestrel/scaffold'
|
|
|
1250
1327
|
const blueprint = createBlueprint('router', {
|
|
1251
1328
|
src: ['core', 'server'],
|
|
1252
1329
|
dependencies: [{ name: '@orkestrel/emitter', range: '^0.0.5' }],
|
|
1253
|
-
bin:
|
|
1330
|
+
bin: ['main'],
|
|
1254
1331
|
})
|
|
1255
1332
|
|
|
1256
1333
|
blueprint.version // '0.0.1'
|
|
@@ -1264,7 +1341,7 @@ a fleet pin; every other peer is a floor. `extras` are development dependencies
|
|
|
1264
1341
|
valid npm name. A peer reaches the generated workspace through separate representations:
|
|
1265
1342
|
`Blueprint.peers` validates the scope rule and compiles the manifest declarations, while the
|
|
1266
1343
|
`peers` binding in the generated `vite.config.ts` derives from the target's live
|
|
1267
|
-
`peerDependencies`. Each published build face — core, browser, server,
|
|
1344
|
+
`peerDependencies`. Each published build face — core, browser, server, and `bin` — externalizes
|
|
1268
1345
|
every name in that binding, so a peer the workspace declares by hand, such as `vitest`, is left as
|
|
1269
1346
|
an import in the emitted bundle rather than inlined into it.
|
|
1270
1347
|
|
|
@@ -1295,7 +1372,7 @@ because the shape is chosen once and read afterwards: `new` refuses the advisory
|
|
|
1295
1372
|
`repair` need the plan to describe and restore a target that already has that shape. A library
|
|
1296
1373
|
caller creating a workspace holds the same refusal, and the Compile section states it.
|
|
1297
1374
|
|
|
1298
|
-
`bin`, `
|
|
1375
|
+
`bin`, `setup`, `guides`, `integration`, `conformance`, `tree`, `service`, `vendors`,
|
|
1299
1376
|
`studies`, `global`, `styles`, `themes`, `showcase`, `journey`, `base`, and `skills` are structural facts, and `extensions` lists the
|
|
1300
1377
|
extension faces. Reading verbs set each fact and list each extension only when the workspace
|
|
1301
1378
|
physically ships the directory or exact-case file that defines it, never because of the workspace's
|
|
@@ -1470,7 +1547,7 @@ workspace carries:
|
|
|
1470
1547
|
`BrowserExtension.axes` lists the axes a browser extension physically occupies, so a target holding
|
|
1471
1548
|
`app/vue` and no `src/vue` carries `axes: ['app']`. `FRAMEWORKS` holds `vue` alone. A
|
|
1472
1549
|
`StylesExtension` name passes `isSheetName`: it matches `NAME_PATTERN` and is none of the
|
|
1473
|
-
`RESERVED_SHEET_NAMES` values, which are `core`, `browser`, `server`, `bin`, `
|
|
1550
|
+
`RESERVED_SHEET_NAMES` values, which are `core`, `browser`, `server`, `bin`, `styles`,
|
|
1474
1551
|
`themes`, and `vue`.
|
|
1475
1552
|
|
|
1476
1553
|
`parseExtension` reads one `surface:name` entry, and `isSurface` decides whether its surface is
|
|
@@ -1622,8 +1699,8 @@ The `vue` extension gives each axis it occupies a face of its own:
|
|
|
1622
1699
|
`check` script typechecks the whole tree through `vue-tsc` in place of `tsc`.
|
|
1623
1700
|
|
|
1624
1701
|
The vendored `.oxlintrc.json` holds each face to the import direction `AGENTS.md` § Project model fixes, and
|
|
1625
|
-
refuses, from `src/browser`, `src/server`, `src/vue`,
|
|
1626
|
-
`src/core`, to `src/browser` from `src/vue`, or to `src/server` from `src/bin`
|
|
1702
|
+
refuses, from `src/browser`, `src/server`, `src/vue`, and `src/bin`, a relative path to
|
|
1703
|
+
`src/core`, to `src/browser` from `src/vue`, or to `src/server` from `src/bin` with a message naming the alias, because a face's
|
|
1627
1704
|
build bundles what a relative path reaches. The vendored
|
|
1628
1705
|
`tests/config.test.ts` drives those directions through Oxlint.
|
|
1629
1706
|
|
|
@@ -1911,7 +1988,7 @@ bytes.
|
|
|
1911
1988
|
You own `tests/setup.ts`, the selected `tests/setupBrowser.ts`, `tests/setupServer.ts`,
|
|
1912
1989
|
`tests/setupService.ts`, `tests/setupStyles.ts`, and `tests/setupGlobal.ts` modules, each root
|
|
1913
1990
|
`tests/setup*.test.ts` proof, the selected environment and sheet-face entry tests under `tests/src`
|
|
1914
|
-
and `tests/app`, the `tests/src/bin/main.test.ts`
|
|
1991
|
+
and `tests/app`, the `tests/src/bin/main.test.ts` file, and the `tests/integration.test.ts` seed.
|
|
1915
1992
|
Every sheet face's seed under `src` is yours on the same terms. Scaffold writes those
|
|
1916
1993
|
planned files only during materialize and leaves later edits or deletions alone. You also own the
|
|
1917
1994
|
`tests/guides.test.ts`, `tests/conformance.test.ts`, `tests/tree.test.ts`, and
|
|
@@ -2624,10 +2701,10 @@ Nothing is fixed except the manifest.
|
|
|
2624
2701
|
`--ignore-scripts` to `npm pack` so a suite never re-runs the build it already gates.
|
|
2625
2702
|
- One template artifact per configuration file the selection needs: the root `tsconfig.json` and
|
|
2626
2703
|
`vite.config.ts`, plus a Vite config and a scoped TypeScript config per selected environment and
|
|
2627
|
-
for `bin`
|
|
2704
|
+
for `bin` when it lists a module. The root `tsconfig.json` maps the `@src` and `@app` aliases the selection
|
|
2628
2705
|
reaches, and beside them the workspace's own published specifiers — `@orkestrel/<name>` and one
|
|
2629
2706
|
`@orkestrel/<name>/<environment>` entry per environment subpath the `exports` map publishes —
|
|
2630
|
-
each to its source entry.
|
|
2707
|
+
each to its source entry. A `src/bin` module's subpath and each sheet subpath map no entry. Without them the workspace's own name resolves through that `exports` map to
|
|
2631
2708
|
`dist/`, and `npm run check` would wait on `npm run build`. Every subpath is written before the
|
|
2632
2709
|
bare specifier, because `vite.config.ts` derives its `alias` record from these entries in order and
|
|
2633
2710
|
a bare specifier also matches its own subpaths. An `app` environment publishes nothing and maps no
|
|
@@ -2764,11 +2841,12 @@ workspace installs, so a publishing workspace declares `@microsoft/api-extractor
|
|
|
2764
2841
|
compiler API of its own. The browser and server faces pass `rewriteCoreSpecifier`: the compiler
|
|
2765
2842
|
emits the `@src/core` specifier unrewritten and the extractor keeps it external, so the rewrite
|
|
2766
2843
|
replaces it with the workspace's own published name and a consumer of the packed face reaches core
|
|
2767
|
-
through the root export the tarball declares. The seeded `bin` config
|
|
2768
|
-
|
|
2769
|
-
|
|
2770
|
-
|
|
2771
|
-
|
|
2844
|
+
through the root export the tarball declares. The seeded `bin` config rolls up each module its
|
|
2845
|
+
`entries` list names, every `src/bin` module but `main`, because an executable ships no
|
|
2846
|
+
declarations. It passes `rewriteSourceSpecifier`, which replaces each `@src/<environment>` with
|
|
2847
|
+
`../src/<environment>/index.js`, so `dist/bin/<name>.d.ts` reads the environment's declarations at
|
|
2848
|
+
the path `dist/bin/<name>.js` imports. Each roll-up takes its entry's name, so a face ships
|
|
2849
|
+
`index.d.ts` and a `reporter` module ships `reporter.d.ts`.
|
|
2772
2850
|
|
|
2773
2851
|
`planToSummary` reports the tally rather than a number written down here:
|
|
2774
2852
|
|