@orkestrel/scaffold 0.0.132 → 0.0.134
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-dispatch/scripts/bench.js +61 -96
- package/dist/agents/skills/orkestrel-dispatch/scripts/brief.js +48 -76
- package/dist/agents/skills/orkestrel-dispatch/scripts/chain.js +27 -66
- package/dist/agents/skills/orkestrel-dispatch/scripts/cite.js +31 -64
- package/dist/agents/skills/orkestrel-dispatch/scripts/launch.js +43 -57
- package/dist/agents/skills/orkestrel-dispatch/scripts/login.js +43 -86
- package/dist/agents/skills/orkestrel-dispatch/scripts/patch.js +68 -104
- package/dist/agents/skills/orkestrel-dispatch/scripts/result.js +35 -69
- package/dist/agents/skills/orkestrel-dispatch/scripts/sweep.js +47 -84
- package/dist/agents/skills/orkestrel-falsify/scripts/mutate.js +134 -116
- package/dist/agents/skills/orkestrel-harden/scripts/discovery.js +38 -90
- package/dist/agents/skills/orkestrel-harden/scripts/interleave.js +39 -103
- package/dist/agents/skills/orkestrel-harden/scripts/measure.js +40 -89
- package/dist/agents/skills/orkestrel-harden/scripts/titles.js +41 -87
- package/dist/agents/skills/orkestrel-parallel/scripts/cases.js +43 -88
- package/dist/agents/skills/orkestrel-parallel/scripts/lane.js +1018 -194
- package/dist/agents/skills/orkestrel-publish/scripts/compare.js +40 -60
- package/dist/agents/skills/orkestrel-publish/scripts/pins.js +47 -81
- package/dist/agents/skills/orkestrel-publish/scripts/steps.js +66 -104
- package/dist/agents/skills/orkestrel-publish/scripts/swap.js +74 -88
- package/dist/agents/skills/orkestrel-publish/scripts/wave.js +95 -108
- package/dist/agents/skills/orkestrel-publish/scripts/window.js +55 -96
- package/dist/agents/skills/orkestrel-scout/scripts/map.js +54 -101
- package/dist/bin/main.js +30 -6
- package/dist/bin/main.js.map +1 -1
- package/dist/host/agents/orchestration.md +1 -0
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/bench.ts +81 -97
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/brief.ts +64 -72
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/chain.ts +41 -63
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/cite.ts +56 -79
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/launch.ts +61 -74
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/login.ts +59 -89
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/patch.ts +87 -106
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/result.ts +57 -76
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/sweep.ts +73 -88
- package/dist/host/agents/skills/orkestrel-falsify/SKILL.md +2 -2
- package/dist/host/agents/skills/orkestrel-falsify/scripts/mutate.ts +167 -119
- package/dist/host/agents/skills/orkestrel-harden/references/methods.md +1 -1
- package/dist/host/agents/skills/orkestrel-harden/scripts/discovery.ts +58 -75
- package/dist/host/agents/skills/orkestrel-harden/scripts/interleave.ts +55 -99
- package/dist/host/agents/skills/orkestrel-harden/scripts/measure.ts +59 -90
- package/dist/host/agents/skills/orkestrel-harden/scripts/titles.ts +60 -80
- package/dist/host/agents/skills/orkestrel-parallel/SKILL.md +4 -4
- package/dist/host/agents/skills/orkestrel-parallel/scripts/cases.ts +71 -108
- package/dist/host/agents/skills/orkestrel-parallel/scripts/lane.ts +1288 -239
- package/dist/host/agents/skills/orkestrel-publish/references/wave.md +10 -6
- package/dist/host/agents/skills/orkestrel-publish/scripts/compare.ts +58 -79
- package/dist/host/agents/skills/orkestrel-publish/scripts/pins.ts +66 -87
- package/dist/host/agents/skills/orkestrel-publish/scripts/steps.ts +84 -102
- package/dist/host/agents/skills/orkestrel-publish/scripts/swap.ts +92 -99
- package/dist/host/agents/skills/orkestrel-publish/scripts/wave.ts +130 -126
- package/dist/host/agents/skills/orkestrel-publish/scripts/window.ts +82 -120
- package/dist/host/agents/skills/orkestrel-scout/SKILL.md +3 -3
- package/dist/host/agents/skills/orkestrel-scout/scripts/map.ts +85 -112
- package/dist/host/claude/agents/orkestrel.md +54 -54
- package/dist/host/claude/rules/documentation.md +1 -1
- package/dist/host/claude/rules/patterns.md +5 -4
- package/dist/host/claude/rules/styles.md +1 -1
- package/dist/host/claude/rules/tests.md +8 -3
- package/dist/host/claude/rules/workspace.md +47 -35
- package/dist/host/configs/helpers.ts +40 -15
- package/dist/host/dotfiles/oxlintrc.json +62 -0
- package/dist/host/guides/browser.md +1 -1
- package/dist/host/guides/form.md +79 -4
- package/dist/host/guides/queue.md +3 -1
- package/dist/host/guides/scaffold.md +95 -67
- package/dist/host/guides/table.md +20 -6
- package/dist/host/guides/test.md +342 -202
- package/dist/host/guides/workflow.md +4 -2
- package/dist/host/manifest.json +48 -48
- package/dist/host/tests/config.test.ts +201 -11
- package/dist/host/tests/policy.test.ts +15 -22
- package/dist/host/tests/setupPolicy.ts +43 -36
- package/dist/src/core/index.cjs +194 -97
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +27 -13
- package/dist/src/core/index.d.ts +27 -13
- package/dist/src/core/index.js +192 -97
- package/dist/src/core/index.js.map +1 -1
- package/dist/src/server/index.cjs +8 -9
- package/dist/src/server/index.cjs.map +1 -1
- package/dist/src/server/index.d.cts +1 -1
- package/dist/src/server/index.d.ts +1 -1
- package/dist/src/server/index.js +8 -9
- package/dist/src/server/index.js.map +1 -1
- package/package.json +5 -5
|
@@ -88,6 +88,12 @@
|
|
|
88
88
|
"import/no-default-export": "off"
|
|
89
89
|
}
|
|
90
90
|
},
|
|
91
|
+
{
|
|
92
|
+
"files": ["src/reporter/main.ts"],
|
|
93
|
+
"rules": {
|
|
94
|
+
"import/no-default-export": "off"
|
|
95
|
+
}
|
|
96
|
+
},
|
|
91
97
|
{
|
|
92
98
|
"files": [".agents/skills/*/scripts/*.ts"],
|
|
93
99
|
"rules": {
|
|
@@ -773,6 +779,62 @@
|
|
|
773
779
|
]
|
|
774
780
|
}
|
|
775
781
|
},
|
|
782
|
+
{
|
|
783
|
+
"files": ["src/reporter/**/*.{cjs,cts,js,jsx,mjs,mts,ts,tsx}"],
|
|
784
|
+
"rules": {
|
|
785
|
+
"no-restricted-imports": [
|
|
786
|
+
"error",
|
|
787
|
+
{
|
|
788
|
+
"patterns": [
|
|
789
|
+
{
|
|
790
|
+
"regex": "^(?:/|[A-Za-z]:[\\\\/])",
|
|
791
|
+
"message": "imports must not use machine-specific absolute paths"
|
|
792
|
+
},
|
|
793
|
+
{
|
|
794
|
+
"regex": "^(?:[A-Za-mo-z][A-Za-z0-9+.-]*|n(?:[A-Za-np-z0-9+.-][A-Za-z0-9+.-]*)?|no(?:[A-Za-ce-z0-9+.-][A-Za-z0-9+.-]*)?|nod(?:[A-Za-df-z0-9+.-][A-Za-z0-9+.-]*)?|node[A-Za-z0-9+.-]+):",
|
|
795
|
+
"message": "imports must not use non-Node URL schemes"
|
|
796
|
+
},
|
|
797
|
+
{
|
|
798
|
+
"regex": "(?:^|/)(?:[^/.][^/]*|\\.[^/.][^/]*|\\.\\.[^/]+)/\\.{1,2}(?:/|$)",
|
|
799
|
+
"message": "internal import paths must not contain noncanonical dot segments"
|
|
800
|
+
},
|
|
801
|
+
{
|
|
802
|
+
"regex": "^(?:(?:\\./)+\\.\\.(?:/|$)|(?:\\.\\./)+(?:\\./)+)|//",
|
|
803
|
+
"message": "relative import paths must not contain normalized traversal segments"
|
|
804
|
+
},
|
|
805
|
+
{
|
|
806
|
+
"regex": "\\\\",
|
|
807
|
+
"message": "import paths must use portable forward slashes"
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"regex": "^typescript(?:[/?#]|$)",
|
|
811
|
+
"message": "the in-process compiler API is not a surface the fleet uses"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"regex": "\\.(?:css|less|sass|scss|styl|stylus|pcss|postcss|sss)(?:[?#]|$)",
|
|
815
|
+
"message": "src/reporter must not import browser stylesheets"
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"regex": "^(?:@app(?:[/?#]|$)|(?:\\.\\./)+app(?:[/?#]|$))",
|
|
819
|
+
"message": "src/reporter must not depend on private app modules"
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"regex": "^(?:(?:vue|vite)(?:[/?#]|$)|@(?:vue|vitejs)/|@src/(?:browser|vue)(?:[/?#]|$)|@orkestrel/[^/]+/(?:browser|vue)(?:[/?#]|$)|(?:\\.\\./)+(?:browser|vue|src/(?:browser|vue)|app/browser)(?:[/?#]|$))",
|
|
823
|
+
"message": "src/reporter must not depend on browser-only modules"
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"regex": "^(?:\\.\\./)+(?:src/)?core(?:[/?#]|$)",
|
|
827
|
+
"message": "src/reporter must import src/core through the @src/core alias"
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"regex": "^(?:\\.\\./)+(?:src/)?server(?:[/?#]|$)",
|
|
831
|
+
"message": "src/reporter must import src/server through the @src/server alias"
|
|
832
|
+
}
|
|
833
|
+
]
|
|
834
|
+
}
|
|
835
|
+
]
|
|
836
|
+
}
|
|
837
|
+
},
|
|
776
838
|
{
|
|
777
839
|
"files": [
|
|
778
840
|
"tests/**/*.{cjs,cts,js,jsx,mjs,mts,ts,tsx,vue}",
|
|
@@ -273,7 +273,7 @@ The core supplies the entities a browser session and an agent use. Its host-spec
|
|
|
273
273
|
| `BROWSER_DEFAULT_VIEWPORT_HEIGHT` | const | `720` | Sets the default viewport height, `720` pixels. |
|
|
274
274
|
| `BROWSER_DEFAULT_VIEWPORT_WIDTH` | const | `1280` | Sets the default viewport width, `1280` pixels. |
|
|
275
275
|
| `BROWSER_FRAME_WORLD_NAME` | const | `"__orkestrelBrowserFrame"` | Names the isolated world used for iframe evaluation, `'__orkestrelBrowserFrame'`. |
|
|
276
|
-
| `BROWSER_HAR_CREATOR` | const | `Readonly<{ name: "@orkestrel/browser"; version: "0.0.
|
|
276
|
+
| `BROWSER_HAR_CREATOR` | const | `Readonly<{ name: "@orkestrel/browser"; version: "0.0.33"; }>` | Names the tool identity embedded in HAR 1.2 documents. |
|
|
277
277
|
| `BROWSER_KEY_MODIFIERS` | const | `Readonly<Record<string, number>>` | Maps a canonical modifier name to its CDP Input modifier bit value. |
|
|
278
278
|
| `BROWSER_MOUSE_BUTTON_MASKS` | const | `Readonly<Record<BrowserMouseButton, number>>` | Maps each public mouse button to its CDP Input pressed-button bit value. |
|
|
279
279
|
| `BROWSER_NAVIGATION_REASONS` | const | `readonly BrowserNavigationReason[]` | Lists every CDP `Page.ClientNavigationReason` value a page accepts as a navigation's reason, as of Chromium 141; a page reads any other reason as undefined. |
|
package/dist/host/guides/form.md
CHANGED
|
@@ -229,7 +229,7 @@ The browser entry publishes the controlled native form and its host readers.
|
|
|
229
229
|
| `FormControl` | type | `HTMLInputElement \| HTMLSelectElement \| HTMLTextAreaElement` | Represents a native answer control admitted by the binding. |
|
|
230
230
|
| `FormBindingErrorCode` | type | `'CONTROL' \| 'PENDING' \| 'DOM'` | Names a native binding refusal. |
|
|
231
231
|
| `FormBindingEventMap` | type | `{ readonly render: readonly []; readonly write: readonly [control: FormControl]; readonly submit: readonly [submission: FormSubmission, submitter: HTMLElement \| undefined]; readonly error: readonly [error: unknown]; }` | Lists the native binding's notifications after their associated DOM effects. |
|
|
232
|
-
| `FormBindingOptions` | interface | `{ feedback?, summary?, presentations?, defer?, on?, error? }`
|
|
232
|
+
| `FormBindingOptions` | interface | `{ feedback?, summary?, presentations?, defer?, reveal?, on?, error? }` | Configures neutral feedback destinations and isolated event listeners. |
|
|
233
233
|
| `FormBindingInterface` | interface | `{ element, document, destroyed, emitter, read(), refresh(), destroy() }` | Declares a native form's borrowed document and synchronization lifecycle. |
|
|
234
234
|
| `FormBindingAttribute` | interface | `{ original, value }` | Records an attribute's authored value and the binding's last contribution. |
|
|
235
235
|
| `FormBindingValidity` | interface | `{ original, value }` | Records the binding's custom-validity contribution beside the authored message. |
|
|
@@ -239,6 +239,7 @@ The browser entry publishes the controlled native form and its host readers.
|
|
|
239
239
|
| `isFormBindingError` | function | `(value: unknown) => value is FormBindingError` | Checks whether a value is a native binding refusal. |
|
|
240
240
|
| `isFormControl` | function | `(value: unknown) => value is FormControl` | Checks whether a value is a native answer control. |
|
|
241
241
|
| `matchesFormControls` | function | `(field: FormField, controls: readonly FormControl[]) => boolean` | Checks a native control population against a field's declared value shape. |
|
|
242
|
+
| `matchesNativeNumber` | function | `(control: FormControl, value: FieldValue \| undefined) => boolean` | Checks whether a numeric control's own text already parses to the document's number. |
|
|
242
243
|
| `readNativeMessages` | function | `(control: FormControl, errors: readonly FieldError[]) => readonly string[]` | Reads native constraint messages not already reported by document rules. |
|
|
243
244
|
| `readFormControls` | function | `(field: FormField, controls: readonly FormControl[]) => FieldValue \| undefined` | Reads one compatible native population using the document's blank-to-absence semantics. |
|
|
244
245
|
|
|
@@ -261,6 +262,18 @@ readFormControls({ control: 'text', name: 'name' }, [input]) // 'Ada'
|
|
|
261
262
|
isFormBindingError(new FormBindingError('CONTROL', 'Duplicate controls')) // true
|
|
262
263
|
```
|
|
263
264
|
|
|
265
|
+
The projection keeps a number input's own text while it parses to the document's number.
|
|
266
|
+
|
|
267
|
+
```ts
|
|
268
|
+
import { matchesNativeNumber } from '@orkestrel/form/browser'
|
|
269
|
+
|
|
270
|
+
const price = document.createElement('input')
|
|
271
|
+
price.type = 'number'
|
|
272
|
+
price.value = '1.50'
|
|
273
|
+
matchesNativeNumber(price, 1.5) // true — the binding leaves '1.50' in place
|
|
274
|
+
matchesNativeNumber(price, 1.25) // false — the binding writes '1.25'
|
|
275
|
+
```
|
|
276
|
+
|
|
264
277
|
## Controls
|
|
265
278
|
|
|
266
279
|
Each control fixes both the options its field accepts and the `FieldValue` it holds. The `confirm`,
|
|
@@ -1254,6 +1267,18 @@ the failure lasts until that field is filled again or the form is cleared.
|
|
|
1254
1267
|
captured enabled fields to their submitted values or absence. It is what `dirty` measures against
|
|
1255
1268
|
and what `clear` returns to. Read `extractChanges(form.values, form.baseline)` for the changed names.
|
|
1256
1269
|
|
|
1270
|
+
An empty list and absence are equal in change extraction, in either direction. A list field that
|
|
1271
|
+
opens with no baseline answer and is read back empty therefore stays clean, so `dirty` stays false
|
|
1272
|
+
until an entry arrives. Every other answer, the empty string included, differs from absence.
|
|
1273
|
+
|
|
1274
|
+
```ts
|
|
1275
|
+
import { extractChanges } from '@orkestrel/form'
|
|
1276
|
+
|
|
1277
|
+
Array.from(extractChanges({ to: [] }, {})) // [] — an empty list matches an absent baseline
|
|
1278
|
+
Array.from(extractChanges({ to: ['ada@example.com'] }, {})) // ['to']
|
|
1279
|
+
Array.from(extractChanges({ subject: '' }, {})) // ['subject']
|
|
1280
|
+
```
|
|
1281
|
+
|
|
1257
1282
|
`clear` returns every answer to `baseline`. It also clears `touched`, every external failure, and
|
|
1258
1283
|
every runtime `disable` or `enable`. Pending acknowledgement is aborted; the disabled state returns
|
|
1259
1284
|
to the schema's declarations and the answers return to the acknowledged baseline.
|
|
@@ -1584,6 +1609,27 @@ without reachable controls remain text. An invalid submission focuses the first
|
|
|
1584
1609
|
control. The binding never invokes a native validity popup. A `render` event follows DOM effects,
|
|
1585
1610
|
including effects triggered by core changes, so a presentation adapter can apply its own classes.
|
|
1586
1611
|
|
|
1612
|
+
### Reveal a refused field
|
|
1613
|
+
|
|
1614
|
+
An invalid submission focuses only a control a person can reach. A field whose control sits on
|
|
1615
|
+
another page, behind a search, or in a hidden pane has none. Supply `reveal` to bring that field
|
|
1616
|
+
into the document. A refused field a person can already reach takes focus first, and the hook does
|
|
1617
|
+
not run. When none is reachable, the binding calls the hook with each refused field's name in order,
|
|
1618
|
+
rediscovers controls after each call, and focuses the first field the hook made reachable. The hook
|
|
1619
|
+
returns nothing and the binding awaits nothing; a host whose reveal finishes later focuses the
|
|
1620
|
+
field itself. A throw reaches the binding's `error` event and focuses nothing.
|
|
1621
|
+
|
|
1622
|
+
```ts
|
|
1623
|
+
import { createFormBinding } from '@orkestrel/form/browser'
|
|
1624
|
+
|
|
1625
|
+
const binding = createFormBinding(element, model, {
|
|
1626
|
+
reveal: (name) => {
|
|
1627
|
+
search.clear()
|
|
1628
|
+
pager.show(name)
|
|
1629
|
+
},
|
|
1630
|
+
})
|
|
1631
|
+
```
|
|
1632
|
+
|
|
1587
1633
|
Native and document validation remain distinct sources. A named rule's message replaces feedback
|
|
1588
1634
|
for that native constraint. Required, bounds, length, step, pattern, email, and URL failures match
|
|
1589
1635
|
by rule identity, never localized text. A lone uncovered failure keeps the platform's message.
|
|
@@ -1668,9 +1714,16 @@ workaround and the scalar comma-splitting validator for recipient arrays.
|
|
|
1668
1714
|
|
|
1669
1715
|
Set `defer: true` to hold blur-triggered touch while a primary pointer press on an enabled button
|
|
1670
1716
|
associated with this form is active. This includes externally associated buttons and presses on
|
|
1671
|
-
their descendants. Touch resumes in a task after
|
|
1672
|
-
sequence free of blur feedback that moves the
|
|
1673
|
-
|
|
1717
|
+
their descendants. Touch resumes in a task after the press's click, after cancellation, or after a
|
|
1718
|
+
release away from the button, leaving the click sequence free of blur feedback that moves the
|
|
1719
|
+
button. Keyboard blur remains immediate; input reads and submission validation remain immediate.
|
|
1720
|
+
Reset and destruction discard deferred touch.
|
|
1721
|
+
|
|
1722
|
+
A release on the button whose click never reaches the binding keeps the touch pending: a click a
|
|
1723
|
+
listener prevented, or one a listener stopped. The touch then waits for a reset, which discards it, or for the next focus change, which applies it.
|
|
1724
|
+
A later press on a form button carries the pending touch and decides it by its own click. A
|
|
1725
|
+
confirmation gate that holds its first press back therefore keeps the field's feedback still while
|
|
1726
|
+
it is armed, and the confirming press resets the form with nothing shown.
|
|
1674
1727
|
|
|
1675
1728
|
Enable deferral where feedback can move an action under the pointer.
|
|
1676
1729
|
|
|
@@ -1680,6 +1733,25 @@ import { createFormBinding } from '@orkestrel/form/browser'
|
|
|
1680
1733
|
const binding = createFormBinding(element, model, { defer: true })
|
|
1681
1734
|
```
|
|
1682
1735
|
|
|
1736
|
+
For a reset button behind a confirmation gate, let the gate hold the arming click back. The field
|
|
1737
|
+
stays untouched until the confirming click resets the form or focus moves on.
|
|
1738
|
+
|
|
1739
|
+
```ts
|
|
1740
|
+
import { createFormBinding } from '@orkestrel/form/browser'
|
|
1741
|
+
|
|
1742
|
+
const binding = createFormBinding(element, model, { defer: true })
|
|
1743
|
+
window.addEventListener(
|
|
1744
|
+
'click',
|
|
1745
|
+
(event) => {
|
|
1746
|
+
if (!event.composedPath().includes(discard) || gate.armed) return
|
|
1747
|
+
event.preventDefault()
|
|
1748
|
+
event.stopImmediatePropagation()
|
|
1749
|
+
gate.arm()
|
|
1750
|
+
},
|
|
1751
|
+
{ capture: true },
|
|
1752
|
+
)
|
|
1753
|
+
```
|
|
1754
|
+
|
|
1683
1755
|
### Native capability boundaries
|
|
1684
1756
|
|
|
1685
1757
|
The browser admits text, search, email, URL, telephone, hidden, password, textarea, number, range,
|
|
@@ -1687,6 +1759,9 @@ date, time, datetime-local, color, confirm, radio, single select, multiple selec
|
|
|
1687
1759
|
and file inputs. Blank strings become absence through the core's answer predicate; false, zero, and
|
|
1688
1760
|
empty lists remain answers. A password field accepts both `password` and `text` inputs, so a reveal
|
|
1689
1761
|
toggle retains discovery, validation, and summary links without mirroring the value.
|
|
1762
|
+
A number or range input whose own text parses to the document's number keeps that text, so a typed
|
|
1763
|
+
`1.50` survives every projection of `1.5`, and a different number rewrites it. The comparison reads
|
|
1764
|
+
the input's own locale-independent value with the document's equality, and blank text never matches.
|
|
1690
1765
|
Numeric bad input remains a native error and never becomes NaN or a
|
|
1691
1766
|
valid absent answer. Explicit refresh discards that unreadable native text and repaints the document's
|
|
1692
1767
|
answer; ordinary input, touch, and submit keep the text available for correction. Native constraints
|
|
@@ -18,7 +18,9 @@ store and a crash leaves exactly the unfinished rows. Pass a `store` to `createQ
|
|
|
18
18
|
after a restart a fresh queue over the same store `restore()`s precisely that unfinished work.
|
|
19
19
|
`DatabaseQueueStore` is the durable engine over the `@orkestrel/database` layer (a queue's
|
|
20
20
|
durable state is a table), driver-pluggable across memory / JSON / SQLite; `MemoryQueueStore`
|
|
21
|
-
is the zero-plumbing in-process default.
|
|
21
|
+
is the zero-plumbing in-process default. The table admits each entry whole against the input
|
|
22
|
+
shape, so through `DatabaseQueueStore` an `enqueue` input that carries an undeclared member
|
|
23
|
+
rejects with a `QueueError` of code `store`, whose cause is the `DatabaseError` of code `VALIDATION` that carries the faults, before the handler runs.
|
|
22
24
|
|
|
23
25
|
`Queue` is **observable**: it exposes a typed `emitter` (`.claude/rules/patterns.md` §
|
|
24
26
|
Stateful emitters) carrying its lifecycle moments for fire-and-forget observers — logging,
|
|
@@ -82,39 +82,39 @@ 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, 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 }`
|
|
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
|
-
| `ManifestRegionSet` | interface | `{ pins, scripts, additions?, overrides? }`
|
|
107
|
-
| `ManifestScript` | interface | `{ name, command, accepted }`
|
|
108
|
-
| `ManifestToken` | interface | `{ text, index, depth, value }`
|
|
109
|
-
| `Override` | interface | `{ path, content }`
|
|
110
|
-
| `Plan` | interface | `{ blueprint, groups, artifacts, hash? }`
|
|
111
|
-
| `PlanSummary` | interface | `{ name, src, app, groups, host, template, computed }`
|
|
112
|
-
| `Question` | interface | `{ field, message, blocking, candidates? }`
|
|
113
|
-
| `CompileResult` | interface | `{ plan?, questions, stages }`
|
|
114
|
-
| `SrcDefinition` | interface | `{ configs, project, path, formats }`
|
|
115
|
-
| `StylesExtension` | interface | `{ surface, name }`
|
|
116
|
-
| `ToolchainHold` | interface | `{ framework, range, reason }`
|
|
117
|
-
| `ViteMachinery` | interface | `{ browser, frameworks, output, showcase }`
|
|
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, reporter, 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
|
+
| `ManifestRegionSet` | interface | `{ pins, scripts, additions?, overrides? }` | Describes the manifest regions a writing operation may change. |
|
|
107
|
+
| `ManifestScript` | interface | `{ name, command, accepted }` | Represents one manifest script a region-writing operation may replace. |
|
|
108
|
+
| `ManifestToken` | interface | `{ text, index, depth, value }` | Represents one string or object brace found in manifest text. |
|
|
109
|
+
| `Override` | interface | `{ path, content }` | Represents one artifact override. |
|
|
110
|
+
| `Plan` | interface | `{ blueprint, groups, artifacts, hash? }` | Holds the compiled, ordered artifact list and the selection it covers. |
|
|
111
|
+
| `PlanSummary` | interface | `{ name, src, app, groups, host, template, computed }` | Represents the tally of one plan by artifact origin. |
|
|
112
|
+
| `Question` | interface | `{ field, message, blocking, candidates? }` | Represents one validation issue raised against a blueprint or a plan. |
|
|
113
|
+
| `CompileResult` | interface | `{ plan?, questions, stages }` | Represents the replayable outcome of one compile. |
|
|
114
|
+
| `SrcDefinition` | interface | `{ configs, project, path, formats }` | Describes the build and export settings one published `src` environment contributes. |
|
|
115
|
+
| `StylesExtension` | interface | `{ surface, name }` | Represents a named sheet face under `src/<name>`. |
|
|
116
|
+
| `ToolchainHold` | interface | `{ framework, range, reason }` | Represents one foreign tool range required by a browser framework. |
|
|
117
|
+
| `ViteMachinery` | interface | `{ browser, frameworks, output, showcase }` | Names which host-specific pipelines a generated root Vite configuration carries. |
|
|
118
118
|
|
|
119
119
|
| Name | Kind | Signature | Summary |
|
|
120
120
|
| ------------------- | --------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
@@ -133,7 +133,6 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
133
133
|
| Name | Kind | Signature | Summary |
|
|
134
134
|
| --------------------------------- | ----- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
135
135
|
| `APP_BROWSER_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Lists the development dependencies a private browser application adds. |
|
|
136
|
-
| `APP_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Names the development dependency every private `app` environment adds. |
|
|
137
136
|
| `APP_MATRIX` | const | `Readonly<Record<Environment, AppDefinition>>` | Holds the configuration and runtime-entry settings each private `app` environment contributes, frozen. |
|
|
138
137
|
| `APP_SERVER_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Lists the development dependencies a private server application adds. |
|
|
139
138
|
| `ARTIFACT_GROUPS` | const | `readonly ArtifactGroup[]` | Lists the `ArtifactGroup` values in plan order, frozen. |
|
|
@@ -201,6 +200,9 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
201
200
|
| `PRINT_WIDTH` | const | `100` | Caps the columns one emitted line may occupy, matching `printWidth` in `.oxfmtrc.json`. |
|
|
202
201
|
| `REFERENCE_PATHS` | const | `readonly string[]` | Lists the reference paths staged for offline reading, frozen. |
|
|
203
202
|
| `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. |
|
|
204
206
|
| `RESERVED_SHEET_NAMES` | const | `readonly string[]` | Lists the names a styles extension cannot occupy, frozen. |
|
|
205
207
|
| `SEED_GUIDE_PATHS` | const | `readonly string[]` | Lists the guide paths a generated workspace starts with, frozen. |
|
|
206
208
|
| `SERVICE_SCRIPT_PATH` | const | `"scripts/service.sh"` | Names the inventory skeleton a workspace with declared service vendors is given once. |
|
|
@@ -333,7 +335,7 @@ Exported from `@orkestrel/scaffold`, and reachable from
|
|
|
333
335
|
| `blueprintToDevDependencies` | function | `(blueprint: Blueprint) => Readonly<Record<string, string>>` | Projects a blueprint into the development dependencies its manifest declares. |
|
|
334
336
|
| `blueprintToToolchainHolds` | function | `(blueprint: Blueprint) => Readonly<Record<string, ToolchainHold>>` | Projects a blueprint into the toolchain holds its browser frameworks require. |
|
|
335
337
|
| `blueprintToDocumentArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles the generated workspace's root documentation. |
|
|
336
|
-
| `blueprintToExports` | function | `(blueprint: Blueprint) => Readonly<Record<string, unknown>>` | Projects published environments and
|
|
338
|
+
| `blueprintToExports` | function | `(blueprint: Blueprint) => Readonly<Record<string, unknown>>` | Projects published environments, sheets, and the reporter entry into the manifest export map. |
|
|
337
339
|
| `blueprintToFaces` | function | `(blueprint: Blueprint) => readonly BrowserExtension[]` | Projects a blueprint into browser extensions restricted to occupied browser axes. |
|
|
338
340
|
| `blueprintToGuideArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles the generated workspace's guide index. |
|
|
339
341
|
| `blueprintToHostArtifacts` | function | `(blueprint: Blueprint) => readonly Artifact[]` | Compiles the vendored host artifacts a workspace plans. |
|
|
@@ -697,9 +699,25 @@ files on `main`, the scaffold repository's `host.json` file, and changed vendore
|
|
|
697
699
|
`ORKESTREL_SCAFFOLD_REPOSITORY` replaces the repository base. These settings change which host
|
|
698
700
|
answers a read and grant no verb write authority that it did not already have.
|
|
699
701
|
|
|
700
|
-
`new --bin` creates the executable entry, its test, and its scoped Vite and TypeScript wrappers.
|
|
701
|
-
|
|
702
|
-
|
|
702
|
+
`new --bin` creates the executable entry, its test, and its scoped Vite and TypeScript wrappers.
|
|
703
|
+
|
|
704
|
+
A Vitest reporter takes no creation option. Write `src/reporter/main.ts`, the one reporter entry a
|
|
705
|
+
package holds, as an import of the reporter class from `@src/server` followed by `export default`
|
|
706
|
+
of that class, because Vitest's `--reporter=<specifier>` constructs the module's default export.
|
|
707
|
+
The reading verbs then select `reporter`. The manifest exports `./reporter` as the ES-only
|
|
708
|
+
`dist/reporter/main.js` with its `main.d.ts`, packs `dist/reporter`, and declares
|
|
709
|
+
`check:src:reporter`, `build:src:reporter`, and `test:src:reporter`. The root configuration adds the
|
|
710
|
+
`srcReporter` factory and the `src:reporter` project over `tests/src/reporter`, and the selection
|
|
711
|
+
adds `configs/src/vite.reporter.config.ts` and `configs/src/tsconfig.reporter.json`. The reporter
|
|
712
|
+
build keeps every `@src/*` specifier external and rewrites it through `output.paths` to the built
|
|
713
|
+
`../src/<environment>/index.js`. The vendored `.oxlintrc.json` exempts `src/reporter/main.ts`, and
|
|
714
|
+
no other path, from `import/no-default-export`, and refuses a relative import of `src/core` or
|
|
715
|
+
`src/server` from `src/reporter`, which would bundle a second copy of the class. The distribution
|
|
716
|
+
proof reads `dist/reporter` as its own face and reports a server source copied into it. A consumer
|
|
717
|
+
runs it as `--reporter=@orkestrel/<name>/reporter`.
|
|
718
|
+
|
|
719
|
+
The `new --app browser` command selects the journey axis, creates its birth-owned wrapper,
|
|
720
|
+
defines `appJourney` in the root configuration, and excludes the browser integration suite from
|
|
703
721
|
`app:browser`. Its manifest declares `test:journey`. A `private: true` workspace invokes it after
|
|
704
722
|
`npm run test:app` in `test`; a publishing workspace runs application and journey suites on demand,
|
|
705
723
|
outside release gates and chains. It also declares `journey: capture journey` and `capture: capture frames` for explicit
|
|
@@ -771,7 +789,8 @@ environment's export a distinct name. The record never holds a conflict, so a co
|
|
|
771
789
|
run that reads its owner as a candidate.
|
|
772
790
|
|
|
773
791
|
A candidate refuses, naming its path, when its manifest is unreadable, when it has neither its guide
|
|
774
|
-
nor `src
|
|
792
|
+
nor `src/` (an app-only workspace, which publishes no surface and relies on its `test:policy`
|
|
793
|
+
`surface` rule), when its guide exists but is not UTF-8 text within the artifact bound, or when a
|
|
775
794
|
TypeScript source under `src/` cannot be read. Only `.ts` files under `src/` are read, so a binary
|
|
776
795
|
asset there is ignored. A barrel holding a statement other than `export * from './module.js'`
|
|
777
796
|
refuses with the statement named, because the reflection follows nothing else and an incomplete
|
|
@@ -877,7 +896,7 @@ and the declared `@orkestrel/*` packages come from `package.json`. The environme
|
|
|
877
896
|
the directories the target actually ships, because a directory is the fact and a declaration beside
|
|
878
897
|
it could disagree. The styles surface, its themes target, the showcase, and every extension are
|
|
879
898
|
read from the markers Surfaces and extensions lists. The remaining facts come from exact-case
|
|
880
|
-
files: `src/bin/main.ts` selects `bin`, each root `tests/setup*.test.ts` match selects `setup`,
|
|
899
|
+
files: `src/bin/main.ts` selects `bin`, `src/reporter/main.ts` selects `reporter`, each root `tests/setup*.test.ts` match selects `setup`,
|
|
881
900
|
`tests/guides.test.ts` selects `guides`, `tests/integration.test.ts` selects `integration`,
|
|
882
901
|
`tests/conformance.test.ts` selects `conformance`, `tests/tree.test.ts` selects `tree`,
|
|
883
902
|
`tests/setupService.ts` selects `service`,
|
|
@@ -1010,9 +1029,12 @@ chain invokes `test:app`. A chain whose planned form adds an
|
|
|
1010
1029
|
aggregate the manifest lacks stays with the package, and the `projects` question keeps its remedy.
|
|
1011
1030
|
`audit` reports this `test` chain write only through the `projects` question, so a planned step that
|
|
1012
1031
|
registers no Vitest project, such as `npm run test:guides`, lands on the next `repair` without an
|
|
1013
|
-
earlier advisory. `audit` reports no `build:app` chain write, so
|
|
1014
|
-
`
|
|
1015
|
-
`
|
|
1032
|
+
earlier advisory. `audit` reports no `build:app` chain write, so `repair` rewrites a predecessor
|
|
1033
|
+
`build:app` with no earlier advisory after `build:app:barrel` is declared, and before then only the
|
|
1034
|
+
`scripts` question's report of a missing `build:app:barrel` script precedes that write. A
|
|
1035
|
+
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 `test` or `build:app` chain
|
|
1037
|
+
running any other step or order stays maintainer-owned, as do the
|
|
1016
1038
|
`check`, `build`, `dev`, `serve`, `format`, `lint`, `clean`, and `copy` gate chains. A
|
|
1017
1039
|
declared value is overwritten only when it is already the value being written or is a recognized
|
|
1018
1040
|
generated predecessor. The overwrite happens in place,
|
|
@@ -1242,7 +1264,7 @@ a fleet pin; every other peer is a floor. `extras` are development dependencies
|
|
|
1242
1264
|
valid npm name. A peer reaches the generated workspace through separate representations:
|
|
1243
1265
|
`Blueprint.peers` validates the scope rule and compiles the manifest declarations, while the
|
|
1244
1266
|
`peers` binding in the generated `vite.config.ts` derives from the target's live
|
|
1245
|
-
`peerDependencies`. Each published build face — core, browser, server, and `
|
|
1267
|
+
`peerDependencies`. Each published build face — core, browser, server, `bin`, and `reporter` — externalizes
|
|
1246
1268
|
every name in that binding, so a peer the workspace declares by hand, such as `vitest`, is left as
|
|
1247
1269
|
an import in the emitted bundle rather than inlined into it.
|
|
1248
1270
|
|
|
@@ -1273,8 +1295,8 @@ because the shape is chosen once and read afterwards: `new` refuses the advisory
|
|
|
1273
1295
|
`repair` need the plan to describe and restore a target that already has that shape. A library
|
|
1274
1296
|
caller creating a workspace holds the same refusal, and the Compile section states it.
|
|
1275
1297
|
|
|
1276
|
-
`bin`, `setup`, `guides`, `integration`, `conformance`, `tree`, `service`, `vendors`,
|
|
1277
|
-
`global`, `styles`, `themes`, `showcase`, `journey`, `base`, and `skills` are structural facts, and `extensions` lists the
|
|
1298
|
+
`bin`, `reporter`, `setup`, `guides`, `integration`, `conformance`, `tree`, `service`, `vendors`,
|
|
1299
|
+
`studies`, `global`, `styles`, `themes`, `showcase`, `journey`, `base`, and `skills` are structural facts, and `extensions` lists the
|
|
1278
1300
|
extension faces. Reading verbs set each fact and list each extension only when the workspace
|
|
1279
1301
|
physically ships the directory or exact-case file that defines it, never because of the workspace's
|
|
1280
1302
|
name and never because a sibling fact is set.
|
|
@@ -1352,8 +1374,8 @@ The project loads `tests/setup.ts` alone. The tests import
|
|
|
1352
1374
|
`tests/setupStudy.ts`, a harness module the package owns, so scaffold plans no such file and no
|
|
1353
1375
|
project loads it as a setup file. In publishing and `private: true` workspaces, run the project on
|
|
1354
1376
|
demand with `npm run test:studies` alone; no gate or chain runs it.
|
|
1355
|
-
Its longer timeouts and
|
|
1356
|
-
live
|
|
1377
|
+
Its longer timeouts match the live-service project, and its files run in parallel, because its
|
|
1378
|
+
proofs drive seeded, replayed, or scripted runs rather than a live service. The root `studies/` directory holds the adapters and declarations the study
|
|
1357
1379
|
tests run, and it selects nothing. A chain that carries a study step fails the configuration proof
|
|
1358
1380
|
until the workspace removes that step during scaffold adoption.
|
|
1359
1381
|
|
|
@@ -1448,8 +1470,8 @@ workspace carries:
|
|
|
1448
1470
|
`BrowserExtension.axes` lists the axes a browser extension physically occupies, so a target holding
|
|
1449
1471
|
`app/vue` and no `src/vue` carries `axes: ['app']`. `FRAMEWORKS` holds `vue` alone. A
|
|
1450
1472
|
`StylesExtension` name passes `isSheetName`: it matches `NAME_PATTERN` and is none of the
|
|
1451
|
-
`RESERVED_SHEET_NAMES` values, which are `core`, `browser`, `server`, `bin`, `
|
|
1452
|
-
`vue`.
|
|
1473
|
+
`RESERVED_SHEET_NAMES` values, which are `core`, `browser`, `server`, `bin`, `reporter`, `styles`,
|
|
1474
|
+
`themes`, and `vue`.
|
|
1453
1475
|
|
|
1454
1476
|
`parseExtension` reads one `surface:name` entry, and `isSurface` decides whether its surface is
|
|
1455
1477
|
one the generator plans, so `styles:print` parses and `themes:print` does not. Browser text carries
|
|
@@ -1600,8 +1622,8 @@ The `vue` extension gives each axis it occupies a face of its own:
|
|
|
1600
1622
|
`check` script typechecks the whole tree through `vue-tsc` in place of `tsc`.
|
|
1601
1623
|
|
|
1602
1624
|
The vendored `.oxlintrc.json` holds each face to the import direction `AGENTS.md` § Project model fixes, and
|
|
1603
|
-
refuses, from `src/browser`, `src/server`, `src/vue`, and `src/
|
|
1604
|
-
`src/browser` from `src/vue`, or to `src/server` from `src/bin` with a message naming the alias, because a face's
|
|
1625
|
+
refuses, from `src/browser`, `src/server`, `src/vue`, `src/bin`, and `src/reporter`, a relative path to
|
|
1626
|
+
`src/core`, to `src/browser` from `src/vue`, or to `src/server` from `src/bin` or `src/reporter` with a message naming the alias, because a face's
|
|
1605
1627
|
build bundles what a relative path reaches. The vendored
|
|
1606
1628
|
`tests/config.test.ts` drives those directions through Oxlint.
|
|
1607
1629
|
|
|
@@ -1700,14 +1722,14 @@ A workspace that selects `studies` and the `server` application also builds the
|
|
|
1700
1722
|
`build:app:barrel` script exist only under that condition, and `build:app` runs the script after
|
|
1701
1723
|
`build:app:server`. `serve:build` runs `build` before `serve`, so the barrel, which the server
|
|
1702
1724
|
build's emptied `dist/app/server` would otherwise lose, and every browser face the server serves are
|
|
1703
|
-
rebuilt. The build emits the single file `dist/app/server/index.js` with `@app/*` and
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
staged root, compares the `main.cjs` digest across the barrel step, builds the barrel
|
|
1708
|
-
`index.js` digest, imports the file in Node, and holds each claim under a control.
|
|
1709
|
-
`tests/config.test.ts` repeats the externals, digest, and `main.cjs` readings in each
|
|
1710
|
-
plans the barrel.
|
|
1725
|
+
rebuilt. The build emits the single file `dist/app/server/index.js` with `@app/*` and `@src/*`
|
|
1726
|
+
specifiers and relative imports inlined, and `node:` and every installed package specifier left
|
|
1727
|
+
external. It sets `emptyOutDir` to `false`, so `main.cjs` stays byte-identical. A workspace without
|
|
1728
|
+
both conditions plans none of the three. Scaffold's `tests/src/core/templates.test.ts` builds both
|
|
1729
|
+
entries in a staged root, compares the `main.cjs` digest across the barrel step, builds the barrel
|
|
1730
|
+
twice for one `index.js` digest, imports the file in Node, and holds each claim under a control.
|
|
1731
|
+
The vendored `tests/config.test.ts` repeats the externals, digest, and `main.cjs` readings in each
|
|
1732
|
+
target that plans the barrel.
|
|
1711
1733
|
|
|
1712
1734
|
### The migration guard
|
|
1713
1735
|
|
|
@@ -1889,7 +1911,7 @@ bytes.
|
|
|
1889
1911
|
You own `tests/setup.ts`, the selected `tests/setupBrowser.ts`, `tests/setupServer.ts`,
|
|
1890
1912
|
`tests/setupService.ts`, `tests/setupStyles.ts`, and `tests/setupGlobal.ts` modules, each root
|
|
1891
1913
|
`tests/setup*.test.ts` proof, the selected environment and sheet-face entry tests under `tests/src`
|
|
1892
|
-
and `tests/app`, the `tests/src/bin/main.test.ts`
|
|
1914
|
+
and `tests/app`, the `tests/src/bin/main.test.ts` and `tests/src/reporter/main.test.ts` files, and the `tests/integration.test.ts` seed.
|
|
1893
1915
|
Every sheet face's seed under `src` is yours on the same terms. Scaffold writes those
|
|
1894
1916
|
planned files only during materialize and leaves later edits or deletions alone. You also own the
|
|
1895
1917
|
`tests/guides.test.ts`, `tests/conformance.test.ts`, `tests/tree.test.ts`, and
|
|
@@ -2007,8 +2029,10 @@ declaration, a binding that is not an identifier, a barrel statement outside the
|
|
|
2007
2029
|
A missing guide root, an empty catalog, a catalog row with no hosted guide, and a hosted guide
|
|
2008
2030
|
carrying no `Surface` section report one the same way, so a reading the sweep could not complete
|
|
2009
2031
|
never reports clean. A collision reads
|
|
2010
|
-
`surface name belongs to one package: NAME (OWNER)
|
|
2011
|
-
|
|
2032
|
+
`surface name belongs to one package: NAME (OWNER)`, then the correction: delete the local declaration
|
|
2033
|
+
and `import { NAME } from "@orkestrel/OWNER"` (or the owner's environment entry that exports it)
|
|
2034
|
+
where the contracts match, and rename only where the local contract differs. It carries the
|
|
2035
|
+
declaring path and line, sorted by path, line, and message. Which package keeps a claimed name is the answer
|
|
2012
2036
|
`.claude/rules/names.md` § Fleet name ownership gives; the rule carries no allowlist and no
|
|
2013
2037
|
suppression.
|
|
2014
2038
|
|
|
@@ -2029,6 +2053,7 @@ set is reachable through a published specifier.
|
|
|
2029
2053
|
| `POLICY_SURFACE_HOST` | const | Names the installed host root containing the fleet's reference guides. |
|
|
2030
2054
|
| `createPolicySurfaceFixture` | function | Creates a scratch target with a complete installed guide population. |
|
|
2031
2055
|
| `createPolicySurfaceGuide` | function | Creates a guide whose surface claims the supplied fixture names. |
|
|
2056
|
+
| `describeSurfaceCollision` | function | Describes the refusal for a name that two packages claim, with the owner's import. |
|
|
2032
2057
|
| `inspectPolicySurface` | function | Inspects source and target-owned setup names against the hosted fleet guides. |
|
|
2033
2058
|
| `readPolicyDeclarations` | function | Locates parsed exports at their physical declaration lines. |
|
|
2034
2059
|
| `readPolicySurface` | function | Reads reachable source declarations and refuses unread barrel statements or targets. |
|
|
@@ -2599,10 +2624,10 @@ Nothing is fixed except the manifest.
|
|
|
2599
2624
|
`--ignore-scripts` to `npm pack` so a suite never re-runs the build it already gates.
|
|
2600
2625
|
- One template artifact per configuration file the selection needs: the root `tsconfig.json` and
|
|
2601
2626
|
`vite.config.ts`, plus a Vite config and a scoped TypeScript config per selected environment and
|
|
2602
|
-
for `bin` when
|
|
2627
|
+
for `bin` and for `reporter` when each is set. The root `tsconfig.json` maps the `@src` and `@app` aliases the selection
|
|
2603
2628
|
reaches, and beside them the workspace's own published specifiers — `@orkestrel/<name>` and one
|
|
2604
|
-
`@orkestrel/<name>/<environment>` entry per subpath the `exports` map publishes —
|
|
2605
|
-
source entry. Without them the workspace's own name resolves through that `exports` map to
|
|
2629
|
+
`@orkestrel/<name>/<environment>` entry per environment subpath the `exports` map publishes —
|
|
2630
|
+
each to its source entry. The `./reporter` subpath and each sheet subpath map no entry. Without them the workspace's own name resolves through that `exports` map to
|
|
2606
2631
|
`dist/`, and `npm run check` would wait on `npm run build`. Every subpath is written before the
|
|
2607
2632
|
bare specifier, because `vite.config.ts` derives its `alias` record from these entries in order and
|
|
2608
2633
|
a bare specifier also matches its own subpaths. An `app` environment publishes nothing and maps no
|
|
@@ -2740,7 +2765,10 @@ compiler API of its own. The browser and server faces pass `rewriteCoreSpecifier
|
|
|
2740
2765
|
emits the `@src/core` specifier unrewritten and the extractor keeps it external, so the rewrite
|
|
2741
2766
|
replaces it with the workspace's own published name and a consumer of the packed face reaches core
|
|
2742
2767
|
through the root export the tarball declares. The seeded `bin` config calls no roll-up, because an
|
|
2743
|
-
executable ships no declarations.
|
|
2768
|
+
executable ships no declarations. The reporter config passes `rewriteServerSpecifier`, which
|
|
2769
|
+
replaces `@src/server` with `../src/server/index.js`, so `dist/reporter/main.d.ts` reads the server
|
|
2770
|
+
declarations at the path `dist/reporter/main.js` imports. The roll-up takes the entry's own name,
|
|
2771
|
+
so a face ships `index.d.ts` and the reporter ships `main.d.ts`.
|
|
2744
2772
|
|
|
2745
2773
|
`planToSummary` reports the tally rather than a number written down here:
|
|
2746
2774
|
|