@astryxdesign/cli 0.1.4 → 0.1.5-canary.76e6697
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 +45 -1
- package/docs/getting-started.doc.mjs +4 -0
- package/docs/migration.doc.mjs +134 -0
- package/docs/styling.doc.mjs +53 -0
- package/docs/working-with-ai.doc.mjs +1 -1
- package/package.json +15 -10
- package/src/api/component.mjs +2 -1
- package/src/api/doctor.mjs +13 -2
- package/src/api/template.mjs +14 -3
- package/src/codemods/__tests__/registry.test.mjs +1 -0
- package/src/codemods/__tests__/runner.test.mjs +38 -0
- package/src/codemods/registry.mjs +1 -0
- package/src/codemods/runner.mjs +2 -0
- package/src/codemods/transforms/v0.1.5/__tests__/rename-switch-label-spacing-default-to-hug.test.mjs +93 -0
- package/src/codemods/transforms/v0.1.5/index.mjs +19 -0
- package/src/codemods/transforms/v0.1.5/rename-switch-label-spacing-default-to-hug.mjs +140 -0
- package/src/commands/agent-docs.mjs +9 -6
- 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 +112 -14
- package/src/commands/build-theme.variants.test.mjs +193 -0
- package/src/commands/component-resolution.test.mjs +4 -4
- 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/src/lib/component-discovery.mjs +8 -4
- package/templates/blocks/components/AspectRatio/AspectRatioCircleImage.tsx +1 -6
- package/templates/blocks/components/AspectRatio/AspectRatioImageGallery.tsx +2 -7
- package/templates/blocks/components/AspectRatio/AspectRatioShowcase.tsx +2 -5
- package/templates/blocks/components/AspectRatio/AspectRatioSquareImage.tsx +1 -6
- package/templates/blocks/components/AspectRatio/AspectRatioWidescreen.tsx +1 -6
- 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/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/blocks/components/NavHeadingMenu/NavHeadingMenuShowcase.doc.mjs +15 -0
- package/templates/blocks/components/NavHeadingMenu/NavHeadingMenuShowcase.tsx +47 -0
- package/templates/blocks/components/Table/TableGroupedRowsTable.doc.mjs +14 -0
- package/templates/blocks/components/Table/TableGroupedRowsTable.tsx +66 -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/kanban-board/page.tsx +37 -13
- 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 +4 -14
- package/templates/pages/table-page-heatmap-status/page.tsx +1 -1
- package/templates/pages/table-page-shoe-store-heatmap/page.tsx +5 -19
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,48 @@
|
|
|
1
1
|
# @xds/cli
|
|
2
2
|
|
|
3
|
+
# 0.1.5
|
|
4
|
+
|
|
5
|
+
#### New Features
|
|
6
|
+
|
|
7
|
+
- Add a v0.1.5 upgrade codemod that renames `labelSpacing="default"` to `labelSpacing="hug"` on Switch. (#2889)
|
|
8
|
+
- New `incident-console` page template: an on-call incident response console demonstrating the frame-first tracker archetype — grouped dense incident rows (StatusDot severity, Token state), PowerSearch filtering, status segmented control, and a resizable inspector panel with metadata and timeline. Adds the `Tools - Incident Console` template category.
|
|
9
|
+
- New `messaging-shell` page template: Slack-style column frame (rail | sidebar | stream | thread panel) built on the Chat component family — dense rows, zero cards. Adds the `Shell - Messaging` template category.
|
|
10
|
+
|
|
11
|
+
#### Fixes
|
|
12
|
+
|
|
13
|
+
- Fill viewport height across CLI page templates so the background covers the full page (#3762)
|
|
14
|
+
- `astryx init --features agents` now supports `--agent hermes`. The preset injects the component index into an existing `.hermes.md`/`HERMES.md` (Hermes Agent's top-priority project-context files) and otherwise creates root `AGENTS.md`, which Hermes loads from the project root — unlike the `.claude/CLAUDE.md` default. Additive only: existing `claude`/`cursor`/`codex`/`all`/auto-detect behavior is unchanged. (#2187)
|
|
15
|
+
- cli: `astryx doctor` now detects `@astryxdesign/theme-*` packages in pnpm projects. pnpm installs packages as symlinks into `node_modules/.pnpm`, and the theme scan only accepted real directories, so every symlinked theme package was skipped and doctor warned that none were installed (#3530).
|
|
16
|
+
- Make `astryx theme build`'s color-scheme declaration mode-aware, so built themes with `light-dark()` tokens no longer defeat `<Theme mode="light|dark">` forcing (#3660)
|
|
17
|
+
- `runCodemods` now returns `writtenFiles`, so `astryx upgrade`'s post-codemod hooks (prettier/eslint formatting) actually run on core-codemod changes.
|
|
18
|
+
The runner built the `writtenFiles` list internally but omitted it from its return object, so `upgrade.mjs` read `codemodResult.writtenFiles ?? []` as always-empty and the configured `hooks.postCodemod` (e.g. `prettier --write`, `eslint --fix`) received no files and silently skipped. As a result, jscodeshift's default double-quote output (`"@astryxdesign/core/Button"`) was never reformatted to the project's style, failing `prettier-format` lint on migrated apps. The sibling `integration-runner` already returned `writtenFiles` correctly, so integration-codemod changes were formatted while core-codemod changes were not.
|
|
19
|
+
- `astryx swizzle`: swizzled components ship raw StyleX source that needs a build-time StyleX compiler, and without one they render unstyled with no error. The command now prints a StyleX build-setup note after copying (including the Next.js caveat that the StyleX Babel plugin disables SWC and breaks `next/font`, so an SWC-based transform is required), and `astryx docs styling` gains a "StyleX Build Setup" section covering per-bundler setup. (#3373)
|
|
20
|
+
- `astryx theme build`: custom component variants declared in a theme (e.g. `button['variant:accentOutline']`) now generate a type augmentation against the component's real interface (`ButtonVariantMap`) instead of a non-existent `XDS`-prefixed one, so `variant="accentOutline"` type-checks. Props with no augmentation point (closed unions like Button `size` or Heading `type`) are skipped instead of emitting dead augmentations, and the generated `.variants.d.ts` is now referenced from the theme's `.d.ts` so the augmentation actually loads. (#3371)
|
|
21
|
+
|
|
22
|
+
#### Documentation
|
|
23
|
+
|
|
24
|
+
- CodeBlock: terminal-style dark block template (syntaxTheme preset)
|
|
25
|
+
- Add cascade-layer safety guidance to the migration guide (`astryx docs migration`): a Cascade Layer Safety audit checklist (unlayered styles and later layers both beat `astryx-base` regardless of specificity, classify every stylesheet into a layer deliberately, layer Tailwind preflight on both v3 and v4) and a Foundation Smoke Test section (one page with Button/TextInput/Card/Table plus a non-zero-padding assertion) so a broken layer order fails before feature work instead of after N migrated screens. The getting-started guide now points to it from the theme CSS step.
|
|
26
|
+
- NavHeadingMenu: add a playground config and showcase block so the Overview tab has a working preview (#2698)
|
|
27
|
+
- NavHeadingMenu: constrain the showcase SideNav to a shorter height so the heading no longer appears to float at the top of the Overview preview (#2698)
|
|
28
|
+
|
|
29
|
+
#### Contributors
|
|
30
|
+
|
|
31
|
+
Thanks to everyone who contributed to this release:
|
|
32
|
+
|
|
33
|
+
- @arman-luthra
|
|
34
|
+
- @cixzhang
|
|
35
|
+
- @ejhammond
|
|
36
|
+
- @harjothkhara
|
|
37
|
+
- @is-jain
|
|
38
|
+
- @jiunshinn
|
|
39
|
+
- @josephfarina
|
|
40
|
+
- @let-sunny
|
|
41
|
+
- @thedjpetersen
|
|
42
|
+
- @zeroryu
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
3
46
|
# 0.1.4
|
|
4
47
|
|
|
5
48
|
#### Fixes
|
|
@@ -36,7 +79,7 @@ Thanks to everyone who contributed to this release:
|
|
|
36
79
|
- Strict config + integration v1 schema (integrations, issuesUrl, hooks.postCodemod) and new @astryxdesign/cli/integration export.
|
|
37
80
|
- File-based codemod API (createCodemod/createConfigCodemod) with the @astryxdesign/cli/codemod export and integration codemod discovery in upgrade.
|
|
38
81
|
- 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.
|
|
82
|
+
- 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
83
|
- 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
84
|
- Add a v0.1.3 config codemod that migrates astryx.config layout.components to experimental.xle.components.
|
|
42
85
|
- 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 +123,7 @@ Thanks to everyone who contributed to this release:
|
|
|
80
123
|
Thanks to everyone who contributed to this release:
|
|
81
124
|
|
|
82
125
|
- @AKnassa
|
|
126
|
+
- @cg-hub18
|
|
83
127
|
- @ejhammond
|
|
84
128
|
- @ernestt
|
|
85
129
|
- @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',
|
|
@@ -125,7 +125,7 @@ If you don't know all three, run \`npx astryx init --features agents\` to genera
|
|
|
125
125
|
lang: 'json',
|
|
126
126
|
label: 'package.json',
|
|
127
127
|
code: `"scripts": {
|
|
128
|
-
"
|
|
128
|
+
"astryx": "node node_modules/@astryxdesign/cli/bin/astryx.mjs"
|
|
129
129
|
}`,
|
|
130
130
|
},
|
|
131
131
|
{
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@astryxdesign/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5-canary.76e6697",
|
|
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,19 +68,23 @@
|
|
|
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/
|
|
79
|
-
"@astryxdesign/
|
|
80
|
-
"@astryxdesign/
|
|
81
|
-
"
|
|
78
|
+
"@astryxdesign/charts": "0.1.5-canary.76e6697",
|
|
79
|
+
"@astryxdesign/core": "0.1.5-canary.76e6697",
|
|
80
|
+
"@astryxdesign/lab": "0.1.5-canary.76e6697",
|
|
81
|
+
"@astryxdesign/theme-neutral": "0.1.5-canary.76e6697",
|
|
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.5-canary.76e6697",
|
|
100
|
+
"@astryxdesign/core": "0.1.5-canary.76e6697",
|
|
101
|
+
"@astryxdesign/lab": "0.1.5-canary.76e6697",
|
|
102
|
+
"@astryxdesign/theme-neutral": "0.1.5-canary.76e6697",
|
|
103
|
+
"gpt-tokenizer": "^3.4.0"
|
|
99
104
|
},
|
|
100
105
|
"scripts": {
|
|
101
106
|
"astryx": "node bin/astryx.mjs",
|
package/src/api/component.mjs
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
import * as fs from 'node:fs';
|
|
11
|
+
import * as path from 'node:path';
|
|
11
12
|
import {ERROR_CODES} from '../lib/error-codes.mjs';
|
|
12
13
|
import {findCoreDir, discoverExternalPackages} from '../utils/paths.mjs';
|
|
13
14
|
import {
|
|
@@ -560,7 +561,7 @@ export async function component(name, options = {}) {
|
|
|
560
561
|
|
|
561
562
|
// Examples: blocks in the component's own directory, or
|
|
562
563
|
// componentsUsed match for sub-components without a directory.
|
|
563
|
-
const ownDir = allBlocks.filter(b => b.category
|
|
564
|
+
const ownDir = allBlocks.filter(b => path.basename(b.category) === dirName);
|
|
564
565
|
const examples = ownDir.length > 0
|
|
565
566
|
? ownDir
|
|
566
567
|
: allBlocks.filter(b => b.componentsUsed?.some(c => c === dirName));
|
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
|
}
|
package/src/api/template.mjs
CHANGED
|
@@ -63,6 +63,17 @@ const DEMO_IMAGE_PATTERNS = [
|
|
|
63
63
|
/https?:\/\/(?:[\w-]+\.)*lookaside\.facebook\.com\/[^\s'"`)]+/g,
|
|
64
64
|
];
|
|
65
65
|
|
|
66
|
+
/**
|
|
67
|
+
* Normalize path into Unix path (using forward slashes) for consistent comparison
|
|
68
|
+
* across Windows, macOS, and Linux.
|
|
69
|
+
*
|
|
70
|
+
* @param {string} p - The file path to normalize.
|
|
71
|
+
* @returns {string} The normalized Unix path.
|
|
72
|
+
*/
|
|
73
|
+
function toPosixPath(p) {
|
|
74
|
+
return p.replace(/\\/g, '/');
|
|
75
|
+
}
|
|
76
|
+
|
|
66
77
|
/**
|
|
67
78
|
* Replace demo image references with a self-contained placeholder data URI so
|
|
68
79
|
* scaffolded pages render with zero setup. Builders drop in their own images.
|
|
@@ -144,7 +155,7 @@ async function discoverBlocks() {
|
|
|
144
155
|
const tsxPath = path.join(path.dirname(docPath), basename + '.tsx');
|
|
145
156
|
if (!fs.existsSync(tsxPath)) continue;
|
|
146
157
|
const doc = await loadDocModule(docPath);
|
|
147
|
-
const relPath = path.relative(BLOCKS_DIR, path.dirname(docPath));
|
|
158
|
+
const relPath = toPosixPath(path.relative(BLOCKS_DIR, path.dirname(docPath)));
|
|
148
159
|
blocks.push({
|
|
149
160
|
type: 'block',
|
|
150
161
|
dirName: basename,
|
|
@@ -180,7 +191,7 @@ async function discoverExternalBlocks(cwd = process.cwd()) {
|
|
|
180
191
|
const tsxPath = path.join(path.dirname(docPath), basename + '.tsx');
|
|
181
192
|
if (!fs.existsSync(tsxPath)) continue;
|
|
182
193
|
const doc = await loadDocModule(docPath);
|
|
183
|
-
const relPath = path.relative(ext.blocksDir, path.dirname(docPath));
|
|
194
|
+
const relPath = toPosixPath(path.relative(ext.blocksDir, path.dirname(docPath)));
|
|
184
195
|
blocks.push({
|
|
185
196
|
type: 'block',
|
|
186
197
|
dirName: basename,
|
|
@@ -428,7 +439,7 @@ export async function findShowcase(componentName, cwd, options) {
|
|
|
428
439
|
|
|
429
440
|
// Priority 1: own directory (components/Badge/ for "Badge")
|
|
430
441
|
const dirMatch = showcases.find(b => {
|
|
431
|
-
const catDir = b.category
|
|
442
|
+
const catDir = path.basename(b.category).toLowerCase();
|
|
432
443
|
return catDir === lc;
|
|
433
444
|
});
|
|
434
445
|
if (dirMatch) return toResult(dirMatch);
|
|
@@ -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
|
});
|
|
@@ -20,6 +20,7 @@ const registry = new Map([
|
|
|
20
20
|
['0.1.0', () => import('./transforms/v0.1.0/index.mjs')],
|
|
21
21
|
['0.1.2', () => import('./transforms/v0.1.2/index.mjs')],
|
|
22
22
|
['0.1.3', () => import('./transforms/v0.1.3/index.mjs')],
|
|
23
|
+
['0.1.5', () => import('./transforms/v0.1.5/index.mjs')],
|
|
23
24
|
]);
|
|
24
25
|
|
|
25
26
|
// Re-export from the shared utility so registry callers and other consumers
|
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
|
};
|
package/src/codemods/transforms/v0.1.5/__tests__/rename-switch-label-spacing-default-to-hug.test.mjs
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
import {describe, it, expect} from 'vitest';
|
|
4
|
+
|
|
5
|
+
async function applyTransform(source) {
|
|
6
|
+
const {default: transform} =
|
|
7
|
+
await import('../rename-switch-label-spacing-default-to-hug.mjs');
|
|
8
|
+
const jscodeshift = (await import('jscodeshift')).default;
|
|
9
|
+
const j = jscodeshift.withParser('tsx');
|
|
10
|
+
const api = {jscodeshift: j, stats: () => {}, report: () => {}};
|
|
11
|
+
const file = {source, path: 'test.tsx'};
|
|
12
|
+
const result = transform(file, api);
|
|
13
|
+
return result ?? source;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
describe('rename-switch-label-spacing-default-to-hug', () => {
|
|
17
|
+
it('renames Switch labelSpacing="default" to labelSpacing="hug"', async () => {
|
|
18
|
+
const input = `<Switch label="Notify" value={on} labelSpacing="default" />`;
|
|
19
|
+
const output = await applyTransform(input);
|
|
20
|
+
expect(output).toContain("'hug'");
|
|
21
|
+
expect(output).not.toContain('default');
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it("renames expression-container labelSpacing={'default'}", async () => {
|
|
25
|
+
const input = `<Switch label="Notify" value={on} labelSpacing={'default'} />`;
|
|
26
|
+
const output = await applyTransform(input);
|
|
27
|
+
expect(output).toContain("'hug'");
|
|
28
|
+
expect(output).not.toContain("'default'");
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
it('renames default inside a ternary labelSpacing expression', async () => {
|
|
32
|
+
const input = `<Switch label="Notify" value={on} labelSpacing={isRow ? 'spread' : 'default'} />`;
|
|
33
|
+
const output = await applyTransform(input);
|
|
34
|
+
expect(output).toContain("'hug'");
|
|
35
|
+
expect(output).toContain("'spread'");
|
|
36
|
+
expect(output).not.toContain("'default'");
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('does not change labelSpacing="spread"', async () => {
|
|
40
|
+
const input = `<Switch label="Notify" value={on} labelSpacing="spread" />`;
|
|
41
|
+
const output = await applyTransform(input);
|
|
42
|
+
expect(output).toBe(input);
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it('does not touch labelSpacing="default" on non-Switch components', async () => {
|
|
46
|
+
const input = `<LegacyToggle labelSpacing="default" />`;
|
|
47
|
+
const output = await applyTransform(input);
|
|
48
|
+
expect(output).toBe(input);
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it('does not touch other props with a "default" value on Switch', async () => {
|
|
52
|
+
const input = `<Switch label="Notify" value={on} data-variant="default" />`;
|
|
53
|
+
const output = await applyTransform(input);
|
|
54
|
+
expect(output).toBe(input);
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it('does not touch unrelated "default" string literals', async () => {
|
|
58
|
+
const input = `const theme = {mode: 'default', label: 'Default Mode'};`;
|
|
59
|
+
const output = await applyTransform(input);
|
|
60
|
+
expect(output).toBe(input);
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
it('renames object labelSpacing prop in files importing Switch', async () => {
|
|
64
|
+
const input = `import {Switch} from '@astryxdesign/core/Switch';
|
|
65
|
+
const cfg = {labelSpacing: 'default'};`;
|
|
66
|
+
const output = await applyTransform(input);
|
|
67
|
+
expect(output).toContain("labelSpacing: 'hug'");
|
|
68
|
+
expect(output).not.toContain("'default'");
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it("renames labelSpacing: 'default' as const in files importing Switch", async () => {
|
|
72
|
+
const input = `import {Switch} from '@astryxdesign/core/Switch';
|
|
73
|
+
const ROWS = [{labelSpacing: 'default' as const, label: 'Adjacent'}];`;
|
|
74
|
+
const output = await applyTransform(input);
|
|
75
|
+
expect(output).toContain("'hug' as const");
|
|
76
|
+
expect(output).not.toContain("'default'");
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
it('does not rename object labelSpacing prop when Switch is not imported', async () => {
|
|
80
|
+
const input = `const cfg = {labelSpacing: 'default'};`;
|
|
81
|
+
const output = await applyTransform(input);
|
|
82
|
+
expect(output).toBe(input);
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it('renames Storybook argTypes options in files importing Switch', async () => {
|
|
86
|
+
const input = `import {Switch} from '@astryxdesign/core/Switch';
|
|
87
|
+
const meta = {argTypes: {labelSpacing: {control: 'select', options: ['default', 'spread']}}};`;
|
|
88
|
+
const output = await applyTransform(input);
|
|
89
|
+
expect(output).toContain("'hug'");
|
|
90
|
+
expect(output).toContain("'spread'");
|
|
91
|
+
expect(output).not.toContain("'default'");
|
|
92
|
+
});
|
|
93
|
+
});
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file v0.1.5 transform manifest
|
|
5
|
+
*
|
|
6
|
+
* Lists all codemods for the v0.1.5 release in the order they should run.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import renameSwitchLabelSpacingDefaultToHug, {
|
|
10
|
+
meta as renameSwitchLabelSpacingDefaultToHugMeta,
|
|
11
|
+
} from './rename-switch-label-spacing-default-to-hug.mjs';
|
|
12
|
+
|
|
13
|
+
export default [
|
|
14
|
+
{
|
|
15
|
+
name: 'rename-switch-label-spacing-default-to-hug',
|
|
16
|
+
transform: renameSwitchLabelSpacingDefaultToHug,
|
|
17
|
+
meta: renameSwitchLabelSpacingDefaultToHugMeta,
|
|
18
|
+
},
|
|
19
|
+
];
|