@astryxdesign/cli 0.1.4-canary.39ffd21 → 0.1.4-canary.3d64ef2

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.
Files changed (44) hide show
  1. package/CHANGELOG.md +2 -1
  2. package/docs/getting-started.doc.mjs +4 -0
  3. package/docs/migration.doc.mjs +134 -0
  4. package/docs/styling.doc.mjs +53 -0
  5. package/package.json +14 -9
  6. package/src/api/component.mjs +2 -1
  7. package/src/api/doctor.mjs +13 -2
  8. package/src/api/template.mjs +14 -3
  9. package/src/codemods/__tests__/runner.test.mjs +38 -0
  10. package/src/codemods/runner.mjs +2 -0
  11. package/src/commands/agent-docs.mjs +9 -6
  12. package/src/commands/agent-docs.test.mjs +33 -0
  13. package/src/commands/build-theme.mjs +110 -13
  14. package/src/commands/build-theme.variants.test.mjs +204 -0
  15. package/src/commands/component-resolution.test.mjs +4 -4
  16. package/src/commands/doctor.test.mjs +34 -0
  17. package/src/commands/init.mjs +1 -1
  18. package/src/commands/swizzle.mjs +34 -0
  19. package/src/commands/swizzle.routing.test.mjs +67 -0
  20. package/src/lib/component-discovery.mjs +8 -4
  21. package/templates/blocks/components/BaseTypeahead/BaseTypeaheadCustomSearch.doc.mjs +14 -0
  22. package/templates/blocks/components/BaseTypeahead/BaseTypeaheadCustomSearch.tsx +58 -0
  23. package/templates/blocks/components/CodeBlock/CodeBlockTerminal.doc.mjs +14 -0
  24. package/templates/blocks/components/CodeBlock/CodeBlockTerminal.tsx +24 -0
  25. package/templates/blocks/components/Collapsible/CollapsibleDividedAccordion.doc.mjs +13 -0
  26. package/templates/blocks/components/Collapsible/CollapsibleDividedAccordion.tsx +33 -0
  27. package/templates/blocks/components/CommandPaletteGroup/CommandPaletteGroupShowcase.tsx +27 -48
  28. package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputBasic.doc.mjs +15 -0
  29. package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputBasic.tsx +39 -0
  30. package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputShowcase.doc.mjs +15 -0
  31. package/templates/blocks/components/CommandPaletteInput/CommandPaletteInputShowcase.tsx +39 -0
  32. package/templates/blocks/components/CommandPaletteItem/CommandPaletteItemShowcase.tsx +31 -54
  33. package/templates/blocks/components/CommandPaletteList/CommandPaletteListBasic.doc.mjs +15 -0
  34. package/templates/blocks/components/CommandPaletteList/CommandPaletteListBasic.tsx +27 -0
  35. package/templates/blocks/components/CommandPaletteList/CommandPaletteListShowcase.doc.mjs +15 -0
  36. package/templates/blocks/components/CommandPaletteList/CommandPaletteListShowcase.tsx +38 -0
  37. package/templates/blocks/components/ContextMenuItem/ContextMenuItemBasic.doc.mjs +14 -0
  38. package/templates/blocks/components/ContextMenuItem/ContextMenuItemBasic.tsx +44 -0
  39. package/templates/blocks/components/ContextMenuItem/ContextMenuItemShowcase.doc.mjs +15 -0
  40. package/templates/blocks/components/ContextMenuItem/ContextMenuItemShowcase.tsx +107 -0
  41. package/templates/blocks/components/NavHeadingMenu/NavHeadingMenuShowcase.doc.mjs +15 -0
  42. package/templates/blocks/components/NavHeadingMenu/NavHeadingMenuShowcase.tsx +47 -0
  43. package/templates/pages/table-page-chart/page.tsx +3 -13
  44. package/templates/pages/table-page-shoe-store-heatmap/page.tsx +4 -18
