@astryxdesign/cli 0.1.4-canary.f00b844 → 0.1.4-canary.f0b9ca8
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/CHANGELOG.md +2 -1
- package/docs/getting-started.doc.mjs +4 -0
- package/docs/migration.doc.mjs +134 -0
- package/package.json +14 -9
- package/src/api/doctor.mjs +13 -2
- package/src/codemods/__tests__/runner.test.mjs +38 -0
- package/src/codemods/runner.mjs +2 -0
- package/src/commands/agent-docs.mjs +7 -5
- package/src/commands/agent-docs.test.mjs +33 -0
- package/src/commands/build-theme.mjs +110 -13
- package/src/commands/build-theme.variants.test.mjs +204 -0
- package/src/commands/doctor.test.mjs +34 -0
- package/src/commands/init.mjs +1 -1
- package/templates/blocks/components/BaseTypeahead/BaseTypeaheadCustomSearch.doc.mjs +14 -0
- package/templates/blocks/components/BaseTypeahead/BaseTypeaheadCustomSearch.tsx +58 -0
- package/templates/blocks/components/CodeBlock/CodeBlockTerminal.doc.mjs +14 -0
- package/templates/blocks/components/CodeBlock/CodeBlockTerminal.tsx +24 -0
- package/templates/blocks/components/Collapsible/CollapsibleDividedAccordion.doc.mjs +13 -0
- package/templates/blocks/components/Collapsible/CollapsibleDividedAccordion.tsx +33 -0
- package/templates/blocks/components/CommandPaletteGroup/CommandPaletteGroupShowcase.tsx +27 -48
- package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputBasic.doc.mjs +15 -0
- package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputBasic.tsx +39 -0
- package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputShowcase.doc.mjs +15 -0
- package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputShowcase.tsx +39 -0
- package/templates/blocks/components/CommandPaletteItem/CommandPaletteItemShowcase.tsx +31 -54
- package/templates/blocks/components/CommandPaletteList/CommandPaletteListBasic.doc.mjs +15 -0
- package/templates/blocks/components/CommandPaletteList/CommandPaletteListBasic.tsx +27 -0
- package/templates/blocks/components/CommandPaletteList/CommandPaletteListShowcase.doc.mjs +15 -0
- package/templates/blocks/components/CommandPaletteList/CommandPaletteListShowcase.tsx +38 -0
- package/templates/blocks/components/ContextMenuItem/ContextMenuItemBasic.doc.mjs +14 -0
- package/templates/blocks/components/ContextMenuItem/ContextMenuItemBasic.tsx +44 -0
- package/templates/blocks/components/ContextMenuItem/ContextMenuItemShowcase.doc.mjs +15 -0
- package/templates/blocks/components/ContextMenuItem/ContextMenuItemShowcase.tsx +107 -0
- package/templates/blocks/components/NavHeadingMenu/NavHeadingMenuShowcase.doc.mjs +15 -0
- package/templates/blocks/components/NavHeadingMenu/NavHeadingMenuShowcase.tsx +47 -0
- package/templates/pages/table-page-chart/page.tsx +3 -13
- package/templates/pages/table-page-shoe-store-heatmap/page.tsx +4 -18
package/CHANGELOG.md
CHANGED
|
@@ -36,7 +36,7 @@ Thanks to everyone who contributed to this release:
|
|
|
36
36
|
- Strict config + integration v1 schema (integrations, issuesUrl, hooks.postCodemod) and new @astryxdesign/cli/integration export.
|
|
37
37
|
- File-based codemod API (createCodemod/createConfigCodemod) with the @astryxdesign/cli/codemod export and integration codemod discovery in upgrade.
|
|
38
38
|
- component, template, and upgrade now print a one-line non-blocking warning when a configured integration has validation issues, pointing to validate-integration.
|
|
39
|
-
- Add a Kanban Board page template: color-coded status columns, draggable task cards with priority tags, and board toolbar.
|
|
39
|
+
- Add a Kanban Board page template: color-coded status columns, draggable task cards with priority tags, and board toolbar. Based on a design by @cg-hub18.
|
|
40
40
|
- Add frame-first layout guidance: new `astryx docs layout` topic (shell choice, region budgets, app archetypes, cards-vs-rows policy, responsive contracts), layout rules in the generated agent cheat sheet, and layout anti-patterns in `docs principles`.
|
|
41
41
|
- Add a v0.1.3 config codemod that migrates astryx.config layout.components to experimental.xle.components.
|
|
42
42
|
- Add v0.1.0 codemods for migrating `declare module "@xds/core/..."` type augmentations and `.xds-*` / `[data-xds-theme]` / `@layer xds-theme` CSS surfaces to their `@astryxdesign`/`astryx-*` equivalents.
|
|
@@ -80,6 +80,7 @@ Thanks to everyone who contributed to this release:
|
|
|
80
80
|
Thanks to everyone who contributed to this release:
|
|
81
81
|
|
|
82
82
|
- @AKnassa
|
|
83
|
+
- @cg-hub18
|
|
83
84
|
- @ejhammond
|
|
84
85
|
- @ernestt
|
|
85
86
|
- @harshavardhan194
|
|
@@ -69,6 +69,10 @@ export const docs = {
|
|
|
69
69
|
type: 'prose',
|
|
70
70
|
text: 'Available themes: @astryxdesign/theme-neutral (muted minimal, a good starting point), @astryxdesign/theme-butter, @astryxdesign/theme-chocolate, @astryxdesign/theme-gothic (dark-only), @astryxdesign/theme-matcha, @astryxdesign/theme-stone, and @astryxdesign/theme-y2k. See `npx astryx docs theme` for the full theming guide.',
|
|
71
71
|
},
|
|
72
|
+
{
|
|
73
|
+
type: 'prose',
|
|
74
|
+
text: 'These stylesheets are cascade-layered: the reset loads in @layer reset and component styles in @layer astryx-base. If your project has existing global CSS, a legacy reset, or Tailwind, declare the layer order explicitly and assign every stylesheet to a layer deliberately: unlayered styles and later layers both override astryx-base regardless of specificity. See the Cascade Layer Safety section in `npx astryx docs migration` before building screens.',
|
|
75
|
+
},
|
|
72
76
|
],
|
|
73
77
|
},
|
|
74
78
|
{
|
package/docs/migration.doc.mjs
CHANGED
|
@@ -33,6 +33,7 @@ export const docs = {
|
|
|
33
33
|
'Install the design system and run init so the project has package scripts, theme CSS, and agent docs.',
|
|
34
34
|
'Wrap the app root with Theme and choose the initial light, dark, or system mode behavior.',
|
|
35
35
|
'Make Tailwind and design system CSS layer order explicit before replacing components.',
|
|
36
|
+
'Render the foundation smoke test page and confirm primitives keep their padding before migrating any surface.',
|
|
36
37
|
'Move the persistent frame first: AppShell, TopNav, SideNav, page content, and mobile navigation.',
|
|
37
38
|
'Replace shared primitives: Button, IconButton, TextInput, NumberInput, Switch, CheckboxInput, RadioList, Selector, Tabs, Dialog, AlertDialog, Banner, Toast, Badge, Card, Table, and ListItem.',
|
|
38
39
|
'Replace global workflows: command palette, settings popover, theme toggle, search, filters, create flows, and destructive confirmation dialogs.',
|
|
@@ -125,6 +126,139 @@ export function AppRoot({children}: {children: React.ReactNode}) {
|
|
|
125
126
|
@import "@astryxdesign/core/tailwind-theme.css";
|
|
126
127
|
@import "tailwindcss/utilities.css" layer(utilities);`,
|
|
127
128
|
},
|
|
129
|
+
{
|
|
130
|
+
type: 'prose',
|
|
131
|
+
text: 'On Tailwind v3 there is no preflight.css to import, so wrap the @tailwind base directive in a named layer instead. Keep utilities unlayered so existing app utility classes still win everywhere.',
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
type: 'code',
|
|
135
|
+
lang: 'css',
|
|
136
|
+
label: 'Tailwind v3 coexistence',
|
|
137
|
+
code: `@layer reset, tw-preflight, astryx-base, astryx-theme;
|
|
138
|
+
|
|
139
|
+
@import "@astryxdesign/core/reset.css";
|
|
140
|
+
@import "@astryxdesign/core/astryx.css";
|
|
141
|
+
@import "@astryxdesign/theme-neutral/theme.css";
|
|
142
|
+
|
|
143
|
+
@layer tw-preflight {
|
|
144
|
+
@tailwind base; /* layered: astryx-theme now wins over preflight */
|
|
145
|
+
}
|
|
146
|
+
@tailwind components;
|
|
147
|
+
@tailwind utilities; /* unlayered: legacy utility classes keep winning */`,
|
|
148
|
+
},
|
|
149
|
+
],
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
title: 'Cascade Layer Safety',
|
|
153
|
+
content: [
|
|
154
|
+
{
|
|
155
|
+
type: 'prose',
|
|
156
|
+
text: 'In a stylesheet with no layers at all, a zero-specificity reset like `* { padding: 0 }` loses to any class selector, so most developers treat resets as harmless. Layers change the rules twice: unlayered styles beat every named layer, and a later layer beats an earlier one, both regardless of specificity. The same reset therefore wins against every component style either by staying unlayered or by landing in a layer declared after astryx-base. Same CSS, opposite outcome, and no error or warning when it happens.',
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
type: 'prose',
|
|
160
|
+
text: 'This is the most common way an adoption breaks, through one of two @import mechanisms. A top-level @import without the layer() keyword keeps the legacy reset unlayered, where it overrides every design system layer. And an @import nested inside a file that was itself imported into a layer inherits that surrounding layer, so a reset can silently land in a consumer layer above astryx-base. Either way the fix is the same: import the legacy reset into the lowest layer explicitly.',
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
type: 'code',
|
|
164
|
+
lang: 'css',
|
|
165
|
+
label: 'Legacy reset, explicitly layered',
|
|
166
|
+
code: `/* was: @import "./legacy-reset.css"; (unlayered: beats every layer) */
|
|
167
|
+
@import "./legacy-reset.css" layer(reset);`,
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
type: 'prose',
|
|
171
|
+
text: 'Audit the layers around the design system with this checklist before building screens.',
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
type: 'list',
|
|
175
|
+
style: 'unordered',
|
|
176
|
+
items: [
|
|
177
|
+
'Declare the canonical @layer order once, before any @import. With webpack-based bundlers (including Next.js) the order declaration must live in its own CSS file imported first, such as layers.css, because webpack hoists @import content above the inline CSS that follows it.',
|
|
178
|
+
'Audit every pre-existing global or reset stylesheet and assign each one to a layer deliberately. Top-level imports without layer() stay unlayered and beat every layer; imports nested inside a layered file inherit that layer.',
|
|
179
|
+
'Remove or demote the app legacy reset. The design system ships its own :where() reset in the lowest layer, so any app reset belongs in that same reset layer and never in a layer above astryx-base.',
|
|
180
|
+
'Layer Tailwind preflight. On Tailwind v4, import preflight.css with layer(base). On Tailwind v3, wrap the @tailwind base directive in a named layer (see the snippet in Theme and CSS Setup). Unlayered preflight overrides theme CSS silently.',
|
|
181
|
+
'Set moduleResolution to bundler or node16 and newer so subpath imports like @astryxdesign/core/reset.css resolve.',
|
|
182
|
+
'Theme with defineTheme and the accent family API instead of hand-writing individual color tokens. Derived tokens like --color-on-accent are generated from the accent scale automatically; hand-writing only --color-accent leaves --color-on-accent at its stale white default with no contrast guarantee against the new accent.',
|
|
183
|
+
'Run the foundation smoke test below and view a few components in both light and dark mode before migrating any route.',
|
|
184
|
+
],
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
type: 'prose',
|
|
188
|
+
text: 'One more mental model shift: a className or utility class you write on a component still reaches the DOM either way, but whether it overrides the component is a layer question, not a source order question. Keep app utilities in the utilities layer so they keep winning.',
|
|
189
|
+
},
|
|
190
|
+
],
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
title: 'Foundation Smoke Test',
|
|
194
|
+
content: [
|
|
195
|
+
{
|
|
196
|
+
type: 'prose',
|
|
197
|
+
text: 'A broken layer order fails silently and identically on every page, so catch it before feature work instead of after N migrated screens. Render one throwaway page with a few primitives as the first migration step.',
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
type: 'code',
|
|
201
|
+
lang: 'tsx',
|
|
202
|
+
label: 'Foundation check page',
|
|
203
|
+
code: `import {useState} from 'react';
|
|
204
|
+
import {Button} from '@astryxdesign/core/Button';
|
|
205
|
+
import {Card} from '@astryxdesign/core/Card';
|
|
206
|
+
import {Table} from '@astryxdesign/core/Table';
|
|
207
|
+
import {TextInput} from '@astryxdesign/core/TextInput';
|
|
208
|
+
import {VStack} from '@astryxdesign/core/VStack';
|
|
209
|
+
|
|
210
|
+
export default function FoundationCheck() {
|
|
211
|
+
const [email, setEmail] = useState('');
|
|
212
|
+
|
|
213
|
+
return (
|
|
214
|
+
<div data-foundation-check>
|
|
215
|
+
<VStack gap={4}>
|
|
216
|
+
<Button label="Primary action" variant="primary" />
|
|
217
|
+
<TextInput
|
|
218
|
+
label="Email"
|
|
219
|
+
placeholder="you@example.com"
|
|
220
|
+
value={email}
|
|
221
|
+
onChange={setEmail}
|
|
222
|
+
/>
|
|
223
|
+
<Card>One card with default padding</Card>
|
|
224
|
+
<Table
|
|
225
|
+
data={[{name: 'Foundation', status: 'ok'}]}
|
|
226
|
+
columns={[
|
|
227
|
+
{key: 'name', header: 'Name'},
|
|
228
|
+
{key: 'status', header: 'Status'},
|
|
229
|
+
]}
|
|
230
|
+
/>
|
|
231
|
+
</VStack>
|
|
232
|
+
</div>
|
|
233
|
+
);
|
|
234
|
+
}`,
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
type: 'prose',
|
|
238
|
+
text: 'If the button renders with visible padding, a filled primary background, and the input and card have borders and internal spacing, the foundation is sound. For an assertion that can run in any test runner or a dev-only effect, check that a primitive keeps non-zero padding:',
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
type: 'code',
|
|
242
|
+
lang: 'ts',
|
|
243
|
+
label: 'Foundation assertion',
|
|
244
|
+
code: `const button = document.querySelector<HTMLButtonElement>(
|
|
245
|
+
'[data-foundation-check] button',
|
|
246
|
+
);
|
|
247
|
+
if (!button) {
|
|
248
|
+
throw new Error('Foundation check page did not render a button.');
|
|
249
|
+
}
|
|
250
|
+
if (getComputedStyle(button).paddingInline === '0px') {
|
|
251
|
+
throw new Error(
|
|
252
|
+
'Foundation broken: an unlayered reset or a later cascade layer is ' +
|
|
253
|
+
'overriding component styles. Check that no app reset sits outside ' +
|
|
254
|
+
'the reset layer.',
|
|
255
|
+
);
|
|
256
|
+
}`,
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
type: 'prose',
|
|
260
|
+
text: 'When this fails, the fix is almost always in the layer order: find the stylesheet that zeroes padding, and move it into the reset layer or delete it.',
|
|
261
|
+
},
|
|
128
262
|
],
|
|
129
263
|
},
|
|
130
264
|
{
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@astryxdesign/cli",
|
|
3
|
-
"version": "0.1.4-canary.
|
|
3
|
+
"version": "0.1.4-canary.f0b9ca8",
|
|
4
4
|
"displayName": "CLI",
|
|
5
5
|
"description": "Scaffold projects, browse templates, generate themes, and get agent-ready docs from the command line.",
|
|
6
6
|
"author": "Meta Open Source",
|
|
@@ -75,12 +75,16 @@
|
|
|
75
75
|
"zod": "^4.4.3"
|
|
76
76
|
},
|
|
77
77
|
"peerDependencies": {
|
|
78
|
-
"@astryxdesign/
|
|
79
|
-
"@astryxdesign/
|
|
80
|
-
"@astryxdesign/
|
|
81
|
-
"
|
|
78
|
+
"@astryxdesign/charts": "0.1.4-canary.f0b9ca8",
|
|
79
|
+
"@astryxdesign/core": "0.1.4-canary.f0b9ca8",
|
|
80
|
+
"@astryxdesign/lab": "0.1.4-canary.f0b9ca8",
|
|
81
|
+
"@astryxdesign/theme-neutral": "0.1.4-canary.f0b9ca8",
|
|
82
|
+
"gpt-tokenizer": "^3.4.0"
|
|
82
83
|
},
|
|
83
84
|
"peerDependenciesMeta": {
|
|
85
|
+
"@astryxdesign/charts": {
|
|
86
|
+
"optional": true
|
|
87
|
+
},
|
|
84
88
|
"@astryxdesign/core": {
|
|
85
89
|
"optional": true
|
|
86
90
|
},
|
|
@@ -92,10 +96,11 @@
|
|
|
92
96
|
}
|
|
93
97
|
},
|
|
94
98
|
"devDependencies": {
|
|
95
|
-
"@astryxdesign/
|
|
96
|
-
"@astryxdesign/
|
|
97
|
-
"@astryxdesign/
|
|
98
|
-
"
|
|
99
|
+
"@astryxdesign/charts": "0.1.4-canary.f0b9ca8",
|
|
100
|
+
"@astryxdesign/core": "0.1.4-canary.f0b9ca8",
|
|
101
|
+
"@astryxdesign/lab": "0.1.4-canary.f0b9ca8",
|
|
102
|
+
"@astryxdesign/theme-neutral": "0.1.4-canary.f0b9ca8",
|
|
103
|
+
"gpt-tokenizer": "^3.4.0"
|
|
99
104
|
},
|
|
100
105
|
"scripts": {
|
|
101
106
|
"astryx": "node bin/astryx.mjs",
|
package/src/api/doctor.mjs
CHANGED
|
@@ -115,10 +115,21 @@ function findThemePackages(cwd) {
|
|
|
115
115
|
return found;
|
|
116
116
|
}
|
|
117
117
|
for (const entry of entries) {
|
|
118
|
-
if (!entry.isDirectory()) continue;
|
|
119
118
|
if (!entry.name.startsWith('theme-')) continue;
|
|
119
|
+
const dir = path.join(scopeDir, entry.name);
|
|
120
|
+
// pnpm installs packages as symlinks into node_modules/.pnpm, and a
|
|
121
|
+
// symlink dirent reports isDirectory() as false — stat the target instead.
|
|
122
|
+
let isDir = entry.isDirectory();
|
|
123
|
+
if (!isDir && entry.isSymbolicLink()) {
|
|
124
|
+
try {
|
|
125
|
+
isDir = fs.statSync(dir).isDirectory();
|
|
126
|
+
} catch {
|
|
127
|
+
isDir = false;
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
if (!isDir) continue;
|
|
120
131
|
const name = `@astryxdesign/${entry.name}`;
|
|
121
|
-
found.push({name, version: pkgVersion(
|
|
132
|
+
found.push({name, version: pkgVersion(dir)});
|
|
122
133
|
}
|
|
123
134
|
return found;
|
|
124
135
|
}
|
|
@@ -99,5 +99,43 @@ describe('runCodemods — unified config codemod path', () => {
|
|
|
99
99
|
expect(fs.readFileSync(path.join(srcDir, 'a.ts'), 'utf-8')).toContain(
|
|
100
100
|
'const bar = 1',
|
|
101
101
|
);
|
|
102
|
+
// writtenFiles must be returned (consumed by upgrade.mjs to run the
|
|
103
|
+
// post-codemod formatting/lint hooks). Regression guard: it was previously
|
|
104
|
+
// built internally but omitted from the return object, so hooks received an
|
|
105
|
+
// empty file list and silently skipped, leaving codemod output unformatted.
|
|
106
|
+
expect(result.writtenFiles).toEqual([path.join(srcDir, 'a.ts')]);
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
it('returns writtenFiles for every changed file (post-codemod hook input)', async () => {
|
|
110
|
+
const srcDir = path.join(tmpDir, 'src');
|
|
111
|
+
fs.mkdirSync(srcDir);
|
|
112
|
+
fs.writeFileSync(path.join(srcDir, 'a.ts'), 'const foo = 1;\n');
|
|
113
|
+
fs.writeFileSync(path.join(srcDir, 'b.ts'), 'const foo = 2;\n');
|
|
114
|
+
fs.writeFileSync(path.join(srcDir, 'c.ts'), 'const untouched = 3;\n');
|
|
115
|
+
|
|
116
|
+
const versionManifests = [
|
|
117
|
+
{
|
|
118
|
+
version: '0.1.3',
|
|
119
|
+
transforms: [
|
|
120
|
+
{
|
|
121
|
+
name: 'synthetic-code-codemod',
|
|
122
|
+
meta: {title: 'Synthetic code codemod'},
|
|
123
|
+
transform: file => file.source.replace(/foo/g, 'bar'),
|
|
124
|
+
},
|
|
125
|
+
],
|
|
126
|
+
},
|
|
127
|
+
];
|
|
128
|
+
|
|
129
|
+
const result = await runCodemods(versionManifests, {
|
|
130
|
+
apply: true,
|
|
131
|
+
path: './src',
|
|
132
|
+
silent: true,
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
expect(result.totalFilesChanged).toBe(2);
|
|
136
|
+
// Only the two files that actually changed are reported (not c.ts).
|
|
137
|
+
expect([...result.writtenFiles].sort()).toEqual(
|
|
138
|
+
[path.join(srcDir, 'a.ts'), path.join(srcDir, 'b.ts')].sort(),
|
|
139
|
+
);
|
|
102
140
|
});
|
|
103
141
|
});
|
package/src/codemods/runner.mjs
CHANGED
|
@@ -178,6 +178,7 @@ function toUnifiedEntry(transformEntry, version) {
|
|
|
178
178
|
* @param {string|undefined} options.codemod - Run only this specific transform
|
|
179
179
|
* @param {Set<string>} [options.skipCodemods] - Transform names to exclude
|
|
180
180
|
* @param {boolean} [options.silent] - Suppress all human-facing output (for --json)
|
|
181
|
+
* @returns {{totalFilesChanged: number, totalTransformsApplied: number, totalValidationBlocked: number, writtenFiles: string[], errors: Array, skippedOptional: Array}}
|
|
181
182
|
*/
|
|
182
183
|
export async function runCodemods(
|
|
183
184
|
versionManifests,
|
|
@@ -405,6 +406,7 @@ export async function runCodemods(
|
|
|
405
406
|
totalFilesChanged,
|
|
406
407
|
totalTransformsApplied,
|
|
407
408
|
totalValidationBlocked,
|
|
409
|
+
writtenFiles,
|
|
408
410
|
errors,
|
|
409
411
|
skippedOptional,
|
|
410
412
|
};
|
|
@@ -9,11 +9,12 @@
|
|
|
9
9
|
* - Claude Code: CLAUDE.md (root) or .claude/CLAUDE.md
|
|
10
10
|
* - Cursor: .cursorrules
|
|
11
11
|
* - Codex/generic: AGENTS.md
|
|
12
|
+
* - Hermes Agent: .hermes.md or HERMES.md (existing), else AGENTS.md
|
|
12
13
|
*
|
|
13
14
|
* Auto-detect: discovers existing files and updates them in place.
|
|
14
15
|
* Default (no existing files): creates .claude/CLAUDE.md.
|
|
15
16
|
*
|
|
16
|
-
* --agent <tool>: target a specific tool preset (claude, cursor, codex, all)
|
|
17
|
+
* --agent <tool>: target a specific tool preset (claude, cursor, codex, hermes, all)
|
|
17
18
|
* --agent-docs-path <path>: explicit file path(s)
|
|
18
19
|
*/
|
|
19
20
|
|
|
@@ -46,6 +47,7 @@ const AGENT_PRESETS = {
|
|
|
46
47
|
claude: [CLAUDE_MD, CLAUDE_DIR_MD],
|
|
47
48
|
cursor: ['.cursorrules', AGENTS_MD],
|
|
48
49
|
codex: [AGENTS_MD],
|
|
50
|
+
hermes: ['.hermes.md', 'HERMES.md', AGENTS_MD],
|
|
49
51
|
};
|
|
50
52
|
|
|
51
53
|
/**
|
|
@@ -64,7 +66,7 @@ export function discoverAgentDocs(targetDir) {
|
|
|
64
66
|
* Searches for existing files first, falls back to default creation path.
|
|
65
67
|
*
|
|
66
68
|
* @param {string} targetDir
|
|
67
|
-
* @param {string} agent - Preset name: 'claude', 'cursor', 'codex', 'all'
|
|
69
|
+
* @param {string} agent - Preset name: 'claude', 'cursor', 'codex', 'hermes', 'all'
|
|
68
70
|
* @returns {{inject: string[], create: string[]}} Files to inject into vs create fresh
|
|
69
71
|
*/
|
|
70
72
|
export function resolveAgentPaths(targetDir, agent) {
|
|
@@ -386,7 +388,7 @@ export function removeAgentDocs(targetDir) {
|
|
|
386
388
|
* @param {object} [options]
|
|
387
389
|
* @param {boolean} [options.zh]
|
|
388
390
|
* @param {string} [options.lang]
|
|
389
|
-
* @param {string} [options.agent] - Tool preset: 'claude', 'cursor', 'codex', 'all'
|
|
391
|
+
* @param {string} [options.agent] - Tool preset: 'claude', 'cursor', 'codex', 'hermes', 'all'
|
|
390
392
|
* @param {string[]} [options.paths] - Explicit paths (overrides agent/auto-detect)
|
|
391
393
|
* @param {boolean} [options.onlyReplace] - Only update files that already have Astryx markers (for upgrades)
|
|
392
394
|
* @returns {string[]} List of files written
|
|
@@ -468,14 +470,14 @@ export function installAgentDocs(targetDir, {zh = false, lang, agent, paths, onl
|
|
|
468
470
|
return written;
|
|
469
471
|
}
|
|
470
472
|
|
|
471
|
-
const VALID_AGENTS = ['claude', 'cursor', 'codex', 'all'];
|
|
473
|
+
const VALID_AGENTS = ['claude', 'cursor', 'codex', 'hermes', 'all'];
|
|
472
474
|
|
|
473
475
|
export function registerAgentDocs(program) {
|
|
474
476
|
program
|
|
475
477
|
.command('agent-docs')
|
|
476
478
|
.description('Install/update the component index for AI coding agents')
|
|
477
479
|
.option('--remove', 'Remove the design system section from all agent doc files')
|
|
478
|
-
.option('--agent <tool>', 'Target tool: claude, cursor, codex, all')
|
|
480
|
+
.option('--agent <tool>', 'Target tool: claude, cursor, codex, hermes, all')
|
|
479
481
|
.option('--agent-docs-path <path...>', 'Explicit file path(s) to write to')
|
|
480
482
|
.action(options => {
|
|
481
483
|
const targetDir = process.cwd();
|
|
@@ -449,6 +449,17 @@ describe('installAgentDocs', () => {
|
|
|
449
449
|
expect(fs.existsSync(path.join(tmpDir, 'AGENTS.md'))).toBe(true);
|
|
450
450
|
});
|
|
451
451
|
|
|
452
|
+
it('respects --agent hermes preset: creates AGENTS.md', () => {
|
|
453
|
+
setupCorePackage(tmpDir);
|
|
454
|
+
|
|
455
|
+
const written = installAgentDocs(tmpDir, {agent: 'hermes'});
|
|
456
|
+
|
|
457
|
+
expect(written).toEqual(['AGENTS.md']);
|
|
458
|
+
const content = fs.readFileSync(path.join(tmpDir, 'AGENTS.md'), 'utf-8');
|
|
459
|
+
expect(content).toContain('<!-- ASTRYX:START -->');
|
|
460
|
+
expect(fs.existsSync(path.join(tmpDir, '.claude'))).toBe(false);
|
|
461
|
+
});
|
|
462
|
+
|
|
452
463
|
it('respects explicit --paths', () => {
|
|
453
464
|
setupCorePackage(tmpDir);
|
|
454
465
|
|
|
@@ -548,4 +559,26 @@ describe('resolveAgentPaths', () => {
|
|
|
548
559
|
expect(result.create).toContain('AGENTS.md');
|
|
549
560
|
expect(result.create).toContain('.claude/CLAUDE.md');
|
|
550
561
|
});
|
|
562
|
+
|
|
563
|
+
it('hermes preset creates AGENTS.md when nothing exists', () => {
|
|
564
|
+
const result = resolveAgentPaths(tmpDir, 'hermes');
|
|
565
|
+
expect(result).toEqual({inject: [], create: ['AGENTS.md']});
|
|
566
|
+
});
|
|
567
|
+
|
|
568
|
+
it('hermes preset finds existing .hermes.md', () => {
|
|
569
|
+
fs.writeFileSync(path.join(tmpDir, '.hermes.md'), '');
|
|
570
|
+
const result = resolveAgentPaths(tmpDir, 'hermes');
|
|
571
|
+
expect(result).toEqual({inject: ['.hermes.md'], create: []});
|
|
572
|
+
});
|
|
573
|
+
|
|
574
|
+
it('hermes preset finds existing HERMES.md when no .hermes.md', () => {
|
|
575
|
+
fs.writeFileSync(path.join(tmpDir, 'HERMES.md'), '');
|
|
576
|
+
const result = resolveAgentPaths(tmpDir, 'hermes');
|
|
577
|
+
expect(result).toEqual({inject: ['HERMES.md'], create: []});
|
|
578
|
+
});
|
|
579
|
+
|
|
580
|
+
it('claude preset still creates .claude/CLAUDE.md when nothing exists (hermes is additive)', () => {
|
|
581
|
+
const result = resolveAgentPaths(tmpDir, 'claude');
|
|
582
|
+
expect(result).toEqual({inject: [], create: ['.claude/CLAUDE.md']});
|
|
583
|
+
});
|
|
551
584
|
});
|
|
@@ -175,14 +175,85 @@ async function getKnownValues(componentName) {
|
|
|
175
175
|
return _knownValuesCache.get(componentName);
|
|
176
176
|
}
|
|
177
177
|
|
|
178
|
+
/**
|
|
179
|
+
* Resolve `@astryxdesign/core`'s package root relative to the CLI package. Core
|
|
180
|
+
* and the CLI ship as siblings (`@astryxdesign/core`, `@astryxdesign/cli`), so
|
|
181
|
+
* `../../../core` from `src/commands/` reaches core whether installed from npm
|
|
182
|
+
* or run inside the monorepo. Returns null if it can't be found.
|
|
183
|
+
*/
|
|
184
|
+
function resolveCoreRoot() {
|
|
185
|
+
const cliDir = path.dirname(fileURLToPath(import.meta.url));
|
|
186
|
+
const coreRoot = path.resolve(cliDir, '../../../core');
|
|
187
|
+
return fs.existsSync(coreRoot) ? coreRoot : null;
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* Read the type declarations `@astryxdesign/core/<Component>` exposes so we can
|
|
192
|
+
* check whether a given augmentation-target interface actually exists before
|
|
193
|
+
* generating a module augmentation against it.
|
|
194
|
+
*
|
|
195
|
+
* Reads the shipped `dist/<Component>/index.d.ts` (what a consumer's TypeScript
|
|
196
|
+
* actually sees), falling back to the `src/<Component>/index.ts` in the
|
|
197
|
+
* monorepo. Returns the file contents, or '' if nothing is found.
|
|
198
|
+
*/
|
|
199
|
+
const _componentDeclCache = new Map();
|
|
200
|
+
function readComponentDeclarations(pascalName) {
|
|
201
|
+
if (_componentDeclCache.has(pascalName)) {
|
|
202
|
+
return _componentDeclCache.get(pascalName);
|
|
203
|
+
}
|
|
204
|
+
let contents = '';
|
|
205
|
+
const coreRoot = resolveCoreRoot();
|
|
206
|
+
if (coreRoot) {
|
|
207
|
+
const candidates = [
|
|
208
|
+
path.join(coreRoot, 'dist', pascalName, 'index.d.ts'),
|
|
209
|
+
path.join(coreRoot, 'src', pascalName, 'index.ts'),
|
|
210
|
+
];
|
|
211
|
+
for (const file of candidates) {
|
|
212
|
+
try {
|
|
213
|
+
if (fs.existsSync(file)) {
|
|
214
|
+
contents = fs.readFileSync(file, 'utf-8');
|
|
215
|
+
break;
|
|
216
|
+
}
|
|
217
|
+
} catch {
|
|
218
|
+
// ignore and try the next candidate
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
_componentDeclCache.set(pascalName, contents);
|
|
223
|
+
return contents;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
/**
|
|
227
|
+
* Determine whether `@astryxdesign/core/<Component>` exports an interface named
|
|
228
|
+
* `interfaceName` that can be augmented via module augmentation.
|
|
229
|
+
*
|
|
230
|
+
* Only interfaces are extension points — closed literal-union types (e.g.
|
|
231
|
+
* `HeadingType`, `ButtonSize`) are NOT augmentable, so a generated augmentation
|
|
232
|
+
* against them is dead code. We check that the name is exported (directly or
|
|
233
|
+
* re-exported) as a type/interface.
|
|
234
|
+
*/
|
|
235
|
+
function componentHasAugmentableInterface(pascalName, interfaceName) {
|
|
236
|
+
const decl = readComponentDeclarations(pascalName);
|
|
237
|
+
if (!decl) return false;
|
|
238
|
+
// Word-boundary match so `ButtonVariantMap` doesn't match `XButtonVariantMap`.
|
|
239
|
+
const re = new RegExp(`\\b${interfaceName}\\b`);
|
|
240
|
+
return re.test(decl);
|
|
241
|
+
}
|
|
242
|
+
|
|
178
243
|
/**
|
|
179
244
|
* Generate TypeScript declaration content with module augmentation for custom
|
|
180
245
|
* component prop values found in the theme's `components` keys. Reads known
|
|
181
246
|
* values from doc files to filter out base prop values.
|
|
182
247
|
*
|
|
183
|
-
* Interface naming convention:
|
|
184
|
-
* banner + status →
|
|
185
|
-
* button + variant →
|
|
248
|
+
* Interface naming convention: PascalCase(component) + PascalCase(prop) + Map
|
|
249
|
+
* banner + status → BannerStatusMap
|
|
250
|
+
* button + variant → ButtonVariantMap
|
|
251
|
+
*
|
|
252
|
+
* An augmentation is only emitted when `@astryxdesign/core/<Component>` actually
|
|
253
|
+
* exports a matching interface. Props backed by closed literal-union types
|
|
254
|
+
* (e.g. Button `size`, Heading `type`/`level`) have no augmentation point, so
|
|
255
|
+
* generating a `declare module` block for them would be dead code — those are
|
|
256
|
+
* skipped.
|
|
186
257
|
*
|
|
187
258
|
* @param {object} themeDef - Theme definition (resolved by defineTheme)
|
|
188
259
|
* @returns {Promise<string|null>} TypeScript declaration content, or null if no augmentations needed
|
|
@@ -234,7 +305,14 @@ async function generateVariantDeclarationsAsync(themeDef) {
|
|
|
234
305
|
const pascal = toPascalCase(component);
|
|
235
306
|
const propPascal = prop.charAt(0).toUpperCase() + prop.slice(1);
|
|
236
307
|
const modulePath = `@astryxdesign/core/${pascal}`;
|
|
237
|
-
const interfaceName =
|
|
308
|
+
const interfaceName = `${pascal}${propPascal}Map`;
|
|
309
|
+
|
|
310
|
+
// Only augment interfaces that actually exist as an extension point in
|
|
311
|
+
// core. Props backed by closed literal-union types (e.g. Button `size`,
|
|
312
|
+
// Heading `type`/`level`) have no `*Map` interface — a `declare module`
|
|
313
|
+
// block against a non-existent interface just creates a new, unused
|
|
314
|
+
// interface and never extends the component's prop union, so skip it.
|
|
315
|
+
if (!componentHasAugmentableInterface(pascal, interfaceName)) continue;
|
|
238
316
|
|
|
239
317
|
sections.push(`declare module '${modulePath}' {`);
|
|
240
318
|
sections.push(` interface ${interfaceName} {`);
|
|
@@ -247,6 +325,13 @@ async function generateVariantDeclarationsAsync(themeDef) {
|
|
|
247
325
|
}
|
|
248
326
|
}
|
|
249
327
|
|
|
328
|
+
// If every custom value targeted a non-augmentable prop, there's nothing to
|
|
329
|
+
// emit beyond the header — return null so no `.variants.d.ts` is written.
|
|
330
|
+
const hasEmittedAugmentation = sections.some(line =>
|
|
331
|
+
line.startsWith('declare module'),
|
|
332
|
+
);
|
|
333
|
+
if (!hasEmittedAugmentation) return null;
|
|
334
|
+
|
|
250
335
|
return sections.join('\n');
|
|
251
336
|
}
|
|
252
337
|
|
|
@@ -433,13 +518,21 @@ ${iconReExport}`;
|
|
|
433
518
|
/**
|
|
434
519
|
* Generate TypeScript declarations for a built theme module.
|
|
435
520
|
*/
|
|
436
|
-
function generateBuiltTypes(themeDef, iconInfo) {
|
|
521
|
+
function generateBuiltTypes(themeDef, iconInfo, variantsFileName) {
|
|
437
522
|
const iconType = iconInfo
|
|
438
523
|
? `import type { IconRegistry } from '@astryxdesign/core/Icon';
|
|
439
524
|
export declare const ${iconInfo.exportName}: IconRegistry;
|
|
440
525
|
`
|
|
441
526
|
: '';
|
|
442
|
-
|
|
527
|
+
// Pull in the generated custom-variant augmentations so that importing the
|
|
528
|
+
// theme's types also loads the module augmentations (otherwise the
|
|
529
|
+
// `.variants.d.ts` is emitted but never referenced, and the custom variants
|
|
530
|
+
// never widen the component prop unions for consumers).
|
|
531
|
+
const variantsRef = variantsFileName
|
|
532
|
+
? `/// <reference path="./${variantsFileName}" />
|
|
533
|
+
`
|
|
534
|
+
: '';
|
|
535
|
+
return `${variantsRef}import type { DefinedTheme } from '@astryxdesign/core/theme';
|
|
443
536
|
${iconType}export declare const ${toIdentifier(themeDef.name)}Theme: DefinedTheme;
|
|
444
537
|
`;
|
|
445
538
|
}
|
|
@@ -894,19 +987,23 @@ export function registerTheme(program) {
|
|
|
894
987
|
|
|
895
988
|
const iconInfo = extractIconInfo(filePath);
|
|
896
989
|
|
|
897
|
-
//
|
|
898
|
-
|
|
899
|
-
const jsContent = generatedHeader(sourceRelative, 'js', buildCommand) + generateBuiltModule(resolvedTheme || themeDef, iconInfo);
|
|
900
|
-
const dtsContent = generatedHeader(sourceRelative, 'ts', buildCommand) + generateBuiltTypes(themeDef, iconInfo);
|
|
901
|
-
|
|
902
|
-
// Type augmentation .d.ts if theme has custom prop values
|
|
990
|
+
// Type augmentation .d.ts if theme has custom prop values. Computed
|
|
991
|
+
// before the main .d.ts so the latter can reference it (see below).
|
|
903
992
|
const augmentationSource = resolvedTheme || themeDef;
|
|
904
993
|
const variantDecl = await generateVariantDeclarationsAsync(augmentationSource);
|
|
905
|
-
const
|
|
994
|
+
const variantsFileName = variantDecl ? `${baseName}.variants.d.ts` : null;
|
|
995
|
+
const variantDtsPath = variantDecl ? path.join(outDir, variantsFileName) : null;
|
|
906
996
|
const variantContent = variantDecl
|
|
907
997
|
? generatedHeader(sourceRelative, 'ts', buildCommand) + variantDecl
|
|
908
998
|
: null;
|
|
909
999
|
|
|
1000
|
+
// Generate all file contents in memory first. The main .d.ts references
|
|
1001
|
+
// the variants file (when present) via a triple-slash directive so
|
|
1002
|
+
// importing the theme also loads the custom-variant augmentations.
|
|
1003
|
+
const cssContent = generatedHeader(sourceRelative, 'css', buildCommand) + css;
|
|
1004
|
+
const jsContent = generatedHeader(sourceRelative, 'js', buildCommand) + generateBuiltModule(resolvedTheme || themeDef, iconInfo);
|
|
1005
|
+
const dtsContent = generatedHeader(sourceRelative, 'ts', buildCommand) + generateBuiltTypes(themeDef, iconInfo, variantsFileName);
|
|
1006
|
+
|
|
910
1007
|
// Atomic-ish write: stage every file as `<dest>.tmp`, then rename
|
|
911
1008
|
// each into place. If any stage step fails we clean up partials and
|
|
912
1009
|
// exit; if a rename fails mid-way we still have the originals (or
|