@astryxdesign/cli 0.4.6 → 0.4.7-canary.29be96d
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 +4 -0
- package/README.md +1 -0
- package/api/index.d.mts +1 -1
- package/api/index.mjs +1 -1
- package/api/theme/build/build.mjs +8 -38
- package/api/theme/targets/targets.d.mts +18 -0
- package/api/theme/targets/targets.mjs +87 -0
- package/api/theme/targets/targets.test.mjs +65 -0
- package/api/theme/theme.d.mts +1 -0
- package/api/theme/theme.mjs +3 -1
- package/api/theme/theme.type.d.mts +23 -0
- package/api/theme/theme.type.mjs +21 -1
- package/api/theme/themeTargets.doc.d.mts +11 -0
- package/api/theme/themeTargets.doc.mjs +58 -0
- package/assets/docs/README.md +50 -0
- package/assets/docs/cli-integrations.doc.mjs +4 -4
- package/assets/docs/theme.doc.dense.mjs +1 -1
- package/assets/docs/theme.doc.mjs +1 -1
- package/assets/templates/blocks/components/Dialog/DialogAdaptivePresentation.doc.mjs +25 -0
- package/assets/templates/blocks/components/Dialog/DialogAdaptivePresentation.tsx +167 -0
- package/assets/templates/blocks/components/Dialog/DialogScrollingContent.tsx +1 -1
- package/assets/templates/blocks/components/Step/StepContent.doc.mjs +14 -0
- package/assets/templates/blocks/components/Step/StepContent.tsx +32 -0
- package/assets/templates/blocks/components/Step/StepIndicator.doc.mjs +14 -0
- package/assets/templates/blocks/components/Step/StepIndicator.tsx +60 -0
- package/assets/templates/blocks/components/Step/StepShowcase.doc.mjs +15 -0
- package/assets/templates/blocks/components/Step/StepShowcase.tsx +26 -0
- package/assets/templates/blocks/components/Step/StepStates.doc.mjs +14 -0
- package/assets/templates/blocks/components/Step/StepStates.tsx +46 -0
- package/assets/templates/blocks/components/Stepper/StepperCustomContent.doc.mjs +22 -0
- package/assets/templates/blocks/components/Stepper/StepperCustomContent.tsx +126 -0
- package/assets/templates/blocks/components/Stepper/StepperIndicatorModes.doc.mjs +1 -1
- package/assets/templates/blocks/components/Stepper/StepperIndicatorModes.tsx +17 -5
- package/assets/templates/blocks/components/Stepper/StepperOnTrackHorizontal.doc.mjs +14 -0
- package/assets/templates/blocks/components/Stepper/StepperOnTrackHorizontal.tsx +25 -0
- package/assets/templates/blocks/components/Stepper/StepperOnTrackVertical.doc.mjs +2 -2
- package/assets/templates/blocks/components/Stepper/StepperOnTrackVertical.tsx +1 -1
- package/assets/templates/blocks/components/Stepper/StepperShowcase.doc.mjs +1 -1
- package/assets/templates/blocks/components/Stepper/StepperShowcase.tsx +6 -7
- package/assets/templates/blocks/components/Stepper/StepperStatus.tsx +1 -1
- package/assets/templates/themes/neutral/neutralTheme.ts +13 -8
- package/clients/cli/commands/build-theme.mjs +85 -0
- package/clients/cli/commands/dialog-adaptive-template.test.mjs +24 -0
- package/clients/cli/commands/theme-targets.behavior.test.mjs +64 -0
- package/clients/cli/commands/theme-targets.doc.mjs +38 -0
- package/clients/cli/commands/theme.doc.mjs +4 -2
- package/clients/cli/index.mjs +1 -0
- package/clients/cli/lib/manifest.mjs +2 -0
- package/foundation/discovery/theming-targets.d.mts +48 -0
- package/foundation/discovery/theming-targets.mjs +135 -0
- package/foundation/discovery/theming-targets.test.mjs +127 -0
- package/foundation/response/response-types.doc.mjs +5 -0
- package/package.json +9 -9
- package/assets/templates/blocks/components/Stepper/StepperHorizontal.doc.mjs +0 -14
- package/assets/templates/blocks/components/Stepper/StepperHorizontal.tsx +0 -24
- package/assets/templates/blocks/components/Stepper/StepperMultiStepForm.doc.mjs +0 -14
- package/assets/templates/blocks/components/Stepper/StepperMultiStepForm.tsx +0 -92
- package/assets/templates/blocks/components/Stepper/StepperVerticalOnboarding.doc.mjs +0 -14
- package/assets/templates/blocks/components/Stepper/StepperVerticalOnboarding.tsx +0 -40
|
@@ -7,8 +7,8 @@ export const doc = {
|
|
|
7
7
|
name: 'Stepper — On-Track Vertical',
|
|
8
8
|
displayName: 'Stepper — On-Track Vertical',
|
|
9
9
|
description:
|
|
10
|
-
'The on-track layout in vertical orientation: indicators sit inline on a continuous connector rail, with each label and description beside its node.',
|
|
10
|
+
'The on-track layout in vertical orientation: indicators sit inline on a continuous connector rail, with each label and description beside its node. Compare with the separated layout, where the indicator sits alongside its own bar segment instead of on a shared rail.',
|
|
11
11
|
isReady: true,
|
|
12
12
|
aspectRatio: 4 / 3,
|
|
13
|
-
componentsUsed: ['Stepper'],
|
|
13
|
+
componentsUsed: ['Stepper', 'Step'],
|
|
14
14
|
};
|
|
@@ -7,7 +7,7 @@ export const doc = {
|
|
|
7
7
|
name: 'Stepper — Checkout Progress',
|
|
8
8
|
displayName: 'Stepper — Checkout Progress',
|
|
9
9
|
description:
|
|
10
|
-
'
|
|
10
|
+
'The default stepper: a horizontal track where every step owns an equal segment of the progress bar above its label. The default auto indicator resolves itself per step — a check once the step is done, a ring on the current step, a number for the ones still ahead. Click any step to jump.',
|
|
11
11
|
isReady: true,
|
|
12
12
|
isShowcase: true,
|
|
13
13
|
aspectRatio: 16 / 9,
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
'use client';
|
|
4
4
|
|
|
5
5
|
import {useState} from 'react';
|
|
6
|
-
import {Stepper, Step} from '@astryxdesign/
|
|
6
|
+
import {Stepper, Step} from '@astryxdesign/core/Stepper';
|
|
7
7
|
|
|
8
8
|
export default function StepperShowcase() {
|
|
9
9
|
const [active, setActive] = useState(2);
|
|
@@ -12,13 +12,12 @@ export default function StepperShowcase() {
|
|
|
12
12
|
<Stepper
|
|
13
13
|
activeStep={active}
|
|
14
14
|
orientation="horizontal"
|
|
15
|
-
indicatorPosition="on-track"
|
|
16
15
|
onStepClick={setActive}>
|
|
17
|
-
<Step step={0} label="Cart"
|
|
18
|
-
<Step step={1} label="Shipping"
|
|
19
|
-
<Step step={2} label="Payment"
|
|
20
|
-
<Step step={3} label="Review"
|
|
21
|
-
<Step step={4} label="Confirm"
|
|
16
|
+
<Step step={0} label="Cart" />
|
|
17
|
+
<Step step={1} label="Shipping" />
|
|
18
|
+
<Step step={2} label="Payment" />
|
|
19
|
+
<Step step={3} label="Review" />
|
|
20
|
+
<Step step={4} label="Confirm" />
|
|
22
21
|
</Stepper>
|
|
23
22
|
</div>
|
|
24
23
|
);
|
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
* icon = T30 / T80
|
|
25
25
|
* text = T30 / T80
|
|
26
26
|
*
|
|
27
|
-
* All 9 saturated badge values pass WCAG AA (5
|
|
27
|
+
* All 9 saturated badge values pass WCAG AA against their label (>= 4.5:1);
|
|
28
|
+
* `scripts/check-badge-contrast.test.mjs` holds every theme to that.
|
|
28
29
|
*
|
|
29
30
|
* Only overrides tokens that differ from the defaults.
|
|
30
31
|
*/
|
|
@@ -432,10 +433,14 @@ export const neutralTheme = defineTheme({
|
|
|
432
433
|
color: '#171717',
|
|
433
434
|
},
|
|
434
435
|
'variant:error': {
|
|
435
|
-
// Light: T55 #e33f4a
|
|
436
|
+
// Light: T58 #c9303a. The T55 stop #e33f4a pairs with white at only
|
|
437
|
+
// 4.14:1 — the label is 12px/500, so AA wants 4.5, not the 3:1
|
|
438
|
+
// large-text allowance. One tonal step down holds the hue
|
|
439
|
+
// (OKLCH H 21.9 -> 22.8, C 0.200 -> 0.189) and reaches 5.29:1.
|
|
436
440
|
// Dark : T60 stop from dark-mode tonal palette of Tailwind red-600
|
|
437
|
-
// source #dc2626 (kept on H=27 alarm-red rather than coral)
|
|
438
|
-
|
|
441
|
+
// source #dc2626 (kept on H=27 alarm-red rather than coral).
|
|
442
|
+
// Dark text on it is 6.60:1 and unchanged.
|
|
443
|
+
backgroundColor: 'light-dark(#c9303a, #ff705d)',
|
|
439
444
|
color: 'light-dark(#ffffff, #171717)',
|
|
440
445
|
},
|
|
441
446
|
|
|
@@ -500,7 +505,7 @@ export const neutralTheme = defineTheme({
|
|
|
500
505
|
//
|
|
501
506
|
// success → badge success bg (green T45 / dark-ramp T60)
|
|
502
507
|
// warning → badge warning bg (yellow T85, same hex both modes)
|
|
503
|
-
// error → badge error bg (red
|
|
508
|
+
// error → badge error bg (red T58 / dark-ramp T60)
|
|
504
509
|
// accent → badge info bg (blue T50 / dark-ramp T60) — the
|
|
505
510
|
// StatusDot "accent" is the info/attention color, so it
|
|
506
511
|
// pairs with the info badge rather than --color-accent
|
|
@@ -515,7 +520,7 @@ export const neutralTheme = defineTheme({
|
|
|
515
520
|
statusdot: {
|
|
516
521
|
'variant:success': {backgroundColor: 'light-dark(#198100, #64af4c)'},
|
|
517
522
|
'variant:warning': {backgroundColor: '#ffce2f'},
|
|
518
|
-
'variant:error': {backgroundColor: 'light-dark(#
|
|
523
|
+
'variant:error': {backgroundColor: 'light-dark(#c9303a, #ff705d)'},
|
|
519
524
|
'variant:accent': {backgroundColor: 'light-dark(#0074e2, #6d9cfe)'},
|
|
520
525
|
},
|
|
521
526
|
|
|
@@ -611,8 +616,8 @@ export const neutralTheme = defineTheme({
|
|
|
611
616
|
'--color-warning': '#ffce2f',
|
|
612
617
|
},
|
|
613
618
|
'variant:error': {
|
|
614
|
-
// Red
|
|
615
|
-
'--color-error': '#
|
|
619
|
+
// Red T58 saturated stop (= variant:error badge bg)
|
|
620
|
+
'--color-error': '#c9303a',
|
|
616
621
|
},
|
|
617
622
|
},
|
|
618
623
|
|
|
@@ -38,6 +38,7 @@ import {ERROR_CODES} from '../../../foundation/response/error-codes.mjs';
|
|
|
38
38
|
import {themeAdd} from '../../../api/theme/add/add.mjs';
|
|
39
39
|
import {themeTemplate} from '../../../api/theme/template/template.mjs';
|
|
40
40
|
import {themeList} from '../../../api/theme/list/list.mjs';
|
|
41
|
+
import {themeTargets} from '../../../api/theme/targets/targets.mjs';
|
|
41
42
|
import {themeBuild, importSpecifier} from '../../../api/theme/build/build.mjs';
|
|
42
43
|
import {defineCommand} from '../lib/define-command.mjs';
|
|
43
44
|
import {doc as themeGroup} from './theme.doc.mjs';
|
|
@@ -45,10 +46,12 @@ import {doc as themeBuildCommand} from './theme-build.doc.mjs';
|
|
|
45
46
|
import {doc as themeListCommand} from './theme-list.doc.mjs';
|
|
46
47
|
import {doc as themeAddCommand} from './theme-add.doc.mjs';
|
|
47
48
|
import {doc as themeTemplateCommand} from './theme-template.doc.mjs';
|
|
49
|
+
import {doc as themeTargetsCommand} from './theme-targets.doc.mjs';
|
|
48
50
|
import {doc as themeBuildFn} from '../../../api/theme/themeBuild.doc.mjs';
|
|
49
51
|
import {doc as themeListFn} from '../../../api/theme/themeList.doc.mjs';
|
|
50
52
|
import {doc as themeAddFn} from '../../../api/theme/themeAdd.doc.mjs';
|
|
51
53
|
import {doc as themeTemplateFn} from '../../../api/theme/themeTemplate.doc.mjs';
|
|
54
|
+
import {doc as themeTargetsFn} from '../../../api/theme/themeTargets.doc.mjs';
|
|
52
55
|
|
|
53
56
|
/**
|
|
54
57
|
* Path to this CLI's real entry (clients/cli/bin/astryx.mjs), resolved from
|
|
@@ -194,6 +197,36 @@ function printThemeList(themes) {
|
|
|
194
197
|
);
|
|
195
198
|
}
|
|
196
199
|
|
|
200
|
+
/**
|
|
201
|
+
* Render the targets as one greppable line each, under an aligned header. A
|
|
202
|
+
* `records()` block would be five lines per target — over a thousand for the
|
|
203
|
+
* full surface, which is the view this command exists to make readable.
|
|
204
|
+
* @param {import('../../../api/theme/theme.type.mjs').ThemeTargetEntry[]} targets
|
|
205
|
+
* @returns {string}
|
|
206
|
+
*/
|
|
207
|
+
function formatTargetsTable(targets) {
|
|
208
|
+
const rows = targets.map(t => ({
|
|
209
|
+
key: t.key,
|
|
210
|
+
component: t.component,
|
|
211
|
+
props: t.props.join(', ') || '-',
|
|
212
|
+
states: t.states.join(', ') || '-',
|
|
213
|
+
}));
|
|
214
|
+
const head = {key: 'key', component: 'component', props: 'props', states: 'states'};
|
|
215
|
+
const width = (/** @type {'key'|'component'|'props'} */ field) =>
|
|
216
|
+
[head, ...rows].reduce((max, r) => Math.max(max, r[field].length), 0);
|
|
217
|
+
const w = {key: width('key'), component: width('component'), props: width('props')};
|
|
218
|
+
const line = (/** @type {typeof head} */ r) =>
|
|
219
|
+
[
|
|
220
|
+
r.key.padEnd(w.key),
|
|
221
|
+
r.component.padEnd(w.component),
|
|
222
|
+
r.props.padEnd(w.props),
|
|
223
|
+
r.states,
|
|
224
|
+
]
|
|
225
|
+
.join(' ')
|
|
226
|
+
.trimEnd();
|
|
227
|
+
return [line(head), ...rows.map(line)].join('\n');
|
|
228
|
+
}
|
|
229
|
+
|
|
197
230
|
/**
|
|
198
231
|
* @param {import('commander').Command} program
|
|
199
232
|
*/
|
|
@@ -225,6 +258,18 @@ export function registerTheme(program) {
|
|
|
225
258
|
},
|
|
226
259
|
});
|
|
227
260
|
|
|
261
|
+
// Theming questions are asked at `theme`, but per-component overrides live
|
|
262
|
+
// under `component`. Without this pointer the group reads as a build-tool
|
|
263
|
+
// menu, and the component targets are unreachable from the noun the user
|
|
264
|
+
// started at.
|
|
265
|
+
theme.addHelpText(
|
|
266
|
+
'after',
|
|
267
|
+
`\nComponent style overrides:\n` +
|
|
268
|
+
` ${getCliInvocation()} theme targets Every themeable class, with its props and states\n` +
|
|
269
|
+
` ${getCliInvocation()} component <Name> One component's theming table\n` +
|
|
270
|
+
` ${getCliInvocation()} docs theme How component overrides work\n`,
|
|
271
|
+
);
|
|
272
|
+
|
|
228
273
|
defineCommand(theme, themeBuildCommand, {
|
|
229
274
|
fn: themeBuildFn,
|
|
230
275
|
action: async (
|
|
@@ -502,4 +547,44 @@ export function registerTheme(program) {
|
|
|
502
547
|
);
|
|
503
548
|
},
|
|
504
549
|
});
|
|
550
|
+
|
|
551
|
+
defineCommand(theme, themeTargetsCommand, {
|
|
552
|
+
fn: themeTargetsFn,
|
|
553
|
+
action: async (/** @type {string | undefined} */ filter) => {
|
|
554
|
+
const json = program.opts().json || false;
|
|
555
|
+
|
|
556
|
+
/** @type {import('../../../api/theme/theme.type.mjs').ThemeTargetsResponse} */
|
|
557
|
+
let result;
|
|
558
|
+
try {
|
|
559
|
+
result = await themeTargets(filter, {cwd: process.cwd()});
|
|
560
|
+
} catch (e) {
|
|
561
|
+
const err =
|
|
562
|
+
/** @type {import('../../../api/error.mjs').AstryxError} */ (e);
|
|
563
|
+
cliError(err.message, {
|
|
564
|
+
suggestions: err.suggestions || [],
|
|
565
|
+
code: err.code,
|
|
566
|
+
});
|
|
567
|
+
return;
|
|
568
|
+
}
|
|
569
|
+
|
|
570
|
+
if (json) return jsonOut(result);
|
|
571
|
+
|
|
572
|
+
const run = getCliInvocation();
|
|
573
|
+
const {targets, componentCount} = result.data;
|
|
574
|
+
emit(
|
|
575
|
+
section(
|
|
576
|
+
'Theming targets',
|
|
577
|
+
`${targets.length} across ${componentCount} component${componentCount === 1 ? '' : 's'}`,
|
|
578
|
+
),
|
|
579
|
+
text(formatTargetsTable(targets)),
|
|
580
|
+
text(
|
|
581
|
+
[
|
|
582
|
+
`Each key goes under \`components\` in defineTheme; it paints \`.astryx-<key>\`.`,
|
|
583
|
+
`Props take a value (\`variant:secondary\`); states are written bare (\`checked\`).`,
|
|
584
|
+
`One component in full: ${run} component <Name>`,
|
|
585
|
+
].join('\n'),
|
|
586
|
+
),
|
|
587
|
+
);
|
|
588
|
+
},
|
|
589
|
+
});
|
|
505
590
|
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
import {describe, expect, it} from 'vitest';
|
|
4
|
+
import {component} from '../../../api/component/component.mjs';
|
|
5
|
+
|
|
6
|
+
const CWD = {cwd: '.'};
|
|
7
|
+
|
|
8
|
+
// Resolves built-in block templates by walking the source tree.
|
|
9
|
+
const SCAN_TIMEOUT = 30_000;
|
|
10
|
+
|
|
11
|
+
describe(
|
|
12
|
+
'Dialog adaptive presentation template',
|
|
13
|
+
() => {
|
|
14
|
+
it('is listed as a Dialog example block', async () => {
|
|
15
|
+
const result = await component('Dialog', {
|
|
16
|
+
...CWD,
|
|
17
|
+
blocks: true,
|
|
18
|
+
});
|
|
19
|
+
const exampleNames = result.data.examples.map(b => b.name);
|
|
20
|
+
expect(exampleNames).toContain('DialogAdaptivePresentation');
|
|
21
|
+
});
|
|
22
|
+
},
|
|
23
|
+
SCAN_TIMEOUT,
|
|
24
|
+
);
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file CLI behavior for `astryx theme targets`.
|
|
5
|
+
*
|
|
6
|
+
* The API leaf is covered by api/theme/targets/targets.test.mjs; what is only
|
|
7
|
+
* reachable here is the terminal binding — the table a human reads, the JSON
|
|
8
|
+
* envelope a lint script reads, and the route into component overrides from
|
|
9
|
+
* `theme --help`, which is where the question gets asked.
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
import {describe, it, expect} from 'vitest';
|
|
13
|
+
import {runCli} from '../../../test-utils/run-cli.mjs';
|
|
14
|
+
|
|
15
|
+
describe('astryx theme targets', () => {
|
|
16
|
+
it('prints one greppable line per target, with props and states', async () => {
|
|
17
|
+
const {status, stdout} = await runCli(['theme', 'targets', 'Switch']);
|
|
18
|
+
|
|
19
|
+
expect(status).toBe(0);
|
|
20
|
+
expect(stdout).toMatch(/^switch\s+Switch\s+size\s+checked, disabled$/m);
|
|
21
|
+
expect(stdout).toMatch(/^switch-thumb\s+Switch\s+size\s+checked$/m);
|
|
22
|
+
expect(stdout).toMatch(/3 across 1 component/);
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
it('lists the whole surface when unfiltered', async () => {
|
|
26
|
+
const {status, stdout} = await runCli(['theme', 'targets']);
|
|
27
|
+
|
|
28
|
+
expect(status).toBe(0);
|
|
29
|
+
const rows = stdout.split('\n').filter(l => /^[a-z][a-z0-9-]*\s{2,}/.test(l));
|
|
30
|
+
expect(rows.length).toBeGreaterThan(100);
|
|
31
|
+
expect(stdout).toMatch(/^button\s/m);
|
|
32
|
+
expect(stdout).toMatch(/^switch-thumb\s/m);
|
|
33
|
+
}, 30_000);
|
|
34
|
+
|
|
35
|
+
it('returns a theme.targets envelope under --json', async () => {
|
|
36
|
+
const {status, stdout} = await runCli(['--json', 'theme', 'targets', 'Switch']);
|
|
37
|
+
|
|
38
|
+
expect(status).toBe(0);
|
|
39
|
+
const payload = JSON.parse(stdout);
|
|
40
|
+
expect(payload.type).toBe('theme.targets');
|
|
41
|
+
expect(payload.data.targets).toContainEqual({
|
|
42
|
+
key: 'switch-thumb',
|
|
43
|
+
className: 'astryx-switch-thumb',
|
|
44
|
+
component: 'Switch',
|
|
45
|
+
props: ['size'],
|
|
46
|
+
states: ['checked'],
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it('fails a filter that matches nothing', async () => {
|
|
51
|
+
const {status, stderr} = await runCli(['theme', 'targets', 'nosuchthing']);
|
|
52
|
+
|
|
53
|
+
expect(status).toBe(1);
|
|
54
|
+
expect(stderr).toMatch(/No theming target matches "nosuchthing"/);
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it('routes a theming question from `theme --help` to component overrides', async () => {
|
|
58
|
+
const {stdout} = await runCli(['theme', '--help']);
|
|
59
|
+
|
|
60
|
+
expect(stdout).toMatch(/Component style overrides:/);
|
|
61
|
+
expect(stdout).toMatch(/theme targets/);
|
|
62
|
+
expect(stdout).toMatch(/component <Name>/);
|
|
63
|
+
});
|
|
64
|
+
});
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file CommandDoc for `astryx theme targets`. The terminal binding of the
|
|
5
|
+
* `themeTargets()` function (referenced via `fn`); its args map to that
|
|
6
|
+
* function's params so a converter can build Commander config + --help from one
|
|
7
|
+
* source of truth.
|
|
8
|
+
* @position packages/cli/clients/cli/commands — command documentation
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/** @type {import('@astryxdesign/cli/authoring').CommandDoc} */
|
|
12
|
+
export const doc = {
|
|
13
|
+
type: 'command',
|
|
14
|
+
name: 'theme targets',
|
|
15
|
+
displayName: 'astryx theme targets',
|
|
16
|
+
namespace: 'cli',
|
|
17
|
+
summary: 'List the component theming targets a theme can override',
|
|
18
|
+
description:
|
|
19
|
+
'Prints every `defineTheme` components key across the system: the stable class it paints, ' +
|
|
20
|
+
'the component that declares it, and the props and states that are legal override keys ' +
|
|
21
|
+
'under it. This is the whole themeable surface in one command — what auditing a theme, or ' +
|
|
22
|
+
'answering "which key paints this pixel?", used to need one `astryx component <Name>` per ' +
|
|
23
|
+
'component to assemble. Pass a component name to scope it; pass any substring to search ' +
|
|
24
|
+
'keys. `--json` for a list a repo can lint its own theme against.',
|
|
25
|
+
fn: 'themeTargets',
|
|
26
|
+
args: [{name: 'filter', param: 'filter', required: false}],
|
|
27
|
+
examples: [
|
|
28
|
+
{label: 'The whole themeable surface', cli: 'astryx theme targets'},
|
|
29
|
+
{label: "One component's targets", cli: 'astryx theme targets Switch'},
|
|
30
|
+
{label: 'Search keys', cli: 'astryx theme targets thumb'},
|
|
31
|
+
{label: 'For a lint or an audit script', cli: 'astryx --json theme targets'},
|
|
32
|
+
],
|
|
33
|
+
exitCodes: [
|
|
34
|
+
{code: 0, when: 'success'},
|
|
35
|
+
{code: 1, when: 'a filter matches no target, or core cannot be resolved'},
|
|
36
|
+
],
|
|
37
|
+
related: ['component', 'theme build', 'theme template'],
|
|
38
|
+
};
|
|
@@ -17,11 +17,13 @@ export const doc = {
|
|
|
17
17
|
description:
|
|
18
18
|
'The theme command group. Running astryx theme with no subcommand prints the ' +
|
|
19
19
|
'subcommand list; the work happens in the subcommands: compile a theme (build), ' +
|
|
20
|
-
'scaffold one into your project (add), start a custom one from the annotated template (template),
|
|
21
|
-
|
|
20
|
+
'scaffold one into your project (add), start a custom one from the annotated template (template), ' +
|
|
21
|
+
'list the bundled themes (list), or list the component theming targets a theme can override (targets).',
|
|
22
|
+
subcommands: ['build', 'add', 'list', 'template', 'targets'],
|
|
22
23
|
examples: [
|
|
23
24
|
{label: 'List bundled themes', cli: 'astryx theme list'},
|
|
24
25
|
{label: 'Scaffold a theme', cli: 'astryx theme add matcha'},
|
|
26
|
+
{label: 'See what a theme can override', cli: 'astryx theme targets'},
|
|
25
27
|
],
|
|
26
28
|
exitCodes: [
|
|
27
29
|
{code: 0, when: 'success (help shown, or a subcommand succeeded)'},
|
package/clients/cli/index.mjs
CHANGED
|
@@ -77,6 +77,7 @@ export const RESPONSE_TYPES = {
|
|
|
77
77
|
'theme list': ['theme.list'],
|
|
78
78
|
'theme add': ['theme.list', 'theme.add'],
|
|
79
79
|
'theme template': ['theme.template'],
|
|
80
|
+
'theme targets': ['theme.targets'],
|
|
80
81
|
upgrade: ['upgrade.list', 'upgrade.status', 'upgrade.run'],
|
|
81
82
|
manifest: ['manifest'],
|
|
82
83
|
doctor: ['doctor'],
|
|
@@ -116,6 +117,7 @@ const EXAMPLES = {
|
|
|
116
117
|
'astryx theme add matcha ./src/themes/matcha',
|
|
117
118
|
],
|
|
118
119
|
'theme template': ['astryx theme template', 'astryx theme template --json'],
|
|
120
|
+
'theme targets': ['astryx theme targets Switch', 'astryx --json theme targets'],
|
|
119
121
|
upgrade: ['astryx upgrade --json'],
|
|
120
122
|
manifest: ['astryx manifest --json', 'astryx --json'],
|
|
121
123
|
doctor: ['astryx doctor', 'astryx doctor --json'],
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
// @generated by scripts/sync-api-types.mjs from the JSDoc in foundation/**/*.mjs.
|
|
2
|
+
// DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Every theming target declared under a core `src` directory, sorted by key
|
|
6
|
+
* then component. A key can appear more than once: a shared sub-element (the
|
|
7
|
+
* radio indicator, say) is documented by every component that renders it.
|
|
8
|
+
*
|
|
9
|
+
* Unreadable docs are skipped rather than fatal — a single malformed doc must
|
|
10
|
+
* not take out theme validation or the listing.
|
|
11
|
+
*
|
|
12
|
+
* @param {string} coreSrc - absolute path to `<core>/src`
|
|
13
|
+
* @returns {Promise<ThemingTarget[]>}
|
|
14
|
+
*/
|
|
15
|
+
export function collectThemingTargets(coreSrc: string): Promise<ThemingTarget[]>;
|
|
16
|
+
/**
|
|
17
|
+
* Collapse the enumeration into the `{key: [props and states]}` map theme
|
|
18
|
+
* validation checks override keys against — both are legal override keys, so
|
|
19
|
+
* they share one list.
|
|
20
|
+
* @param {ThemingTarget[]} targets
|
|
21
|
+
* @returns {Record<string, string[]>}
|
|
22
|
+
*/
|
|
23
|
+
export function targetsByKey(targets: ThemingTarget[]): Record<string, string[]>;
|
|
24
|
+
/**
|
|
25
|
+
* One theming target, as a theme author has to write it.
|
|
26
|
+
*/
|
|
27
|
+
export type ThemingTarget = {
|
|
28
|
+
/**
|
|
29
|
+
* - the `defineTheme` `components` key (class minus the `astryx-` prefix)
|
|
30
|
+
*/
|
|
31
|
+
key: string;
|
|
32
|
+
/**
|
|
33
|
+
* - the stable class the component renders
|
|
34
|
+
*/
|
|
35
|
+
className: string;
|
|
36
|
+
/**
|
|
37
|
+
* - the component whose doc declares it
|
|
38
|
+
*/
|
|
39
|
+
component: string;
|
|
40
|
+
/**
|
|
41
|
+
* - visual props the target reflects (`variant:value` keys)
|
|
42
|
+
*/
|
|
43
|
+
props: string[];
|
|
44
|
+
/**
|
|
45
|
+
* - runtime states the target reflects (bare-name keys)
|
|
46
|
+
*/
|
|
47
|
+
states: string[];
|
|
48
|
+
};
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file The one enumeration of component theming targets.
|
|
5
|
+
*
|
|
6
|
+
* @input a core `src` directory
|
|
7
|
+
* @output every `theming.targets` entry authored in a component `.doc.mjs`,
|
|
8
|
+
* flattened into the `defineTheme` component key a theme author writes
|
|
9
|
+
* @position packages/cli/foundation/discovery — shared by `theme targets` (the
|
|
10
|
+
* listing) and `theme build` (override validation). Both read the
|
|
11
|
+
* component docs, which are the source of truth `astryx component
|
|
12
|
+
* <Name>` prints; nothing here is a second registry, so the list a
|
|
13
|
+
* theme author can enumerate and the set the compiler accepts cannot
|
|
14
|
+
* drift from the components or from each other.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import * as fs from 'node:fs';
|
|
18
|
+
import * as path from 'node:path';
|
|
19
|
+
import {loadComponentDoc} from './component-loader.mjs';
|
|
20
|
+
|
|
21
|
+
const SKIP_DIRS = new Set(['node_modules', '__tests__']);
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* One theming target, as a theme author has to write it.
|
|
25
|
+
* @typedef {object} ThemingTarget
|
|
26
|
+
* @property {string} key - the `defineTheme` `components` key (class minus the `astryx-` prefix)
|
|
27
|
+
* @property {string} className - the stable class the component renders
|
|
28
|
+
* @property {string} component - the component whose doc declares it
|
|
29
|
+
* @property {string[]} props - visual props the target reflects (`variant:value` keys)
|
|
30
|
+
* @property {string[]} states - runtime states the target reflects (bare-name keys)
|
|
31
|
+
*/
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Strip the namespace prefix to get the `defineTheme` key for a class name.
|
|
35
|
+
*
|
|
36
|
+
* Keep the `astryx-` literal in sync with packages/core/src/naming.ts
|
|
37
|
+
* (NAMESPACE / classPrefix), the same way component-format.mjs does.
|
|
38
|
+
* <!-- SYNC: packages/core/src/naming.ts (namespace prefix source of truth) -->
|
|
39
|
+
* @param {string} className
|
|
40
|
+
* @returns {string}
|
|
41
|
+
*/
|
|
42
|
+
function targetKey(className) {
|
|
43
|
+
return className.replace(/^astryx-/, '');
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Every theming target declared under a core `src` directory, sorted by key
|
|
48
|
+
* then component. A key can appear more than once: a shared sub-element (the
|
|
49
|
+
* radio indicator, say) is documented by every component that renders it.
|
|
50
|
+
*
|
|
51
|
+
* Unreadable docs are skipped rather than fatal — a single malformed doc must
|
|
52
|
+
* not take out theme validation or the listing.
|
|
53
|
+
*
|
|
54
|
+
* @param {string} coreSrc - absolute path to `<core>/src`
|
|
55
|
+
* @returns {Promise<ThemingTarget[]>}
|
|
56
|
+
*/
|
|
57
|
+
export async function collectThemingTargets(coreSrc) {
|
|
58
|
+
if (!coreSrc || !fs.existsSync(coreSrc)) return [];
|
|
59
|
+
|
|
60
|
+
/** @type {ThemingTarget[]} */
|
|
61
|
+
const targets = [];
|
|
62
|
+
|
|
63
|
+
/** @param {string} dir */
|
|
64
|
+
async function scan(dir) {
|
|
65
|
+
for (const entry of fs.readdirSync(dir, {withFileTypes: true})) {
|
|
66
|
+
const full = path.join(dir, entry.name);
|
|
67
|
+
if (entry.isDirectory()) {
|
|
68
|
+
if (SKIP_DIRS.has(entry.name)) continue;
|
|
69
|
+
await scan(full);
|
|
70
|
+
continue;
|
|
71
|
+
}
|
|
72
|
+
if (!entry.name.endsWith('.doc.mjs')) continue;
|
|
73
|
+
|
|
74
|
+
/** @type {any} */
|
|
75
|
+
let doc;
|
|
76
|
+
try {
|
|
77
|
+
doc = await loadComponentDoc(full);
|
|
78
|
+
} catch {
|
|
79
|
+
continue;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
const component =
|
|
83
|
+
typeof doc?.name === 'string' && doc.name
|
|
84
|
+
? doc.name
|
|
85
|
+
: path.basename(path.dirname(full));
|
|
86
|
+
|
|
87
|
+
for (const target of doc?.theming?.targets || []) {
|
|
88
|
+
const className = target?.className;
|
|
89
|
+
if (typeof className !== 'string') continue;
|
|
90
|
+
const key = targetKey(className);
|
|
91
|
+
if (!key) continue;
|
|
92
|
+
targets.push({
|
|
93
|
+
key,
|
|
94
|
+
className,
|
|
95
|
+
component,
|
|
96
|
+
props: stringList(target.visualProps),
|
|
97
|
+
states: stringList(target.states),
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
await scan(coreSrc);
|
|
104
|
+
|
|
105
|
+
targets.sort(
|
|
106
|
+
(a, b) => a.key.localeCompare(b.key) || a.component.localeCompare(b.component),
|
|
107
|
+
);
|
|
108
|
+
return targets;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Collapse the enumeration into the `{key: [props and states]}` map theme
|
|
113
|
+
* validation checks override keys against — both are legal override keys, so
|
|
114
|
+
* they share one list.
|
|
115
|
+
* @param {ThemingTarget[]} targets
|
|
116
|
+
* @returns {Record<string, string[]>}
|
|
117
|
+
*/
|
|
118
|
+
export function targetsByKey(targets) {
|
|
119
|
+
/** @type {Record<string, string[]>} */
|
|
120
|
+
const byKey = {};
|
|
121
|
+
for (const t of targets) {
|
|
122
|
+
byKey[t.key] = [...new Set([...(byKey[t.key] || []), ...t.props, ...t.states])];
|
|
123
|
+
}
|
|
124
|
+
return byKey;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* @param {unknown} value
|
|
129
|
+
* @returns {string[]}
|
|
130
|
+
*/
|
|
131
|
+
function stringList(value) {
|
|
132
|
+
return Array.isArray(value)
|
|
133
|
+
? value.filter((/** @type {unknown} */ v) => typeof v === 'string')
|
|
134
|
+
: [];
|
|
135
|
+
}
|