@@ -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: Astryx + PascalCase(component) + PascalCase(prop) + Map
184
- * banner + status → XDSBannerStatusMap
185
- * button + variant → XDSButtonVariantMap
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 = `XDS${pascal}${propPascal}Map`;
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
- return `import type { DefinedTheme } from '@astryxdesign/core/theme';
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
- // Generate all file contents in memory first.
898
- const cssContent = generatedHeader(sourceRelative, 'css', buildCommand) + css;
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 variantDtsPath = variantDecl ? path.join(outDir, `${baseName}.variants.d.ts`) : null;
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
@@ -0,0 +1,204 @@
1
+ // Copyright (c) Meta Platforms, Inc. and affiliates.
2
+
3
+ /**
4
+ * @file Regression test for the custom-variant type augmentations emitted by
5
+ * `astryx theme build` (#3391 companion: #3371).
6
+ *
7
+ * When a theme declares a custom component prop value (e.g.
8
+ * `button['variant:accentOutline']`), the build emits a `<name>.variants.d.ts`
9
+ * with a module augmentation so the custom value type-checks. This suite pins
10
+ * the two bugs that made that augmentation dead code:
11
+ *
12
+ * 1. The augmentation targeted a non-existent, `XDS`-prefixed interface
13
+ * (`XDSButtonVariantMap`) instead of core's real `ButtonVariantMap`, so it
14
+ * created a new unused interface and never widened the prop union.
15
+ * 2. Props with no augmentation point (closed literal-union types such as
16
+ * Button `size` or Heading `type`/`level`) still got a `declare module`
17
+ * block against a `*Map` interface that doesn't exist.
18
+ * 3. The generated `.variants.d.ts` was never referenced by the main
19
+ * `<name>.d.ts`, so even a correct augmentation never loaded.
20
+ *
21
+ * Building `astryx theme build` requires a compiled @astryxdesign/core, so this
22
+ * suite builds core once in beforeAll (mirrors build-theme.prose.test.mjs).
23
+ */
24
+
25
+ import {describe, it, expect, beforeAll, beforeEach, afterEach} from 'vitest';
26
+ import {execFileSync} from 'node:child_process';
27
+ import * as fs from 'node:fs';
28
+ import * as path from 'node:path';
29
+ import * as os from 'node:os';
30
+ import {fileURLToPath} from 'node:url';
31
+
32
+ const __dirname = path.dirname(fileURLToPath(import.meta.url));
33
+ const CLI_BIN = path.resolve(__dirname, '../../bin/astryx.mjs');
34
+ const REPO_ROOT = path.resolve(__dirname, '../../../..');
35
+ const CORE_THEME_ENTRY = path.join(
36
+ REPO_ROOT,
37
+ 'packages/core/dist/theme/index.js',
38
+ );
39
+ // The fix reads core's shipped component declarations to decide whether an
40
+ // interface is augmentable; those .d.ts files come from the same core build.
41
+ const CORE_BUTTON_DTS = path.join(
42
+ REPO_ROOT,
43
+ 'packages/core/dist/Button/index.d.ts',
44
+ );
45
+
46
+ function runCli(args, cwd) {
47
+ try {
48
+ const out = execFileSync('node', [CLI_BIN, ...args], {
49
+ cwd,
50
+ encoding: 'utf-8',
51
+ stdio: ['ignore', 'pipe', 'pipe'],
52
+ env: {...process.env, FORCE_COLOR: '0'},
53
+ });
54
+ return {code: 0, stdout: out, stderr: ''};
55
+ } catch (e) {
56
+ return {
57
+ code: e.status ?? 1,
58
+ stdout: e.stdout?.toString() ?? '',
59
+ stderr: e.stderr?.toString() ?? '',
60
+ };
61
+ }
62
+ }
63
+
64
+ function writeTheme(dir, contents) {
65
+ fs.mkdirSync(dir, {recursive: true});
66
+ const file = path.join(dir, 'variants-theme.mjs');
67
+ fs.writeFileSync(file, contents);
68
+ return file;
69
+ }
70
+
71
+ beforeAll(() => {
72
+ if (!fs.existsSync(CORE_THEME_ENTRY) || !fs.existsSync(CORE_BUTTON_DTS)) {
73
+ execFileSync('pnpm', ['-F', '@astryxdesign/core', 'build'], {
74
+ cwd: REPO_ROOT,
75
+ stdio: 'pipe',
76
+ timeout: 180_000,
77
+ });
78
+ }
79
+ }, 200_000);
80
+
81
+ let tmpDir;
82
+ beforeEach(() => {
83
+ tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-build-theme-variants-'));
84
+ });
85
+ afterEach(() => {
86
+ fs.rmSync(tmpDir, {recursive: true, force: true});
87
+ });
88
+
89
+ describe('theme build custom-variant augmentations', () => {
90
+ it('targets the real (un-prefixed) core interface for a custom variant', () => {
91
+ const themeFile = writeTheme(
92
+ tmpDir,
93
+ `export default {
94
+ name: 'variants-theme',
95
+ tokens: { '--color-bg': '#fff' },
96
+ components: {
97
+ button: { 'variant:accentOutline': { backgroundColor: 'transparent' } },
98
+ },
99
+ };\n`,
100
+ );
101
+
102
+ const result = runCli(
103
+ ['theme', 'build', path.relative(tmpDir, themeFile)],
104
+ tmpDir,
105
+ );
106
+ expect(result.code).toBe(0);
107
+
108
+ const variantsPath = path.join(tmpDir, 'variants-theme.variants.d.ts');
109
+ expect(fs.existsSync(variantsPath)).toBe(true);
110
+ const dts = fs.readFileSync(variantsPath, 'utf-8');
111
+
112
+ // Targets core's actual augmentation point…
113
+ expect(dts).toContain("declare module '@astryxdesign/core/Button'");
114
+ expect(dts).toMatch(/interface ButtonVariantMap\b/);
115
+ expect(dts).toContain("'accentOutline': true;");
116
+ // …and NOT the old, non-existent XDS-prefixed interface.
117
+ expect(dts).not.toMatch(/XDSButtonVariantMap/);
118
+ });
119
+
120
+ it('skips props with no augmentation point (Button size, Heading type)', () => {
121
+ const themeFile = writeTheme(
122
+ tmpDir,
123
+ `export default {
124
+ name: 'variants-theme',
125
+ tokens: { '--color-bg': '#fff' },
126
+ components: {
127
+ button: {
128
+ 'variant:accentOutline': { backgroundColor: 'transparent' },
129
+ 'size:jumbo': { paddingBlock: '40px' },
130
+ },
131
+ heading: { 'type:hero': { fontSize: '80px' } },
132
+ },
133
+ };\n`,
134
+ );
135
+
136
+ const result = runCli(
137
+ ['theme', 'build', path.relative(tmpDir, themeFile)],
138
+ tmpDir,
139
+ );
140
+ expect(result.code).toBe(0);
141
+
142
+ const variantsPath = path.join(tmpDir, 'variants-theme.variants.d.ts');
143
+ expect(fs.existsSync(variantsPath)).toBe(true);
144
+ const dts = fs.readFileSync(variantsPath, 'utf-8');
145
+
146
+ // The augmentable variant is emitted…
147
+ expect(dts).toMatch(/interface ButtonVariantMap\b/);
148
+ // …but closed literal-union props get no dead augmentation.
149
+ expect(dts).not.toMatch(/ButtonSizeMap/);
150
+ expect(dts).not.toMatch(/HeadingTypeMap/);
151
+ expect(dts).not.toContain("declare module '@astryxdesign/core/Heading'");
152
+ });
153
+
154
+ it('does not emit a .variants.d.ts when every custom value is non-augmentable', () => {
155
+ const themeFile = writeTheme(
156
+ tmpDir,
157
+ `export default {
158
+ name: 'variants-theme',
159
+ tokens: { '--color-bg': '#fff' },
160
+ components: {
161
+ button: { 'size:jumbo': { paddingBlock: '40px' } },
162
+ },
163
+ };\n`,
164
+ );
165
+
166
+ const result = runCli(
167
+ ['theme', 'build', path.relative(tmpDir, themeFile)],
168
+ tmpDir,
169
+ );
170
+ expect(result.code).toBe(0);
171
+ expect(
172
+ fs.existsSync(path.join(tmpDir, 'variants-theme.variants.d.ts')),
173
+ ).toBe(false);
174
+ });
175
+
176
+ it('references the variants file from the main .d.ts so the augmentation loads', () => {
177
+ const themeFile = writeTheme(
178
+ tmpDir,
179
+ `export default {
180
+ name: 'variants-theme',
181
+ tokens: { '--color-bg': '#fff' },
182
+ components: {
183
+ button: { 'variant:accentOutline': { backgroundColor: 'transparent' } },
184
+ },
185
+ };\n`,
186
+ );
187
+
188
+ const result = runCli(
189
+ ['theme', 'build', path.relative(tmpDir, themeFile)],
190
+ tmpDir,
191
+ );
192
+ expect(result.code).toBe(0);
193
+
194
+ const dts = fs.readFileSync(
195
+ path.join(tmpDir, 'variants-theme.d.ts'),
196
+ 'utf-8',
197
+ );
198
+ // A triple-slash reference to the variants file, so importing the theme's
199
+ // types also loads the module augmentation.
200
+ expect(dts).toMatch(
201
+ /\/\/\/\s*<reference path="\.\/variants-theme\.variants\.d\.ts"\s*\/>/,
202
+ );
203
+ });
204
+ });
@@ -78,13 +78,13 @@ describe('findShowcase() priority', () => {
78
78
  it('Badge resolves to Badge dir, not a sibling that uses Badge', async () => {
79
79
  const result = await findShowcase('Badge');
80
80
  expect(result).not.toBeNull();
81
- expect(result.filePath).toMatch(/\/Badge\//);
81
+ expect(result.filePath).toMatch(/[/\\]Badge[/\\]/);
82
82
  });
83
83
 
84
84
  it('Avatar resolves to Avatar dir, not AvatarStatusDot', async () => {
85
85
  const result = await findShowcase('Avatar');
86
86
  expect(result).not.toBeNull();
87
- expect(result.filePath).toMatch(/\/Avatar\//);
87
+ expect(result.filePath).toMatch(/[/\\]Avatar[/\\]/);
88
88
  expect(result.filePath).not.toMatch(/AvatarStatusDot/);
89
89
  });
90
90
 
@@ -92,7 +92,7 @@ describe('findShowcase() priority', () => {
92
92
  const result = await findShowcase('ClickableCard');
93
93
  expect(result).not.toBeNull();
94
94
  expect(result.name).toBe('ClickableCard');
95
- expect(result.filePath).toMatch(/\/Card\//);
95
+ expect(result.filePath).toMatch(/[/\\]Card[/\\]/);
96
96
  });
97
97
 
98
98
  it('SelectableCard resolves via componentsUsed in Card/', async () => {
@@ -104,7 +104,7 @@ describe('findShowcase() priority', () => {
104
104
  it('Stack resolves to Stack dir despite componentsUsed elsewhere', async () => {
105
105
  const result = await findShowcase('Stack');
106
106
  expect(result).not.toBeNull();
107
- expect(result.filePath).toMatch(/\/Stack\//);
107
+ expect(result.filePath).toMatch(/[/\\]Stack[/\\]/);
108
108
  });
109
109
 
110
110
  it('returns null for nonexistent component', async () => {
@@ -63,6 +63,33 @@ function installPkg(name, version = '1.0.0') {
63
63
  return dir;
64
64
  }
65
65
 
66
+ /**
67
+ * Mirror pnpm's layout: the real package lives under node_modules/.pnpm and
68
+ * the entry in the scope directory is a symlink to it.
69
+ */
70
+ function installPkgPnpmStyle(name, version = '1.0.0') {
71
+ const realDir = path.join(
72
+ tmpDir,
73
+ 'node_modules',
74
+ '.pnpm',
75
+ `${name.replace('/', '+')}@${version}`,
76
+ 'node_modules',
77
+ ...name.split('/'),
78
+ );
79
+ fs.mkdirSync(realDir, {recursive: true});
80
+ fs.writeFileSync(
81
+ path.join(realDir, 'package.json'),
82
+ JSON.stringify({name, version, main: 'index.js'}),
83
+ );
84
+ fs.writeFileSync(path.join(realDir, 'index.js'), 'module.exports = {};');
85
+ const linkPath = path.join(tmpDir, 'node_modules', ...name.split('/'));
86
+ fs.mkdirSync(path.dirname(linkPath), {recursive: true});
87
+ // 'junction' keeps this working on Windows without elevated permissions;
88
+ // it is ignored on posix.
89
+ fs.symlinkSync(realDir, linkPath, 'junction');
90
+ return linkPath;
91
+ }
92
+
66
93
  function find(checks, id) {
67
94
  return checks.find(c => c.id === id);
68
95
  }
@@ -119,6 +146,13 @@ describe('doctor — individual checks', () => {
119
146
  expect(res.status).toBe('pass');
120
147
  });
121
148
 
149
+ it('themes: detects pnpm-style symlinked theme packages (#3530)', () => {
150
+ installPkgPnpmStyle('@astryxdesign/theme-neutral', '0.1.2');
151
+ const res = checkThemes({cwd: tmpDir, configTheme: 'default'});
152
+ expect(res.status).toBe('pass');
153
+ expect(res.message).toContain('@astryxdesign/theme-neutral');
154
+ });
155
+
122
156
  it('config: INFO when no astryx.config.mjs', async () => {
123
157
  const res = await checkConfig({cwd: tmpDir, configPath: null});
124
158
  expect(res.status).toBe('info');
@@ -198,7 +198,7 @@ export function registerInit(program) {
198
198
  .option('--features <list>', 'Comma-separated features to install (agents, theme, template)')
199
199
  .option('--all', 'Install all features, no prompts')
200
200
  .option('--remove-agents', 'Remove AI agent docs from all agent doc files')
201
- .option('--agent <tool>', 'Target AI tool for agent docs: claude, cursor, codex, all')
201
+ .option('--agent <tool>', 'Target AI tool for agent docs: claude, cursor, codex, hermes, all')
202
202
  .option('--agent-docs-path <path...>', 'Explicit file path(s) for agent docs')
203
203
  .action(async (options) => {
204
204
  const targetDir = process.cwd();
@@ -26,6 +26,7 @@ import {jsonOut, humanLog} from '../lib/json.mjs';
26
26
  import {cliError} from '../lib/cli-error.mjs';
27
27
  import {ERROR_CODES} from '../lib/error-codes.mjs';
28
28
  import {checkGhCli} from '../utils/github.mjs';
29
+ import {getRunPrefix} from '../utils/package-manager.mjs';
29
30
  import {Project} from '../lib/project.mjs';
30
31
  import {
31
32
  CORE_PACKAGE,
@@ -339,6 +340,10 @@ export function registerSwizzle(program) {
339
340
  // Copy all non-test, non-doc, non-README files
340
341
  const files = fs.readdirSync(componentDir);
341
342
  let copied = 0;
343
+ // Track whether any copied source uses StyleX. Swizzled StyleX source
344
+ // needs a build-time StyleX compiler in the consumer's app or it renders
345
+ // unstyled with no error — so we surface a setup note after copying.
346
+ let usesStyleX = false;
342
347
 
343
348
  for (const file of files) {
344
349
  // Skip test files, doc files, and README
@@ -355,6 +360,13 @@ export function registerSwizzle(program) {
355
360
  content = rewriteImports(content, owner.ownerPackage);
356
361
  }
357
362
 
363
+ if (
364
+ (file.endsWith('.ts') || file.endsWith('.tsx')) &&
365
+ content.includes('@stylexjs/stylex')
366
+ ) {
367
+ usesStyleX = true;
368
+ }
369
+
358
370
  fs.writeFileSync(path.join(outputDir, file), content);
359
371
  copied++;
360
372
  }
@@ -376,6 +388,7 @@ export function registerSwizzle(program) {
376
388
  outputDir: relOutput,
377
389
  filesCopied: copied,
378
390
  files: copiedFiles.map(f => f),
391
+ usesStyleX,
379
392
  };
380
393
  if (feedback) payload.feedback = feedback;
381
394
  return jsonOut('swizzle.copy', payload);
@@ -387,6 +400,27 @@ export function registerSwizzle(program) {
387
400
  );
388
401
  humanLog('You can now customize the component source freely.\n');
389
402
 
403
+ // StyleX build requirement. Swizzled components ship raw StyleX source,
404
+ // which needs a build-time StyleX compiler in the consumer's app to
405
+ // produce atomic CSS. Without it the component compiles but renders
406
+ // unstyled, with no error — a confusing silent failure, so call it out.
407
+ if (usesStyleX) {
408
+ humanLog(
409
+ '⚠ These components use StyleX and require a StyleX compiler in your build.',
410
+ );
411
+ humanLog(
412
+ ' Without one they render unstyled (no error). See setup per framework:',
413
+ );
414
+ humanLog(` ${getRunPrefix()} astryx docs styling`);
415
+ humanLog(
416
+ ' Next.js note: the StyleX Babel plugin disables SWC and breaks next/font —',
417
+ );
418
+ humanLog(
419
+ ' use an SWC-based StyleX transform instead (covered in the guide).',
420
+ );
421
+ humanLog('');
422
+ }
423
+
390
424
  // Maintainer feedback note. If we couldn't swizzle cleanly, the team
391
425
  // wants to know — point users at the issue tracker. Skipped when the
392
426
  // owning package ships no issues URL.
@@ -277,3 +277,70 @@ describe('swizzle — ambiguous ownership', () => {
277
277
  expect(out).toContain(`from '@astryxdesign/core/theme'`);
278
278
  });
279
279
  });
280
+
281
+ /**
282
+ * Build a fake @astryxdesign/core with a component that imports StyleX directly
283
+ * (so the swizzle StyleX-build note should fire) and one that doesn't.
284
+ */
285
+ function buildStyleXCore(project) {
286
+ const core = path.join(project, 'node_modules', '@astryxdesign', 'core');
287
+ // StyleX component.
288
+ const styledDir = path.join(core, 'src', 'Styled');
289
+ fs.mkdirSync(styledDir, {recursive: true});
290
+ fs.writeFileSync(
291
+ path.join(core, 'package.json'),
292
+ '{"name":"@astryxdesign/core","version":"0.0.13"}',
293
+ );
294
+ fs.writeFileSync(
295
+ path.join(styledDir, 'Styled.tsx'),
296
+ [
297
+ `import * as stylex from '@stylexjs/stylex';`,
298
+ `const styles = stylex.create({base: {color: 'red'}});`,
299
+ `export const Styled = () => null;`,
300
+ '',
301
+ ].join('\n'),
302
+ );
303
+ // Plain component (no StyleX).
304
+ const plainDir = path.join(core, 'src', 'Plain');
305
+ fs.mkdirSync(plainDir, {recursive: true});
306
+ fs.writeFileSync(
307
+ path.join(plainDir, 'Plain.tsx'),
308
+ `export const Plain = () => null;\n`,
309
+ );
310
+ return core;
311
+ }
312
+
313
+ describe('swizzle — StyleX build setup note (#3373)', () => {
314
+ it('reports usesStyleX and prints a setup note for StyleX components', () => {
315
+ buildStyleXCore(project);
316
+ writeProjectPackageJson(project);
317
+
318
+ // JSON payload carries the machine-readable flag.
319
+ const jsonResult = runCli(['--json', 'swizzle', 'Styled', '-f'], project);
320
+ expect(jsonResult.code).toBe(0);
321
+ const env = JSON.parse(jsonResult.stdout);
322
+ expect(env.data.usesStyleX).toBe(true);
323
+
324
+ // Human output surfaces the compiler requirement + Next.js caveat.
325
+ const humanResult = runCli(['swizzle', 'Styled', '-f'], project);
326
+ expect(humanResult.code).toBe(0);
327
+ expect(humanResult.stdout).toMatch(/StyleX compiler/i);
328
+ expect(humanResult.stdout).toMatch(/unstyled/i);
329
+ expect(humanResult.stdout).toMatch(/next\/font/i);
330
+ expect(humanResult.stdout).toMatch(/astryx docs styling/);
331
+ });
332
+
333
+ it('does not print the StyleX note for components without StyleX', () => {
334
+ buildStyleXCore(project);
335
+ writeProjectPackageJson(project);
336
+
337
+ const jsonResult = runCli(['--json', 'swizzle', 'Plain', '-f'], project);
338
+ expect(jsonResult.code).toBe(0);
339
+ const env = JSON.parse(jsonResult.stdout);
340
+ expect(env.data.usesStyleX).toBe(false);
341
+
342
+ const humanResult = runCli(['swizzle', 'Plain', '-f'], project);
343
+ expect(humanResult.code).toBe(0);
344
+ expect(humanResult.stdout).not.toMatch(/StyleX compiler/i);
345
+ });
346
+ });
@@ -335,10 +335,13 @@ export function resolveImportPath(coreDir, componentName) {
335
335
  ? JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
336
336
  : null;
337
337
 
338
+ const exportKeys = Object.keys(pkg?.exports || {});
339
+
338
340
  // Priority 1: exact subpath export matching the component name (e.g. ./Heading)
339
341
  // This allows convenience re-export directories to win over the source directory.
340
- if (pkg?.exports?.[`./${componentName}`]) {
341
- return `@astryxdesign/core/${componentName}`;
342
+ const exactMatch = exportKeys.find(k => k.toLowerCase() === `./${componentName}`.toLowerCase());
343
+ if (exactMatch) {
344
+ return `@astryxdesign/core/${exactMatch.slice(2)}`;
342
345
  }
343
346
 
344
347
  const sourcePath = findComponentSource(coreDir, componentName);
@@ -348,8 +351,9 @@ export function resolveImportPath(coreDir, componentName) {
348
351
  const relToSrc = path.relative(srcDir, sourcePath);
349
352
  const topDir = relToSrc.split(path.sep)[0];
350
353
 
351
- if (pkg?.exports?.[`./${topDir}`]) {
352
- return `@astryxdesign/core/${topDir}`;
354
+ const topMatch = exportKeys.find(k => k.toLowerCase() === `./${topDir}`.toLowerCase());
355
+ if (topMatch) {
356
+ return `@astryxdesign/core/${topMatch.slice(2)}`;
353
357
  }
354
358
 
355
359
  return '@astryxdesign/core';
@@ -0,0 +1,14 @@
1
+ // Copyright (c) Meta Platforms, Inc. and affiliates.
2
+
3
+ /** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
4
+ export const doc = {
5
+ type: 'block',
6
+ exampleFor: 'BaseTypeahead',
7
+ name: 'BaseTypeahead — Custom Search Bar',
8
+ displayName: 'BaseTypeahead — Custom Search Bar',
9
+ description:
10
+ 'BaseTypeahead embedded inside a custom-styled wrapper. The wrapper provides its own border and icon chrome; anchorRef positions the dropdown relative to it. Use this pattern when Typeahead\'s built-in field layout does not fit your composition.',
11
+ isReady: true,
12
+ aspectRatio: 16 / 9,
13
+ componentsUsed: ['BaseTypeahead', 'Icon', 'Layout', 'Text'],
14
+ };