@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
|
@@ -245,7 +245,6 @@ export declare interface ArtifactTemplateSet {
|
|
|
245
245
|
};
|
|
246
246
|
readonly entry: string;
|
|
247
247
|
readonly bin: string;
|
|
248
|
-
readonly reporter: string;
|
|
249
248
|
readonly distribution: {
|
|
250
249
|
readonly module: string;
|
|
251
250
|
readonly proof: string;
|
|
@@ -361,9 +360,12 @@ export declare const BASE_DEV_DEPENDENCIES: Readonly<Record<string, string>>;
|
|
|
361
360
|
/** Lists the configuration files a workspace that ships its own executable adds, frozen. */
|
|
362
361
|
export declare const BIN_CONFIGS: readonly string[];
|
|
363
362
|
|
|
364
|
-
/** Names the executable entry
|
|
363
|
+
/** Names the executable entry, the `main` module of `src/bin`. */
|
|
365
364
|
export declare const BIN_ENTRY_PATH = "src/bin/main.ts";
|
|
366
365
|
|
|
366
|
+
/** Matches the stem of a `src/bin` module: lowercase letters and digits, letter first, no hyphen. */
|
|
367
|
+
export declare const BIN_MODULE_PATTERN: RegExp;
|
|
368
|
+
|
|
367
369
|
/** Names the built executable a bin workspace's manifest command runs. */
|
|
368
370
|
export declare const BIN_OUTPUT_PATH = "dist/bin/main.js";
|
|
369
371
|
|
|
@@ -377,7 +379,7 @@ export declare const BIN_OUTPUT_PATH = "dist/bin/main.js";
|
|
|
377
379
|
* are runtime `@orkestrel/*` packages. A peer in the `@orkestrel` scope is a
|
|
378
380
|
* fleet pin; every other peer is a floor. `extras` are package-specific
|
|
379
381
|
* development dependencies and may carry any valid npm name.
|
|
380
|
-
* `bin`, `
|
|
382
|
+
* `bin`, `setup`, `guides`, `integration`, `conformance`, `tree`, `service`,
|
|
381
383
|
* `vendors`, `studies`, `global`, `showcase`, `journey`, `base`, `styles`, `themes`, and `skills` are structural facts: each is
|
|
382
384
|
* set only when the workspace physically ships the directory or exact-case file
|
|
383
385
|
* that defines it, never because of the workspace's name and never because a
|
|
@@ -387,6 +389,11 @@ export declare const BIN_OUTPUT_PATH = "dist/bin/main.js";
|
|
|
387
389
|
* `setup` lists the runtimes required by root setup proofs: `node` for generic
|
|
388
390
|
* and server proofs, and `browser` for `tests/setupBrowser.test.ts` and `tests/setupStyles.test.ts`.
|
|
389
391
|
* `journey` selects the birth-owned variant wrapper for a browser application.
|
|
392
|
+
* `bin` lists the stems of the direct `.ts` files of `src/bin`, sorted: each stem that opens with
|
|
393
|
+
* a lowercase letter and that {@link CENTRAL_FILE_NAMES} does not name. The gate refuses a stem
|
|
394
|
+
* {@link isBinModule} rejects. `main` is the
|
|
395
|
+
* executable the manifest's `bin` field runs, and every other module publishes the ES-only
|
|
396
|
+
* `./<name>` subpath with its declaration, for a host tool that loads the module by specifier.
|
|
390
397
|
* `skills` registers the `skills` Vitest project over the mirrored proofs of the skill
|
|
391
398
|
* scripts a workspace ships under each `.agents/skills/<skill>/scripts/` directory, and adds their
|
|
392
399
|
* scoped typecheck.
|
|
@@ -426,9 +433,7 @@ export declare interface Blueprint {
|
|
|
426
433
|
readonly version: string;
|
|
427
434
|
readonly engines: string;
|
|
428
435
|
readonly overrides: readonly Override[];
|
|
429
|
-
readonly bin:
|
|
430
|
-
/** Selects the exact-case `src/reporter/main.ts` entry of the published Vitest reporter. */
|
|
431
|
-
readonly reporter: boolean;
|
|
436
|
+
readonly bin: readonly string[];
|
|
432
437
|
readonly setup: readonly SetupRuntime[];
|
|
433
438
|
readonly guides: boolean;
|
|
434
439
|
readonly integration: boolean;
|
|
@@ -549,10 +554,34 @@ export declare function blueprintToDevDependencies(blueprint: Blueprint): Readon
|
|
|
549
554
|
export declare function blueprintToDocumentArtifacts(blueprint: Blueprint): readonly ContentArtifact[];
|
|
550
555
|
|
|
551
556
|
/**
|
|
552
|
-
* Projects
|
|
557
|
+
* Projects a blueprint into the `bin`, `files`, and `exports` entries its manifest carries.
|
|
558
|
+
*
|
|
559
|
+
* @param blueprint - The workspace specification.
|
|
560
|
+
* @returns The planned commands, packed paths, and subpaths, each in the order the manifest emits.
|
|
561
|
+
*
|
|
562
|
+
* @remarks
|
|
563
|
+
* A workspace without an executable plans no command, and one publishing nothing plans no
|
|
564
|
+
* subpath, because its manifest carries no `exports` map. `dist/src` is packed only where a
|
|
565
|
+
* library environment or a sheet builds into it: an executable reaches `dist/src` only through
|
|
566
|
+
* the `@src/*` specifiers its build rewrites, one per library environment, so an executable
|
|
567
|
+
* beside no library environment bundles what it imports and packs `dist/bin` alone. A workspace
|
|
568
|
+
* publishing nothing packs `dist/app` when it builds an application.
|
|
569
|
+
*
|
|
570
|
+
* @example
|
|
571
|
+
* ```ts
|
|
572
|
+
* import { blueprintToEntries, createBlueprint } from '@orkestrel/scaffold'
|
|
573
|
+
*
|
|
574
|
+
* blueprintToEntries(createBlueprint('router', { src: ['core'], bin: ['main'] })).files
|
|
575
|
+
* // ['dist/src', 'dist/bin', 'README.md']
|
|
576
|
+
* ```
|
|
577
|
+
*/
|
|
578
|
+
export declare function blueprintToEntries(blueprint: Blueprint): ManifestEntrySet;
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Projects published environments, sheets, and `src/bin` modules into the manifest export map.
|
|
553
582
|
* @param blueprint - The workspace specification.
|
|
554
|
-
* @returns JavaScript conditions, CSS and SCSS subpaths, and the ES-only
|
|
555
|
-
* without an invented JavaScript root.
|
|
583
|
+
* @returns JavaScript conditions, CSS and SCSS subpaths, and the ES-only `./<name>` subpath of
|
|
584
|
+
* each `src/bin` module other than `main`, without an invented JavaScript root.
|
|
556
585
|
* @example
|
|
557
586
|
* ```ts
|
|
558
587
|
* import { blueprintToExports, createBlueprint } from '@orkestrel/scaffold'
|
|
@@ -773,8 +802,8 @@ export declare function blueprintToOrchestrationArtifacts(blueprint: Blueprint):
|
|
|
773
802
|
* Projects a blueprint into the project labels its root Vitest configuration registers.
|
|
774
803
|
*
|
|
775
804
|
* @param blueprint - The workspace specification.
|
|
776
|
-
* @returns Project labels in registration order, including wrapper-registered sheet faces
|
|
777
|
-
* the probe benchmark variant.
|
|
805
|
+
* @returns Project labels in registration order, including wrapper-registered sheet faces,
|
|
806
|
+
* the probe benchmark variant, and, beside a browser-hosted face, the browser bench project.
|
|
778
807
|
*
|
|
779
808
|
* @example
|
|
780
809
|
* ```ts
|
|
@@ -1027,7 +1056,8 @@ export declare function blueprintToToolchainHolds(blueprint: Blueprint): Readonl
|
|
|
1027
1056
|
* benchmark workbench scripts. A workspace carrying guides adds `test:guides`,
|
|
1028
1057
|
* whose package-owned entry runs the guides project and handles explicit parity
|
|
1029
1058
|
* rewrites, and one carrying skills adds `test:skills`. Publishing adds the pack and publication
|
|
1030
|
-
* lifecycle scripts.
|
|
1059
|
+
* lifecycle scripts. Library environments, sheet faces, framework faces, and `src/bin` modules
|
|
1060
|
+
* add their check and build scripts, application
|
|
1031
1061
|
* frameworks add dev scripts, and selected showcases and journeys add their mode scripts.
|
|
1032
1062
|
* A base browser application's journey axis also adds `journey` and `capture`, and each
|
|
1033
1063
|
* app-side browser face adds `journey:<name>` and `capture:<name>`. Their generated
|
|
@@ -1040,10 +1070,11 @@ export declare function blueprintToToolchainHolds(blueprint: Blueprint): Readonl
|
|
|
1040
1070
|
*
|
|
1041
1071
|
* `accepted` carries each generated predecessor the region can replace. The
|
|
1042
1072
|
* guides entry accepts the generated command that invoked the guides project
|
|
1043
|
-
* through Vitest alone. The benchmark entry accepts the
|
|
1073
|
+
* through Vitest alone. The benchmark entry accepts the command that ran the
|
|
1044
1074
|
* `probe` project through `vitest bench`, before the dedicated bench project
|
|
1045
|
-
* existed
|
|
1046
|
-
*
|
|
1075
|
+
* existed, and the command planned for the other state of the browser bench project, so
|
|
1076
|
+
* the entry follows a browser-hosted face that arrives or leaves. The pack hook accepts the
|
|
1077
|
+
* build chain emitted before it delegated to `build`. The publication hook accepts the same gate chain without
|
|
1047
1078
|
* {@link RELEASE_PROOF_COMMAND}. No accepted publication chain carries a study
|
|
1048
1079
|
* step. `serve:build` accepts the server-only chain it ran before it delegated to `build`.
|
|
1049
1080
|
* The value being written is always writable, so it is not repeated there. Any other value is a
|
|
@@ -1056,7 +1087,7 @@ export declare function blueprintToToolchainHolds(blueprint: Blueprint): Readonl
|
|
|
1056
1087
|
*
|
|
1057
1088
|
* const blueprint = createBlueprint('router', { src: ['core'] })
|
|
1058
1089
|
*
|
|
1059
|
-
* blueprintToWritableScripts(blueprint)[0]?.name // '
|
|
1090
|
+
* blueprintToWritableScripts(blueprint)[0]?.name // 'check:src:core'
|
|
1060
1091
|
* ```
|
|
1061
1092
|
*/
|
|
1062
1093
|
export declare function blueprintToWritableScripts(blueprint: Blueprint): readonly ManifestScript[];
|
|
@@ -1310,6 +1341,9 @@ export declare type CatalogEntry = {
|
|
|
1310
1341
|
*/
|
|
1311
1342
|
export declare function catalogToLayers(entries: readonly CatalogEntry[]): ReadonlyArray<readonly string[]>;
|
|
1312
1343
|
|
|
1344
|
+
/** Lists the stems of the centralized files the architecture kind table names, which no `src/bin` module takes, frozen. */
|
|
1345
|
+
export declare const CENTRAL_FILE_NAMES: readonly string[];
|
|
1346
|
+
|
|
1313
1347
|
/**
|
|
1314
1348
|
* Collects the near names and equal contracts other owners claim beside each name a candidate adds.
|
|
1315
1349
|
*
|
|
@@ -1738,7 +1772,6 @@ export declare class Compiler implements CompilerInterface {
|
|
|
1738
1772
|
readonly browser: string;
|
|
1739
1773
|
readonly server: string;
|
|
1740
1774
|
readonly bin: string;
|
|
1741
|
-
readonly reporter: string;
|
|
1742
1775
|
};
|
|
1743
1776
|
readonly app: {
|
|
1744
1777
|
readonly core: string;
|
|
@@ -1761,6 +1794,7 @@ export declare class Compiler implements CompilerInterface {
|
|
|
1761
1794
|
readonly studies: string;
|
|
1762
1795
|
readonly distribution: string;
|
|
1763
1796
|
readonly probe: string;
|
|
1797
|
+
readonly bench: string;
|
|
1764
1798
|
readonly integration: {
|
|
1765
1799
|
readonly sheet: string;
|
|
1766
1800
|
readonly module: string;
|
|
@@ -1783,7 +1817,6 @@ export declare class Compiler implements CompilerInterface {
|
|
|
1783
1817
|
readonly server: string;
|
|
1784
1818
|
};
|
|
1785
1819
|
readonly bin: string;
|
|
1786
|
-
readonly reporter: string;
|
|
1787
1820
|
readonly skills: string;
|
|
1788
1821
|
};
|
|
1789
1822
|
readonly vites: {
|
|
@@ -1795,7 +1828,6 @@ export declare class Compiler implements CompilerInterface {
|
|
|
1795
1828
|
readonly server: string;
|
|
1796
1829
|
};
|
|
1797
1830
|
readonly bin: string;
|
|
1798
|
-
readonly reporter: string;
|
|
1799
1831
|
readonly app: {
|
|
1800
1832
|
readonly vue: string;
|
|
1801
1833
|
readonly browser: string;
|
|
@@ -1883,7 +1915,7 @@ export declare class Compiler implements CompilerInterface {
|
|
|
1883
1915
|
* const blueprint = createBlueprint('router', {
|
|
1884
1916
|
* src: ['core', 'server'],
|
|
1885
1917
|
* dependencies: [{ name: '@orkestrel/emitter', range: '^0.0.5' }],
|
|
1886
|
-
* bin:
|
|
1918
|
+
* bin: ['main'],
|
|
1887
1919
|
* })
|
|
1888
1920
|
*
|
|
1889
1921
|
* blueprint.version // '0.0.1'
|
|
@@ -2333,6 +2365,38 @@ export declare class Compiler implements CompilerInterface {
|
|
|
2333
2365
|
*/
|
|
2334
2366
|
export declare function insertManifestDependencies(manifest: string, additions: DependencyPinSet): string | undefined;
|
|
2335
2367
|
|
|
2368
|
+
/**
|
|
2369
|
+
* Inserts the planned `bin`, `files`, and `exports` entries a package manifest lacks.
|
|
2370
|
+
*
|
|
2371
|
+
* @param manifest - The manifest text to compile.
|
|
2372
|
+
* @param planned - The entries the plan emits, each in planned order.
|
|
2373
|
+
* @returns The manifest declaring every planned entry, or `undefined` when the text is not a
|
|
2374
|
+
* manifest object, or a section that must take an entry holds a value of another shape: `bin` not
|
|
2375
|
+
* an object, `exports` not a map of subpaths, or `files` not an array of strings.
|
|
2376
|
+
*
|
|
2377
|
+
* @remarks
|
|
2378
|
+
* The compiler inserts text instead of serializing the manifest, so every declared byte survives,
|
|
2379
|
+
* and a declared entry keeps its value whatever the plan holds. An inserted entry lands before the
|
|
2380
|
+
* first declared entry the plan orders after it, or after the last declared entry when none does,
|
|
2381
|
+
* and copies the indentation of the section's first entry; a nested value takes the same step per
|
|
2382
|
+
* level. An absent section is created as one top-level key holding the planned entries, before the
|
|
2383
|
+
* first declared key `MANIFEST_KEY_ORDER` orders after it, or last in the manifest object. A
|
|
2384
|
+
* manifest declaring every planned entry is returned unchanged.
|
|
2385
|
+
*
|
|
2386
|
+
* @example
|
|
2387
|
+
* ```ts
|
|
2388
|
+
* import { insertManifestEntries } from '@orkestrel/scaffold'
|
|
2389
|
+
*
|
|
2390
|
+
* insertManifestEntries('{\n\t"files": [\n\t\t"dist/src",\n\t\t"README.md"\n\t]\n}\n', {
|
|
2391
|
+
* bin: {},
|
|
2392
|
+
* files: ['dist/src', 'dist/bin', 'README.md'],
|
|
2393
|
+
* exports: {},
|
|
2394
|
+
* })
|
|
2395
|
+
* // '{\n\t"files": [\n\t\t"dist/src",\n\t\t"dist/bin",\n\t\t"README.md"\n\t]\n}\n'
|
|
2396
|
+
* ```
|
|
2397
|
+
*/
|
|
2398
|
+
export declare function insertManifestEntries(manifest: string, planned: ManifestEntrySet): string | undefined;
|
|
2399
|
+
|
|
2336
2400
|
/**
|
|
2337
2401
|
* Inserts dependencies into one section of package manifest text.
|
|
2338
2402
|
*
|
|
@@ -2430,6 +2494,21 @@ export declare class Compiler implements CompilerInterface {
|
|
|
2430
2494
|
*/
|
|
2431
2495
|
export declare const isAudit: Guard<Audit>;
|
|
2432
2496
|
|
|
2497
|
+
/**
|
|
2498
|
+
* Narrows a value to the stem of a `src/bin` module.
|
|
2499
|
+
* @param value - The candidate stem.
|
|
2500
|
+
* @returns True if the stem matches `BIN_MODULE_PATTERN` within the name length cap and names no
|
|
2501
|
+
* centralized file; false otherwise.
|
|
2502
|
+
* @example
|
|
2503
|
+
* ```ts
|
|
2504
|
+
* import { isBinModule } from '@orkestrel/scaffold'
|
|
2505
|
+
*
|
|
2506
|
+
* isBinModule('reporter') // true
|
|
2507
|
+
* isBinModule('helpers') // false
|
|
2508
|
+
* ```
|
|
2509
|
+
*/
|
|
2510
|
+
export declare function isBinModule(value: unknown): value is string;
|
|
2511
|
+
|
|
2433
2512
|
/**
|
|
2434
2513
|
* Narrows a value to a {@link Blueprint}.
|
|
2435
2514
|
*
|
|
@@ -2872,6 +2951,28 @@ export declare class Compiler implements CompilerInterface {
|
|
|
2872
2951
|
*/
|
|
2873
2952
|
export declare const isStylesExtension: Guard<StylesExtension>;
|
|
2874
2953
|
|
|
2954
|
+
/**
|
|
2955
|
+
* Narrows a manifest `exports` value to a map of subpaths.
|
|
2956
|
+
*
|
|
2957
|
+
* @param value - The declared `exports` value.
|
|
2958
|
+
* @returns True if the value is an object whose every key opens with `.`; false otherwise.
|
|
2959
|
+
*
|
|
2960
|
+
* @remarks
|
|
2961
|
+
* Node reads a string, an array, or an object whose keys are conditions, such as `import` and
|
|
2962
|
+
* `require`, as the root export alone, and refuses an object that mixes conditions with subpaths,
|
|
2963
|
+
* so a subpath can be added only to a subpath map. A value whose keys cannot be read answers
|
|
2964
|
+
* `false`.
|
|
2965
|
+
*
|
|
2966
|
+
* @example
|
|
2967
|
+
* ```ts
|
|
2968
|
+
* import { isSubpathMap } from '@orkestrel/scaffold'
|
|
2969
|
+
*
|
|
2970
|
+
* isSubpathMap({ '.': './index.js' }) // true
|
|
2971
|
+
* isSubpathMap({ import: './index.js' }) // false
|
|
2972
|
+
* ```
|
|
2973
|
+
*/
|
|
2974
|
+
export declare function isSubpathMap(value: unknown): value is Readonly<Record<string, unknown>>;
|
|
2975
|
+
|
|
2875
2976
|
/**
|
|
2876
2977
|
* Narrows a value to a surface an extension can extend.
|
|
2877
2978
|
* @param value - The candidate surface.
|
|
@@ -2934,6 +3035,16 @@ export declare class Compiler implements CompilerInterface {
|
|
|
2934
3035
|
*/
|
|
2935
3036
|
export declare type Lookup = 'found' | 'missing' | 'unmatched' | 'failed';
|
|
2936
3037
|
|
|
3038
|
+
/**
|
|
3039
|
+
* Lists the top-level manifest keys in the order a compiled manifest emits them.
|
|
3040
|
+
*
|
|
3041
|
+
* @remarks
|
|
3042
|
+
* An entry write that creates an absent `bin`, `files`, or `exports` key places it before the
|
|
3043
|
+
* first declared key this list orders after it, so a created key lands where a born manifest
|
|
3044
|
+
* carries it.
|
|
3045
|
+
*/
|
|
3046
|
+
export declare const MANIFEST_KEY_ORDER: readonly string[];
|
|
3047
|
+
|
|
2937
3048
|
/** Names the manifest path every compiler plan emits with birth ownership. */
|
|
2938
3049
|
export declare const MANIFEST_PATH = "package.json";
|
|
2939
3050
|
|
|
@@ -2958,6 +3069,20 @@ export declare class Compiler implements CompilerInterface {
|
|
|
2958
3069
|
readonly text: string;
|
|
2959
3070
|
}
|
|
2960
3071
|
|
|
3072
|
+
/**
|
|
3073
|
+
* Describes the `bin`, `files`, and `exports` entries a manifest carries.
|
|
3074
|
+
*
|
|
3075
|
+
* @remarks
|
|
3076
|
+
* `bin` maps each command name to the file it runs, `files` lists the packed paths, and
|
|
3077
|
+
* `exports` maps each subpath to its target or condition block. Each list keeps the order the
|
|
3078
|
+
* plan emits, and an entry write reads that order to place an inserted entry.
|
|
3079
|
+
*/
|
|
3080
|
+
export declare interface ManifestEntrySet {
|
|
3081
|
+
readonly bin: Readonly<Record<string, string>>;
|
|
3082
|
+
readonly files: readonly string[];
|
|
3083
|
+
readonly exports: Readonly<Record<string, unknown>>;
|
|
3084
|
+
}
|
|
3085
|
+
|
|
2961
3086
|
/**
|
|
2962
3087
|
* Describes the manifest regions a writing operation may change.
|
|
2963
3088
|
*
|
|
@@ -2971,12 +3096,15 @@ export declare class Compiler implements CompilerInterface {
|
|
|
2971
3096
|
* `overrides` names npm selector maps whose string leaves are replaced or inserted.
|
|
2972
3097
|
* Malformed ancestors and duplicate selected keys refuse the write. This metadata
|
|
2973
3098
|
* is independent of the artifact replacements carried by `Blueprint.overrides`.
|
|
3099
|
+
* `entries` names the planned `bin`, `files`, and `exports` entries, and the writer inserts each
|
|
3100
|
+
* one the manifest lacks. Absent, nothing is inserted.
|
|
2974
3101
|
*/
|
|
2975
3102
|
export declare interface ManifestRegionSet {
|
|
2976
3103
|
readonly pins: DependencyPinSet;
|
|
2977
3104
|
readonly scripts: readonly ManifestScript[];
|
|
2978
3105
|
readonly additions?: DependencyPinSet;
|
|
2979
3106
|
readonly overrides?: Readonly<Record<string, Readonly<Record<string, string>>>>;
|
|
3107
|
+
readonly entries?: ManifestEntrySet;
|
|
2980
3108
|
}
|
|
2981
3109
|
|
|
2982
3110
|
/**
|
|
@@ -3022,6 +3150,37 @@ export declare class Compiler implements CompilerInterface {
|
|
|
3022
3150
|
*/
|
|
3023
3151
|
export declare function manifestToDependencies(manifest: string): ManifestDependencySet;
|
|
3024
3152
|
|
|
3153
|
+
/**
|
|
3154
|
+
* Projects a package manifest's text to the planned `bin`, `files`, and `exports` entries it lacks.
|
|
3155
|
+
*
|
|
3156
|
+
* @param manifest - The `package.json` text.
|
|
3157
|
+
* @param planned - The entries the plan emits.
|
|
3158
|
+
* @returns The planned entries the manifest does not declare, each in planned order.
|
|
3159
|
+
*
|
|
3160
|
+
* @remarks
|
|
3161
|
+
* A planned command counts as declared when the manifest names it, or when any declared command
|
|
3162
|
+
* runs the planned file: a package keeps the command name it publishes. A string `bin` declares
|
|
3163
|
+
* the planned command when it names the planned file. A planned packed path counts as declared
|
|
3164
|
+
* when a declared path equals it or names a directory above it, as {@link matchesPackedPath} reads
|
|
3165
|
+
* the pair. A subpath counts as declared by name alone, so a declared entry holding another value
|
|
3166
|
+
* stays the package's. A string `exports`, a fallback array, or an object whose keys are conditions
|
|
3167
|
+
* rather than subpaths declares the root subpath `.` alone, as Node reads each. A section holding any other shape declares none of
|
|
3168
|
+
* its planned entries. A manifest that is not an object lacks nothing, because no entry can be read
|
|
3169
|
+
* from it or written into it.
|
|
3170
|
+
*
|
|
3171
|
+
* @example
|
|
3172
|
+
* ```ts
|
|
3173
|
+
* import { manifestToEntries } from '@orkestrel/scaffold'
|
|
3174
|
+
*
|
|
3175
|
+
* manifestToEntries('{"files": ["dist/src"]}', {
|
|
3176
|
+
* bin: {},
|
|
3177
|
+
* files: ['dist/src', 'dist/bin'],
|
|
3178
|
+
* exports: {},
|
|
3179
|
+
* }).files // ['dist/bin']
|
|
3180
|
+
* ```
|
|
3181
|
+
*/
|
|
3182
|
+
export declare function manifestToEntries(manifest: string, planned: ManifestEntrySet): ManifestEntrySet;
|
|
3183
|
+
|
|
3025
3184
|
/**
|
|
3026
3185
|
* Represents one string or object brace found in manifest text.
|
|
3027
3186
|
*
|
|
@@ -3176,6 +3335,30 @@ export declare class Compiler implements CompilerInterface {
|
|
|
3176
3335
|
*/
|
|
3177
3336
|
export declare function matchesOrchestrationPath(path: string): boolean;
|
|
3178
3337
|
|
|
3338
|
+
/**
|
|
3339
|
+
* Checks whether a declared `files` entry packs a planned one.
|
|
3340
|
+
*
|
|
3341
|
+
* @param declared - The entry the manifest declares.
|
|
3342
|
+
* @param planned - The entry the plan emits.
|
|
3343
|
+
* @returns True if the entries are equal, or the declared entry names a directory whose path
|
|
3344
|
+
* segments open the planned entry's; false otherwise.
|
|
3345
|
+
*
|
|
3346
|
+
* @remarks
|
|
3347
|
+
* A declared entry ending in `/**` or `/*` packs the directory it names, so `dist/**` packs
|
|
3348
|
+
* `dist/app`. No other glob is read: an entry such as `dist/*.js` packs no planned path it does not
|
|
3349
|
+
* equal. A negated entry such as `!dist/src/styles/index.js` excludes a path rather than packing
|
|
3350
|
+
* one, so only an equal entry declares it.
|
|
3351
|
+
*
|
|
3352
|
+
* @example
|
|
3353
|
+
* ```ts
|
|
3354
|
+
* import { matchesPackedPath } from '@orkestrel/scaffold'
|
|
3355
|
+
*
|
|
3356
|
+
* matchesPackedPath('dist', 'dist/app') // true
|
|
3357
|
+
* matchesPackedPath('dist-old', 'dist/app') // false
|
|
3358
|
+
* ```
|
|
3359
|
+
*/
|
|
3360
|
+
export declare function matchesPackedPath(declared: string, planned: string): boolean;
|
|
3361
|
+
|
|
3179
3362
|
/**
|
|
3180
3363
|
* Tests whether one emitted line fits the vendored formatter width.
|
|
3181
3364
|
*
|
|
@@ -3386,6 +3569,27 @@ export declare class Compiler implements CompilerInterface {
|
|
|
3386
3569
|
*/
|
|
3387
3570
|
export declare function nameToGuide(name: string): string;
|
|
3388
3571
|
|
|
3572
|
+
/**
|
|
3573
|
+
* Returns the canonical form of a path a manifest names inside its package.
|
|
3574
|
+
*
|
|
3575
|
+
* @param path - A `bin` target or a `files` entry.
|
|
3576
|
+
* @returns The path with `/` for every backslash, one `/` for every run of separators, and no
|
|
3577
|
+
* leading `./` or trailing `/`.
|
|
3578
|
+
*
|
|
3579
|
+
* @remarks
|
|
3580
|
+
* npm reads a backslash in a `bin` or `files` path as a separator and collapses repeated
|
|
3581
|
+
* separators, so `dist\bin\main.js` and `dist//bin/main.js` name `dist/bin/main.js`.
|
|
3582
|
+
*
|
|
3583
|
+
* @example
|
|
3584
|
+
* ```ts
|
|
3585
|
+
* import { normalizePackagePath } from '@orkestrel/scaffold'
|
|
3586
|
+
*
|
|
3587
|
+
* normalizePackagePath('./dist/bin/main.js') // 'dist/bin/main.js'
|
|
3588
|
+
* normalizePackagePath('dist//bin/main.js') // 'dist/bin/main.js'
|
|
3589
|
+
* ```
|
|
3590
|
+
*/
|
|
3591
|
+
export declare function normalizePackagePath(path: string): string;
|
|
3592
|
+
|
|
3389
3593
|
/**
|
|
3390
3594
|
* Lists the exact root paths that wire an agent bench or own an orchestration directory, frozen.
|
|
3391
3595
|
*
|
|
@@ -3759,6 +3963,30 @@ export declare class Compiler implements CompilerInterface {
|
|
|
3759
3963
|
/** Caps the columns one emitted line may occupy, matching `printWidth` in `.oxfmtrc.json`. */
|
|
3760
3964
|
export declare const PRINT_WIDTH = 100;
|
|
3761
3965
|
|
|
3966
|
+
/**
|
|
3967
|
+
* Lists the bench globs of the browser-hosted projects among a workspace's project labels.
|
|
3968
|
+
*
|
|
3969
|
+
* @param projects - The project labels, in registration order.
|
|
3970
|
+
* @returns One glob per browser-hosted label, matching every `*.bench.ts` file beneath that
|
|
3971
|
+
* label's directory under `tests/<axis>/`, in label order.
|
|
3972
|
+
*
|
|
3973
|
+
* @remarks
|
|
3974
|
+
* A label on the `src` or `app` axis names a project that runs in Playwright Chromium unless it
|
|
3975
|
+
* names `core`, `server`, or `bin`, which run in Node. The `src:themes` target collects
|
|
3976
|
+
* `tests/src/styles/themes`. Every other label sits on neither axis and adds no glob.
|
|
3977
|
+
*
|
|
3978
|
+
* @example
|
|
3979
|
+
* ```ts
|
|
3980
|
+
* import { projectsToBenches } from '@orkestrel/scaffold'
|
|
3981
|
+
*
|
|
3982
|
+
* const benches = projectsToBenches(['src:core', 'src:browser', 'app:vue', 'policy'])
|
|
3983
|
+
*
|
|
3984
|
+
* benches.length // 2
|
|
3985
|
+
* benches[1]?.startsWith('tests/app/vue/') // true
|
|
3986
|
+
* ```
|
|
3987
|
+
*/
|
|
3988
|
+
export declare function projectsToBenches(projects: readonly string[]): readonly string[];
|
|
3989
|
+
|
|
3762
3990
|
/**
|
|
3763
3991
|
* Represents one validation issue raised against a blueprint or a plan.
|
|
3764
3992
|
*
|
|
@@ -3980,15 +4208,6 @@ export declare class Compiler implements CompilerInterface {
|
|
|
3980
4208
|
*/
|
|
3981
4209
|
export declare function replacePlanRanges(plan: Plan, pins: DependencyPinSet): Plan | undefined;
|
|
3982
4210
|
|
|
3983
|
-
/** Lists the configuration files a workspace that publishes a Vitest reporter adds, frozen. */
|
|
3984
|
-
export declare const REPORTER_CONFIGS: readonly string[];
|
|
3985
|
-
|
|
3986
|
-
/** Names the reporter entry whose presence makes a workspace `reporter`. */
|
|
3987
|
-
export declare const REPORTER_ENTRY_PATH = "src/reporter/main.ts";
|
|
3988
|
-
|
|
3989
|
-
/** Names the built reporter module a reporter workspace's `./reporter` export loads. */
|
|
3990
|
-
export declare const REPORTER_OUTPUT_PATH = "dist/reporter/main.js";
|
|
3991
|
-
|
|
3992
4211
|
/** Lists the names a styles extension cannot occupy, frozen. */
|
|
3993
4212
|
export declare const RESERVED_SHEET_NAMES: readonly string[];
|
|
3994
4213
|
|