@astryxdesign/cli 0.1.4-canary.e67f422 → 0.1.4-canary.e9b31f8
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/docs/styling.doc.mjs +53 -0
- package/package.json +10 -10
- 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.color-scheme.test.mjs +153 -0
- package/src/commands/build-theme.mjs +8 -1
- package/src/commands/build-theme.variants.test.mjs +7 -18
- package/src/commands/doctor.test.mjs +34 -0
- package/src/commands/init.mjs +1 -1
- package/src/commands/swizzle.mjs +34 -0
- package/src/commands/swizzle.routing.test.mjs +67 -0
- package/templates/blocks/components/CodeBlock/CodeBlockTerminal.doc.mjs +1 -1
- package/templates/blocks/components/Collapsible/CollapsibleWithoutCard.tsx +25 -23
- 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/pages/classic-gallery/page.tsx +1 -1
- package/templates/pages/dashboard/page.tsx +1 -1
- package/templates/pages/documentation/page.tsx +1 -1
- package/templates/pages/incident-console/page.tsx +580 -0
- package/templates/pages/incident-console/template.doc.mjs +12 -0
- package/templates/pages/messaging-shell/page.tsx +676 -0
- package/templates/pages/messaging-shell/template.doc.mjs +12 -0
- package/templates/pages/mixed-gallery/page.tsx +1 -1
- package/templates/pages/payment-form/page.tsx +2 -6
- package/templates/pages/product-detail/page.tsx +3 -11
- package/templates/pages/product-gallery/page.tsx +1 -1
- package/templates/pages/settings/page.tsx +1 -1
- package/templates/pages/side-gallery/page.tsx +1 -1
- package/templates/pages/table-page/page.tsx +1 -1
- package/templates/pages/table-page-chart/page.tsx +1 -1
- package/templates/pages/table-page-heatmap-status/page.tsx +1 -1
- package/templates/pages/table-page-shoe-store-heatmap/page.tsx +1 -1
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/docs/styling.doc.mjs
CHANGED
|
@@ -338,6 +338,59 @@ const styles = stylex.create({
|
|
|
338
338
|
},
|
|
339
339
|
],
|
|
340
340
|
},
|
|
341
|
+
{
|
|
342
|
+
title: 'StyleX Build Setup (required for swizzled components)',
|
|
343
|
+
category: 'guide',
|
|
344
|
+
content: [
|
|
345
|
+
{
|
|
346
|
+
type: 'prose',
|
|
347
|
+
text: 'Astryx components ship pre-compiled, so consuming the published package needs no StyleX setup. But `astryx swizzle <Component>` copies the raw StyleX *source* into your app, and StyleX source requires a build-time StyleX compiler to produce atomic CSS. Without one the component compiles but renders completely unstyled: no error, no warning. If a swizzled component looks unstyled, a missing StyleX compiler is almost always why. The same applies if you author your own StyleX with `stylex.create()`.',
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
type: 'table',
|
|
351
|
+
headers: ['Bundler', 'StyleX plugin'],
|
|
352
|
+
rows: [
|
|
353
|
+
['Webpack', '@stylexjs/webpack-plugin'],
|
|
354
|
+
['Vite / Rollup', '@stylexjs/rollup-plugin (or a community Vite plugin)'],
|
|
355
|
+
['Babel (any bundler)', '@stylexjs/babel-plugin + @stylexjs/postcss-plugin'],
|
|
356
|
+
['Next.js (App Router, SWC)', 'An SWC-based transform; see the Next.js note below'],
|
|
357
|
+
],
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
type: 'prose',
|
|
361
|
+
text: 'Next.js (App Router) is the sharp edge. StyleX\'s canonical compiler is a Babel plugin, but introducing a Babel config in Next.js disables the SWC compiler, which in turn breaks SWC-dependent features like `next/font`. So the "obvious" Babel setup is actively incompatible with a standard Next 15 App Router app.',
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
type: 'prose',
|
|
365
|
+
text: 'The working path on Next.js is an SWC-based StyleX transform (e.g. the community `@stylexswc/nextjs-plugin`) wired into `next.config`, which keeps SWC and `next/font` intact. See the example app `apps/example-nextjs-stylex` in the repo for a complete, working Next.js + StyleX + SWC configuration.',
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
type: 'code',
|
|
369
|
+
lang: 'js',
|
|
370
|
+
label: 'next.config.mjs: SWC-based StyleX transform (keeps next/font working)',
|
|
371
|
+
code: `import stylexPlugin from '@stylexswc/nextjs-plugin';
|
|
372
|
+
|
|
373
|
+
export default stylexPlugin({
|
|
374
|
+
rsOptions: {
|
|
375
|
+
// Resolve @astryxdesign/core's StyleX so swizzled component source compiles.
|
|
376
|
+
aliases: {'@/*': ['./src/*']},
|
|
377
|
+
unstable_moduleResolution: {type: 'commonJS'},
|
|
378
|
+
},
|
|
379
|
+
})({
|
|
380
|
+
// your existing Next.js config
|
|
381
|
+
});`,
|
|
382
|
+
},
|
|
383
|
+
{
|
|
384
|
+
type: 'list',
|
|
385
|
+
style: 'unordered',
|
|
386
|
+
items: [
|
|
387
|
+
'Symptom of a missing compiler: swizzled component renders with no styles, but no build or runtime error.',
|
|
388
|
+
'Do NOT add @stylexjs/babel-plugin to a Next.js App Router app; it disables SWC and breaks next/font.',
|
|
389
|
+
'Pure theming (defineTheme + astryx theme build) needs NO StyleX compiler; only swizzled/authored StyleX source does.',
|
|
390
|
+
],
|
|
391
|
+
},
|
|
392
|
+
],
|
|
393
|
+
},
|
|
341
394
|
{
|
|
342
395
|
title: 'What NOT to Do',
|
|
343
396
|
category: 'guide',
|
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.e9b31f8",
|
|
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",
|
|
@@ -68,17 +68,17 @@
|
|
|
68
68
|
"CHANGELOG.md"
|
|
69
69
|
],
|
|
70
70
|
"dependencies": {
|
|
71
|
-
"@clack/prompts": "^1.
|
|
71
|
+
"@clack/prompts": "^1.7.0",
|
|
72
72
|
"commander": "^12.1.0",
|
|
73
73
|
"jiti": "^2.7.0",
|
|
74
74
|
"jscodeshift": "^17.3.0",
|
|
75
75
|
"zod": "^4.4.3"
|
|
76
76
|
},
|
|
77
77
|
"peerDependencies": {
|
|
78
|
-
"@astryxdesign/charts": "0.1.4-canary.
|
|
79
|
-
"@astryxdesign/core": "0.1.4-canary.
|
|
80
|
-
"@astryxdesign/lab": "0.1.4-canary.
|
|
81
|
-
"@astryxdesign/theme-neutral": "0.1.4-canary.
|
|
78
|
+
"@astryxdesign/charts": "0.1.4-canary.e9b31f8",
|
|
79
|
+
"@astryxdesign/core": "0.1.4-canary.e9b31f8",
|
|
80
|
+
"@astryxdesign/lab": "0.1.4-canary.e9b31f8",
|
|
81
|
+
"@astryxdesign/theme-neutral": "0.1.4-canary.e9b31f8",
|
|
82
82
|
"gpt-tokenizer": "^3.4.0"
|
|
83
83
|
},
|
|
84
84
|
"peerDependenciesMeta": {
|
|
@@ -96,10 +96,10 @@
|
|
|
96
96
|
}
|
|
97
97
|
},
|
|
98
98
|
"devDependencies": {
|
|
99
|
-
"@astryxdesign/charts": "0.1.4-canary.
|
|
100
|
-
"@astryxdesign/core": "0.1.4-canary.
|
|
101
|
-
"@astryxdesign/lab": "0.1.4-canary.
|
|
102
|
-
"@astryxdesign/theme-neutral": "0.1.4-canary.
|
|
99
|
+
"@astryxdesign/charts": "0.1.4-canary.e9b31f8",
|
|
100
|
+
"@astryxdesign/core": "0.1.4-canary.e9b31f8",
|
|
101
|
+
"@astryxdesign/lab": "0.1.4-canary.e9b31f8",
|
|
102
|
+
"@astryxdesign/theme-neutral": "0.1.4-canary.e9b31f8",
|
|
103
103
|
"gpt-tokenizer": "^3.4.0"
|
|
104
104
|
},
|
|
105
105
|
"scripts": {
|
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
|
});
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file Regression test for the `color-scheme` declaration `astryx theme build`
|
|
5
|
+
* emits alongside `light-dark()` token output (see #3658).
|
|
6
|
+
*
|
|
7
|
+
* `astryx theme build` injects a `color-scheme` declaration into
|
|
8
|
+
* `@layer astryx-theme` whenever the generated CSS contains `light-dark()`,
|
|
9
|
+
* so LightningCSS/browsers can resolve it. That declaration must mirror
|
|
10
|
+
* reset.css's own `html[data-theme]` -> `color-scheme` mapping (a bare
|
|
11
|
+
* `:root { color-scheme: light dark; }` alone permanently pins the page to
|
|
12
|
+
* "light dark", defeating `<Theme mode="light|dark">` forcing regardless of
|
|
13
|
+
* `@layer astryx-theme` being declared after `@layer reset` in layer order):
|
|
14
|
+
*
|
|
15
|
+
* :root { color-scheme: light dark; }
|
|
16
|
+
* html[data-theme="light"] { color-scheme: light; }
|
|
17
|
+
* html[data-theme="dark"] { color-scheme: dark; }
|
|
18
|
+
*
|
|
19
|
+
* Themes that never use `light-dark()` have no `color-scheme` ambiguity to
|
|
20
|
+
* resolve, so none of the three rules should be emitted for them.
|
|
21
|
+
*
|
|
22
|
+
* Building `astryx theme build` requires a compiled @astryxdesign/core (there is no in-CLI
|
|
23
|
+
* fallback generator), so this suite builds core once in beforeAll via the
|
|
24
|
+
* shared ensureCoreBuilt() helper — which serializes concurrent Vitest workers
|
|
25
|
+
* behind a lock — to stay self-sufficient regardless of CI job ordering.
|
|
26
|
+
*/
|
|
27
|
+
|
|
28
|
+
import {describe, it, expect, beforeAll, beforeEach, afterEach} from 'vitest';
|
|
29
|
+
import {execFileSync} from 'node:child_process';
|
|
30
|
+
import * as fs from 'node:fs';
|
|
31
|
+
import * as path from 'node:path';
|
|
32
|
+
import * as os from 'node:os';
|
|
33
|
+
import {fileURLToPath} from 'node:url';
|
|
34
|
+
import {ensureCoreBuilt} from './ensure-core-built.mjs';
|
|
35
|
+
|
|
36
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
37
|
+
const CLI_BIN = path.resolve(__dirname, '../../bin/astryx.mjs');
|
|
38
|
+
|
|
39
|
+
const COLOR_SCHEME_ROOT_DECL = ':root { color-scheme: light dark; }';
|
|
40
|
+
const COLOR_SCHEME_LIGHT_DECL = 'html[data-theme="light"] { color-scheme: light; }';
|
|
41
|
+
const COLOR_SCHEME_DARK_DECL = 'html[data-theme="dark"] { color-scheme: dark; }';
|
|
42
|
+
|
|
43
|
+
function runCli(args, cwd) {
|
|
44
|
+
try {
|
|
45
|
+
const out = execFileSync('node', [CLI_BIN, ...args], {
|
|
46
|
+
cwd,
|
|
47
|
+
encoding: 'utf-8',
|
|
48
|
+
stdio: ['ignore', 'pipe', 'pipe'],
|
|
49
|
+
env: {...process.env, FORCE_COLOR: '0'},
|
|
50
|
+
});
|
|
51
|
+
return {code: 0, stdout: out, stderr: ''};
|
|
52
|
+
} catch (e) {
|
|
53
|
+
return {
|
|
54
|
+
code: e.status ?? 1,
|
|
55
|
+
stdout: e.stdout?.toString() ?? '',
|
|
56
|
+
stderr: e.stderr?.toString() ?? '',
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
function writeTheme(dir, name, tokens) {
|
|
62
|
+
fs.mkdirSync(dir, {recursive: true});
|
|
63
|
+
// The CLI writes <basename>.css next to the source file, so use the
|
|
64
|
+
// theme name as the filename for unambiguous fixtures.
|
|
65
|
+
const file = path.join(dir, `${name}.mjs`);
|
|
66
|
+
fs.writeFileSync(
|
|
67
|
+
file,
|
|
68
|
+
`export default { name: ${JSON.stringify(name)}, tokens: ${JSON.stringify(tokens)} };\n`,
|
|
69
|
+
);
|
|
70
|
+
return file;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// `astryx theme build` imports the compiled @astryxdesign/core/theme entry. Build core
|
|
74
|
+
// once if it isn't already present so the suite works in any CI job.
|
|
75
|
+
beforeAll(() => {
|
|
76
|
+
ensureCoreBuilt();
|
|
77
|
+
}, 200_000);
|
|
78
|
+
|
|
79
|
+
let tmpDir;
|
|
80
|
+
beforeEach(() => {
|
|
81
|
+
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-build-theme-color-scheme-'));
|
|
82
|
+
});
|
|
83
|
+
afterEach(() => {
|
|
84
|
+
fs.rmSync(tmpDir, {recursive: true, force: true});
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
describe('theme build color-scheme output', () => {
|
|
88
|
+
it('emits the mode-aware color-scheme rules in @layer astryx-theme for a light-dark() theme', () => {
|
|
89
|
+
const project = path.join(tmpDir, 'project');
|
|
90
|
+
const themesDir = path.join(project, 'themes');
|
|
91
|
+
// A raw light-dark() token value is what triggers the color-scheme
|
|
92
|
+
// injection in build-theme.mjs (it checks the generated CSS for the
|
|
93
|
+
// literal substring). `defineTheme.test.ts` already covers the separate
|
|
94
|
+
// [light, dark] tuple -> light-dark() conversion; this fixture writes
|
|
95
|
+
// the string directly so this test stays focused on the CLI's own
|
|
96
|
+
// color-scheme decision, not on that conversion.
|
|
97
|
+
const themeFile = writeTheme(themesDir, 'with-light-dark', {
|
|
98
|
+
'--color-accent': 'light-dark(#0077B6, #48CAE4)',
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
const result = runCli(
|
|
102
|
+
['theme', 'build', path.relative(project, themeFile)],
|
|
103
|
+
project,
|
|
104
|
+
);
|
|
105
|
+
|
|
106
|
+
expect(result.code).toBe(0);
|
|
107
|
+
|
|
108
|
+
const cssPath = path.join(themesDir, 'with-light-dark.css');
|
|
109
|
+
expect(fs.existsSync(cssPath)).toBe(true);
|
|
110
|
+
const css = fs.readFileSync(cssPath, 'utf-8');
|
|
111
|
+
|
|
112
|
+
expect(css).toContain('light-dark(#0077B6, #48CAE4)');
|
|
113
|
+
|
|
114
|
+
// All 3 rules must be present...
|
|
115
|
+
expect(css).toContain(COLOR_SCHEME_ROOT_DECL);
|
|
116
|
+
expect(css).toContain(COLOR_SCHEME_LIGHT_DECL);
|
|
117
|
+
expect(css).toContain(COLOR_SCHEME_DARK_DECL);
|
|
118
|
+
|
|
119
|
+
// ...and specifically inside @layer astryx-theme, not @layer reset (the
|
|
120
|
+
// declaration must sit alongside the light-dark() token/component output
|
|
121
|
+
// it resolves, not the zero-specificity prose defaults).
|
|
122
|
+
const themeLayerStart = css.indexOf('@layer astryx-theme');
|
|
123
|
+
expect(themeLayerStart).toBeGreaterThanOrEqual(0);
|
|
124
|
+
const themeLayerBody = css.slice(themeLayerStart);
|
|
125
|
+
expect(themeLayerBody).toContain(COLOR_SCHEME_ROOT_DECL);
|
|
126
|
+
expect(themeLayerBody).toContain(COLOR_SCHEME_LIGHT_DECL);
|
|
127
|
+
expect(themeLayerBody).toContain(COLOR_SCHEME_DARK_DECL);
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
it('omits all color-scheme rules for a theme with no light-dark() tokens', () => {
|
|
131
|
+
const project = path.join(tmpDir, 'project');
|
|
132
|
+
const themesDir = path.join(project, 'themes');
|
|
133
|
+
const themeFile = writeTheme(themesDir, 'no-light-dark', {
|
|
134
|
+
'--color-accent': '#0077B6',
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
const result = runCli(
|
|
138
|
+
['theme', 'build', path.relative(project, themeFile)],
|
|
139
|
+
project,
|
|
140
|
+
);
|
|
141
|
+
|
|
142
|
+
expect(result.code).toBe(0);
|
|
143
|
+
|
|
144
|
+
const cssPath = path.join(themesDir, 'no-light-dark.css');
|
|
145
|
+
expect(fs.existsSync(cssPath)).toBe(true);
|
|
146
|
+
const css = fs.readFileSync(cssPath, 'utf-8');
|
|
147
|
+
|
|
148
|
+
expect(css).not.toContain('light-dark(');
|
|
149
|
+
expect(css).not.toContain(COLOR_SCHEME_ROOT_DECL);
|
|
150
|
+
expect(css).not.toContain(COLOR_SCHEME_LIGHT_DECL);
|
|
151
|
+
expect(css).not.toContain(COLOR_SCHEME_DARK_DECL);
|
|
152
|
+
});
|
|
153
|
+
});
|
|
@@ -939,8 +939,15 @@ export function registerTheme(program) {
|
|
|
939
939
|
if (component.length > 0) {
|
|
940
940
|
const componentInner = component.join('\n\n');
|
|
941
941
|
const componentScope = `@scope (${scopeSelector}) to (${scopeTo}) {\n${componentInner}\n}`;
|
|
942
|
+
// light-dark() needs a color-scheme declaration in this bundle, but a
|
|
943
|
+
// bare `:root { color-scheme: light dark }` outranks reset.css's
|
|
944
|
+
// `html[data-theme]` mapping (astryx-theme layer comes after reset),
|
|
945
|
+
// silently defeating `<Theme mode>` forcing on <html>. Mirror the
|
|
946
|
+
// attribute-keyed mapping so the declaration follows the active mode.
|
|
942
947
|
const colorSchemeDecl = componentScope.includes('light-dark(')
|
|
943
|
-
? ' :root { color-scheme: light dark; }\n
|
|
948
|
+
? ' :root { color-scheme: light dark; }\n' +
|
|
949
|
+
' html[data-theme="light"] { color-scheme: light; }\n' +
|
|
950
|
+
' html[data-theme="dark"] { color-scheme: dark; }\n\n'
|
|
944
951
|
: '';
|
|
945
952
|
cssParts.push(
|
|
946
953
|
`@layer astryx-theme {\n${colorSchemeDecl}${componentScope}\n}`,
|