@astryxdesign/cli 0.7.2-canary.ebcc404 → 0.7.2-canary.f8f7cf1
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/README.md +9 -8
- package/api/build/help/help.mjs +1 -1
- package/api/component/_adapter.d.mts +14 -0
- package/api/component/_adapter.mjs +48 -0
- package/api/component/component.mjs +10 -2
- package/api/component/integration-export-name.test.mjs +233 -8
- package/api/docs/_adapter.d.mts +11 -0
- package/api/docs/_adapter.mjs +244 -1
- package/api/docs/integrationDocs.test.mjs +124 -0
- package/api/doctor/theme-checks.mjs +1 -1
- package/api/gap-report/gap-report.mjs +2 -1
- package/api/index.d.mts +2 -0
- package/api/index.mjs +2 -0
- package/api/init/run/run.mjs +2 -2
- package/api/integration/_adapter.d.mts +12 -0
- package/api/integration/_adapter.mjs +54 -0
- package/api/integration/add-contribution.component-names.test.mjs +66 -0
- package/api/integration/add-contribution.mjs +8 -4
- package/api/integration/add-contribution.test.mjs +4 -2
- package/api/integration/authoring-checks.mjs +11 -2
- package/api/integration/authoring-checks.test.mjs +39 -0
- package/api/integration/authoring-checks.type.d.mts +9 -0
- package/api/integration/authoring-checks.type.mjs +14 -1
- package/api/integration/check/check.d.mts +96 -0
- package/api/integration/check/check.mjs +357 -0
- package/api/integration/check/check.test.mjs +489 -0
- package/api/integration/integration-check.type.d.mts +118 -0
- package/api/integration/integration-check.type.mjs +84 -0
- package/api/integration/integrationCheck.doc.d.mts +10 -0
- package/api/integration/integrationCheck.doc.mjs +73 -0
- package/api/integration/integrationComponentConflicts.doc.mjs +36 -5
- package/api/integration/pack-check.mjs +48 -3
- package/api/integration/pack-check.test.mjs +247 -0
- package/api/integration/validate-integration.mjs +8 -0
- package/api/integration/validate-integration.test.mjs +11 -0
- package/api/integration/validate-integration.type.d.mts +8 -0
- package/api/integration/validate-integration.type.mjs +12 -1
- package/api/integration/validateIntegration.doc.mjs +17 -3
- package/api/search/search.integration-check.test.mjs +24 -0
- package/api/search/search.mjs +20 -8
- package/api/theme/build/build.family.test.mjs +54 -6
- package/api/theme/build/build.mjs +114 -17
- package/api/theme/themeBuild.doc.mjs +4 -4
- package/assets/docs/README.md +10 -0
- package/assets/docs/author-a-theme.doc.mjs +1 -1
- package/assets/docs/getting-started.doc.mjs +3 -3
- package/assets/docs/theme.doc.dense.mjs +1 -1
- package/assets/docs/theme.doc.mjs +1 -1
- package/assets/docs/theme.doc.zh.mjs +1 -1
- package/assets/docs/tree/add-a-component.doc.mjs +10 -0
- package/assets/docs/tree/block-template.doc.mjs +2 -2
- package/assets/docs/tree/check-the-props.doc.mjs +196 -0
- package/assets/docs/tree/check-your-docs.doc.mjs +44 -3
- package/assets/docs/tree/checks.doc.mjs +21 -13
- package/assets/docs/tree/component-family.doc.mjs +5 -1
- package/assets/docs/tree/component-imports.doc.mjs +1 -1
- package/assets/docs/tree/describe-the-component.doc.mjs +1 -1
- package/assets/docs/tree/links.doc.mjs +2 -2
- package/assets/docs/tree/page-template.doc.mjs +1 -1
- package/assets/docs/tree/quick-start.doc.mjs +1 -1
- package/assets/docs/tree/replace-a-core-template.doc.mjs +1 -1
- package/assets/docs/tree/single-component.doc.mjs +3 -2
- package/assets/docs/tree/troubleshooting.doc.mjs +9 -1
- package/assets/docs/tree/type-scale.doc.mjs +3 -3
- package/assets/docs/tree/versioning.doc.mjs +1 -0
- package/assets/docs/tree/write-the-template-file.doc.mjs +2 -1
- package/assets/docs/use-a-theme.doc.mjs +2 -2
- package/assets/theme.template.ts +1 -1
- package/authoring/doctypes/component/component.doc.mjs +1 -1
- package/authoring/doctypes/template/integration-template.doc.d.mts +11 -0
- package/authoring/doctypes/template/integration-template.doc.mjs +49 -0
- package/authoring/doctypes/template/parse.d.mts +6 -2
- package/authoring/doctypes/template/parse.mjs +3 -1
- package/authoring/doctypes/template/template.doc.mjs +1 -1
- package/authoring/doctypes/template/type.ts +22 -0
- package/authoring/index.d.ts +1 -0
- package/authoring/integration/integration.doc.mjs +8 -1
- package/authoring/integration/parse.test.mjs +10 -0
- package/authoring/integration/schema.d.mts +2 -0
- package/authoring/integration/schema.mjs +1 -0
- package/authoring/integration/type.ts +4 -0
- package/clients/cli/commands/build-theme.batch-report.test.mjs +3 -1
- package/clients/cli/commands/build-theme.mjs +1 -1
- package/clients/cli/commands/build-theme.path-safety.test.mjs +155 -21
- package/clients/cli/commands/doctor-integration-components.doc.mjs +15 -4
- package/clients/cli/commands/doctor-integration-validate.doc.mjs +11 -2
- package/clients/cli/commands/doctor-integration.test.mjs +837 -0
- package/clients/cli/commands/doctor.mjs +190 -0
- package/clients/cli/commands/integration-check.doc.mjs +85 -0
- package/clients/cli/commands/integration-check.test.mjs +267 -0
- package/clients/cli/commands/integration.doc.mjs +6 -2
- package/clients/cli/commands/integration.mjs +107 -1
- package/clients/cli/commands/text-json-parity.test.mjs +5 -0
- package/clients/cli/commands/theme-build.doc.mjs +2 -2
- package/clients/cli/index.mjs +1 -0
- package/foundation/config/project.mjs +82 -0
- package/foundation/discovery/authoring-self-docs.mjs +1 -0
- package/foundation/discovery/component-discovery.d.mts +108 -17
- package/foundation/discovery/component-discovery.export-names.test.mjs +469 -2
- package/foundation/discovery/component-discovery.mjs +380 -47
- package/foundation/discovery/component-replacement.test.mjs +20 -0
- package/foundation/discovery/doc-types.d.mts +157 -0
- package/foundation/discovery/doc-types.mjs +1224 -0
- package/foundation/discovery/doc-types.test.mjs +652 -0
- package/foundation/discovery/docs-discovery.d.mts +81 -0
- package/foundation/discovery/docs-discovery.mjs +57 -0
- package/foundation/discovery/integration-doc-files.d.mts +22 -0
- package/foundation/discovery/integration-doc-files.mjs +231 -0
- package/foundation/discovery/integration-doc-files.test.mjs +246 -0
- package/foundation/discovery/module-exports.d.mts +6 -0
- package/foundation/discovery/module-exports.mjs +15 -2
- package/foundation/discovery/package-tsconfig.d.mts +14 -0
- package/foundation/discovery/package-tsconfig.mjs +228 -0
- package/foundation/discovery/package-tsconfig.test.mjs +210 -0
- package/foundation/discovery/project-typescript.d.mts +23 -0
- package/foundation/discovery/project-typescript.mjs +61 -0
- package/foundation/discovery/prop-drift.d.mts +278 -0
- package/foundation/discovery/prop-drift.mjs +2263 -0
- package/foundation/discovery/prop-drift.test.mjs +2219 -0
- package/foundation/discovery/type-match.d.mts +53 -0
- package/foundation/discovery/type-match.mjs +660 -0
- package/foundation/discovery/type-match.test.mjs +169 -0
- package/foundation/discovery/type-text.d.mts +68 -0
- package/foundation/discovery/type-text.mjs +658 -0
- package/foundation/discovery/type-text.test.mjs +196 -0
- package/foundation/discovery/unresolved-references.d.mts +62 -0
- package/foundation/discovery/unresolved-references.mjs +790 -0
- package/foundation/discovery/unresolved-references.test.mjs +567 -0
- package/foundation/doc-compiler/doc-loads.test.mjs +6 -0
- package/foundation/doc-compiler/links.d.mts +9 -5
- package/foundation/doc-compiler/links.mjs +4 -2
- package/foundation/integrations/contribution-inventory.mjs +6 -1
- package/foundation/response/response-types.doc.mjs +7 -2
- package/package.json +9 -9
package/api/docs/_adapter.mjs
CHANGED
|
@@ -17,8 +17,11 @@
|
|
|
17
17
|
* foundation/discovery/docs-discovery, which the catalog comes from.
|
|
18
18
|
*/
|
|
19
19
|
|
|
20
|
+
import * as path from 'node:path';
|
|
20
21
|
import {Project} from '../../foundation/config/project.mjs';
|
|
21
22
|
import {DocsCatalog} from '../../foundation/discovery/docs-discovery.mjs';
|
|
23
|
+
import {checkDocTypes} from '../../foundation/discovery/doc-types.mjs';
|
|
24
|
+
import {integrationDocFiles} from '../../foundation/discovery/integration-doc-files.mjs';
|
|
22
25
|
import {
|
|
23
26
|
linkReferenceTopic,
|
|
24
27
|
lowerReferenceTopic,
|
|
@@ -53,6 +56,17 @@ import {
|
|
|
53
56
|
selfDocSection,
|
|
54
57
|
} from '../../foundation/discovery/authoring-self-docs.mjs';
|
|
55
58
|
import {CLI_PROVIDER_ID} from '../../foundation/identity/providers.mjs';
|
|
59
|
+
import {
|
|
60
|
+
CORE_PACKAGE,
|
|
61
|
+
discoverOwnedComponents,
|
|
62
|
+
discoverValidIntegrationComponents,
|
|
63
|
+
} from '../../foundation/discovery/component-discovery.mjs';
|
|
64
|
+
import {loadComponentDoc} from '../../foundation/discovery/component-loader.mjs';
|
|
65
|
+
import {
|
|
66
|
+
discoverCoreTemplates,
|
|
67
|
+
discoverIntegrationTemplatesForOne,
|
|
68
|
+
} from '../../foundation/discovery/template-adapter.mjs';
|
|
69
|
+
import {findCoreDir} from '../../foundation/fs/paths.mjs';
|
|
56
70
|
import {AstryxError} from '../error.mjs';
|
|
57
71
|
import {ERROR_CODES} from '../../foundation/response/error-codes.mjs';
|
|
58
72
|
|
|
@@ -495,12 +509,205 @@ async function docFinder(catalog, fromProvider) {
|
|
|
495
509
|
};
|
|
496
510
|
}
|
|
497
511
|
}
|
|
512
|
+
if (CONTRIBUTED_KINDS.has(parsed.kind)) {
|
|
513
|
+
const link = await contributedDocLink(
|
|
514
|
+
catalog,
|
|
515
|
+
provider,
|
|
516
|
+
parsed.kind,
|
|
517
|
+
parsed.name,
|
|
518
|
+
);
|
|
519
|
+
if (link)
|
|
520
|
+
return {link: {target, ...link}, kind: parsed.kind, typed: null};
|
|
521
|
+
}
|
|
522
|
+
const searchType =
|
|
523
|
+
parsed.kind === 'component'
|
|
524
|
+
? 'component'
|
|
525
|
+
: parsed.kind === 'page' || parsed.kind === 'block'
|
|
526
|
+
? 'template'
|
|
527
|
+
: 'doc';
|
|
498
528
|
return {
|
|
499
|
-
problem: `"${target}" names no doc. Find it with \`astryx search ${parsed.name} --type
|
|
529
|
+
problem: `"${target}" names no doc. Find it with \`astryx search ${parsed.name} --type ${searchType}\`, then name it as \`[<provider>:]<kind>:<name>\`.`,
|
|
500
530
|
};
|
|
501
531
|
};
|
|
502
532
|
}
|
|
503
533
|
|
|
534
|
+
/** The doc kinds no docs tree holds: components and templates. */
|
|
535
|
+
const CONTRIBUTED_KINDS = new Set(['component', 'page', 'block']);
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* The link to a component, page, or block doc (spec:AST-047 FR9). No docs tree
|
|
539
|
+
* holds these, so a link finds them among the component and template records
|
|
540
|
+
* the catalog carries, the ones `astryx component` and `astryx template` open,
|
|
541
|
+
* and reads as that command. A component is named by its export name, a
|
|
542
|
+
* template by its id; anything but Core's names its package.
|
|
543
|
+
* @param {DocsCatalog} catalog
|
|
544
|
+
* @param {string} provider normalized provider id
|
|
545
|
+
* @param {string} kind `component`, `page`, or `block`
|
|
546
|
+
* @param {string} name
|
|
547
|
+
* @returns {Promise<Omit<import('../../foundation/doc-compiler/links.mjs').DocLink, 'target'> | null>}
|
|
548
|
+
*/
|
|
549
|
+
async function contributedDocLink(catalog, provider, kind, name) {
|
|
550
|
+
const contributions = await catalog.contributions();
|
|
551
|
+
if (!contributions) return null;
|
|
552
|
+
const sameProvider = (/** @type {string} */ providerId) => {
|
|
553
|
+
try {
|
|
554
|
+
return normalizeProviderId(providerId) === provider;
|
|
555
|
+
} catch {
|
|
556
|
+
return false;
|
|
557
|
+
}
|
|
558
|
+
};
|
|
559
|
+
if (kind === 'component') {
|
|
560
|
+
const record = contributions.components.find(
|
|
561
|
+
component =>
|
|
562
|
+
component.name === name && sameProvider(component.providerId),
|
|
563
|
+
);
|
|
564
|
+
if (!record) return null;
|
|
565
|
+
/** @type {any} */
|
|
566
|
+
let doc = null;
|
|
567
|
+
try {
|
|
568
|
+
doc = record.docPath ? await loadComponentDoc(record.docPath) : null;
|
|
569
|
+
} catch {
|
|
570
|
+
// The component checks report a doc that does not load; the link
|
|
571
|
+
// still opens the component.
|
|
572
|
+
}
|
|
573
|
+
const entry =
|
|
574
|
+
doc?.name === name
|
|
575
|
+
? doc
|
|
576
|
+
: doc?.components?.find(
|
|
577
|
+
(/** @type {any} */ each) => each.name === name,
|
|
578
|
+
);
|
|
579
|
+
// Bare, Core's name opens Core's component unless another package ships
|
|
580
|
+
// the same name or replaces it (spec:AST-035 FR11); then the link selects
|
|
581
|
+
// Core, as it always selects any other package.
|
|
582
|
+
const selectPackage =
|
|
583
|
+
record.package !== CORE_PACKAGE ||
|
|
584
|
+
contributions.components.some(
|
|
585
|
+
other =>
|
|
586
|
+
other.package !== CORE_PACKAGE &&
|
|
587
|
+
(other.name === name || other.replaces === name),
|
|
588
|
+
);
|
|
589
|
+
return {
|
|
590
|
+
id: createDocId(provider, 'component', name),
|
|
591
|
+
route: null,
|
|
592
|
+
title: entry?.displayName ?? name,
|
|
593
|
+
summary: entry?.description ?? doc?.description ?? '',
|
|
594
|
+
command: `astryx component ${name}${selectPackage ? ` --package ${record.package}` : ''}`,
|
|
595
|
+
};
|
|
596
|
+
}
|
|
597
|
+
const template = contributions.templates.find(
|
|
598
|
+
each =>
|
|
599
|
+
each.type === kind && each.id === name && sameProvider(each.providerId),
|
|
600
|
+
);
|
|
601
|
+
if (!template) return null;
|
|
602
|
+
// The same for a Core template: another package's template of its kind
|
|
603
|
+
// with its id, or one that replaces it, takes the bare id.
|
|
604
|
+
const selectPackage =
|
|
605
|
+
template.package !== CORE_PACKAGE ||
|
|
606
|
+
contributions.templates.some(
|
|
607
|
+
other =>
|
|
608
|
+
other.package !== CORE_PACKAGE &&
|
|
609
|
+
other.type === template.type &&
|
|
610
|
+
(other.id === name || other.replaces === name),
|
|
611
|
+
);
|
|
612
|
+
return {
|
|
613
|
+
id: createDocId(provider, template.type, name),
|
|
614
|
+
route: null,
|
|
615
|
+
title: template.displayName ?? template.name,
|
|
616
|
+
summary: template.description ?? '',
|
|
617
|
+
command: `astryx template ${name} --type ${template.type}${selectPackage ? ` --package ${template.package}` : ''}`,
|
|
618
|
+
};
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
/**
|
|
622
|
+
* The component and template docs one integration package's links can name:
|
|
623
|
+
* Core's and its own, as `doctor integration docs` checks it before any app
|
|
624
|
+
* configures it.
|
|
625
|
+
* @param {any} integration a loaded integration: its name, provider id, roots,
|
|
626
|
+
* and package directory
|
|
627
|
+
* @returns {Promise<import('../../foundation/discovery/docs-discovery.mjs').LinkableContributions>}
|
|
628
|
+
*/
|
|
629
|
+
async function packageContributions(integration) {
|
|
630
|
+
const own = integration.providerId ?? integration.name;
|
|
631
|
+
/** @type {import('../../foundation/discovery/docs-discovery.mjs').LinkableComponent[]} */
|
|
632
|
+
const components = [];
|
|
633
|
+
const coreDir = findCoreDir(integration.__packageDir ?? process.cwd());
|
|
634
|
+
if (coreDir) {
|
|
635
|
+
try {
|
|
636
|
+
for (const record of discoverOwnedComponents(coreDir, [])) {
|
|
637
|
+
components.push({
|
|
638
|
+
providerId: CORE_PACKAGE,
|
|
639
|
+
package: CORE_PACKAGE,
|
|
640
|
+
name: record.name,
|
|
641
|
+
docPath: record.docPath,
|
|
642
|
+
});
|
|
643
|
+
}
|
|
644
|
+
} catch {
|
|
645
|
+
// The components check reports a Core it cannot read.
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
if (integration.components) {
|
|
649
|
+
try {
|
|
650
|
+
const {components: records} =
|
|
651
|
+
await discoverValidIntegrationComponents(integration);
|
|
652
|
+
for (const record of records) {
|
|
653
|
+
components.push({
|
|
654
|
+
providerId: own,
|
|
655
|
+
package: integration.name,
|
|
656
|
+
name: record.name,
|
|
657
|
+
docPath: record.docPath,
|
|
658
|
+
// Declared: this package alone cannot tell whether an app applies
|
|
659
|
+
// it, so a link to the Core name it names selects Core.
|
|
660
|
+
...(typeof record.replaces === 'string'
|
|
661
|
+
? {replaces: record.replaces}
|
|
662
|
+
: {}),
|
|
663
|
+
});
|
|
664
|
+
}
|
|
665
|
+
} catch {
|
|
666
|
+
// `validate` reports components that do not load.
|
|
667
|
+
}
|
|
668
|
+
}
|
|
669
|
+
/** @type {import('../../foundation/discovery/docs-discovery.mjs').LinkableTemplate[]} */
|
|
670
|
+
const templates = [];
|
|
671
|
+
/** @param {any} template @param {string} providerId @param {string} pkg */
|
|
672
|
+
const addTemplate = (template, providerId, pkg) => {
|
|
673
|
+
if (template.type !== 'page' && template.type !== 'block') return;
|
|
674
|
+
templates.push({
|
|
675
|
+
providerId,
|
|
676
|
+
package: pkg,
|
|
677
|
+
type: template.type,
|
|
678
|
+
id: template.dirName,
|
|
679
|
+
name: template.name,
|
|
680
|
+
...(template.displayName == null
|
|
681
|
+
? {}
|
|
682
|
+
: {displayName: template.displayName}),
|
|
683
|
+
...(template.description == null
|
|
684
|
+
? {}
|
|
685
|
+
: {description: template.description}),
|
|
686
|
+
...(typeof template.replaces === 'string'
|
|
687
|
+
? {replaces: template.replaces}
|
|
688
|
+
: {}),
|
|
689
|
+
});
|
|
690
|
+
};
|
|
691
|
+
try {
|
|
692
|
+
for (const template of await discoverCoreTemplates()) {
|
|
693
|
+
addTemplate(template, CORE_PACKAGE, CORE_PACKAGE);
|
|
694
|
+
}
|
|
695
|
+
} catch {
|
|
696
|
+
// Core templates that do not load leave nothing to link to.
|
|
697
|
+
}
|
|
698
|
+
if (integration.templates) {
|
|
699
|
+
try {
|
|
700
|
+
const {templates: records} =
|
|
701
|
+
await discoverIntegrationTemplatesForOne(integration);
|
|
702
|
+
for (const template of records)
|
|
703
|
+
addTemplate(template, own, integration.name);
|
|
704
|
+
} catch {
|
|
705
|
+
// `validate` reports templates that do not load.
|
|
706
|
+
}
|
|
707
|
+
}
|
|
708
|
+
return {components, templates};
|
|
709
|
+
}
|
|
710
|
+
|
|
504
711
|
/**
|
|
505
712
|
* How a doc's links find their targets (spec:AST-047 FR9), as
|
|
506
713
|
* {@link docFinder} finds them: each resolves to the link a read shows.
|
|
@@ -701,6 +908,7 @@ export async function docsLinkProblems(
|
|
|
701
908
|
*/
|
|
702
909
|
export async function packageDocsProblems(integration, discovered) {
|
|
703
910
|
const catalog = DocsCatalog.fromBuiltins();
|
|
911
|
+
catalog.setContributions(() => packageContributions(integration));
|
|
704
912
|
for (const record of discovered.records) catalog.add(record);
|
|
705
913
|
catalog.addTreeInputs({
|
|
706
914
|
namespaces: discovered.namespaces.map(input => ({...input, rank: 1})),
|
|
@@ -794,6 +1002,7 @@ async function namespaceReferenceTarget(catalog, route, lang) {
|
|
|
794
1002
|
*/
|
|
795
1003
|
export async function packageReferenceProblems(integration, discovered) {
|
|
796
1004
|
const catalog = DocsCatalog.fromBuiltins();
|
|
1005
|
+
catalog.setContributions(() => packageContributions(integration));
|
|
797
1006
|
for (const record of discovered.records) catalog.add(record);
|
|
798
1007
|
catalog.addTreeInputs({
|
|
799
1008
|
namespaces: discovered.namespaces.map(input => ({...input, rank: 1})),
|
|
@@ -1125,3 +1334,37 @@ export async function resolveTopicDocs(topic, options = {}) {
|
|
|
1125
1334
|
const node = await lowerTopic(catalog, entry, effectiveLang);
|
|
1126
1335
|
return {catalog, node, lang: effectiveLang, entry};
|
|
1127
1336
|
}
|
|
1337
|
+
|
|
1338
|
+
/**
|
|
1339
|
+
* Each doc one integration package ships, checked against the published
|
|
1340
|
+
* authoring type for its kind with the project's own TypeScript (spec:AST-039
|
|
1341
|
+
* FR13). Without TypeScript the report says nothing was checked.
|
|
1342
|
+
* @param {any} integration a loaded integration
|
|
1343
|
+
* @param {string} cwd
|
|
1344
|
+
* @returns {Promise<import('../../foundation/discovery/doc-types.mjs').DocTypesReport & {fixtures?: number}>}
|
|
1345
|
+
*/
|
|
1346
|
+
export async function integrationDocTypes(integration, cwd) {
|
|
1347
|
+
const packageDir = /** @type {{__packageDir?: string}} */ (integration)
|
|
1348
|
+
.__packageDir;
|
|
1349
|
+
const {files, unread, fixtures} = await integrationDocFiles(integration);
|
|
1350
|
+
const checked = await checkDocTypes(files, {
|
|
1351
|
+
packageDir: packageDir ?? cwd,
|
|
1352
|
+
resolveFrom: [cwd, packageDir],
|
|
1353
|
+
});
|
|
1354
|
+
// Test fixtures no reader serves don't ship as docs: only counted.
|
|
1355
|
+
const report =
|
|
1356
|
+
checked.status === 'checked' && fixtures > 0
|
|
1357
|
+
? {...checked, fixtures}
|
|
1358
|
+
: checked;
|
|
1359
|
+
if (report.status !== 'checked' || unread.length === 0) return report;
|
|
1360
|
+
// A root its reader cannot read serves no doc; say so rather than skip it.
|
|
1361
|
+
const rel = (/** @type {string} */ file) =>
|
|
1362
|
+
path.relative(packageDir ?? cwd, file).split(path.sep).join('/') || '.';
|
|
1363
|
+
return {
|
|
1364
|
+
...report,
|
|
1365
|
+
unchecked: [
|
|
1366
|
+
...report.unchecked,
|
|
1367
|
+
...unread.map(entry => ({doc: rel(entry.path), reason: entry.reason})),
|
|
1368
|
+
].sort((a, b) => a.doc.localeCompare(b.doc)),
|
|
1369
|
+
};
|
|
1370
|
+
}
|
|
@@ -22,6 +22,7 @@ import {docs} from './docs.mjs';
|
|
|
22
22
|
import {search} from '../search/search.mjs';
|
|
23
23
|
import {loadDocsCatalog} from './_adapter.mjs';
|
|
24
24
|
import {AstryxError} from '../error.mjs';
|
|
25
|
+
import {discoverCoreTemplates} from '../../foundation/discovery/template-adapter.mjs';
|
|
25
26
|
|
|
26
27
|
const SLOW = 30_000;
|
|
27
28
|
|
|
@@ -110,6 +111,129 @@ describe('integration-contributed topics', () => {
|
|
|
110
111
|
expect(section.data.title).toBe('Overview');
|
|
111
112
|
}, SLOW);
|
|
112
113
|
|
|
114
|
+
it('reads a link to a component or a template as the command that opens it', async () => {
|
|
115
|
+
scaffold({
|
|
116
|
+
'using-widgets.doc.mjs': topic({
|
|
117
|
+
name: 'using-widgets',
|
|
118
|
+
title: 'Using widgets',
|
|
119
|
+
sections: [
|
|
120
|
+
{
|
|
121
|
+
title: 'Overview',
|
|
122
|
+
content: [
|
|
123
|
+
{
|
|
124
|
+
type: 'prose',
|
|
125
|
+
text: 'Start with {@link component:AcmeButton} or {@link block:acme-card}, built on {@link @astryxdesign/core:component:Button}.',
|
|
126
|
+
},
|
|
127
|
+
],
|
|
128
|
+
},
|
|
129
|
+
],
|
|
130
|
+
}),
|
|
131
|
+
});
|
|
132
|
+
const pkgDir = path.join(tmpDir, 'node_modules', '@acme', 'widgets');
|
|
133
|
+
fs.writeFileSync(
|
|
134
|
+
path.join(pkgDir, 'astryx.integration.mjs'),
|
|
135
|
+
"export default {components: './components', templates: './templates', docs: './docs'};\n",
|
|
136
|
+
);
|
|
137
|
+
fs.mkdirSync(path.join(pkgDir, 'components'));
|
|
138
|
+
fs.writeFileSync(
|
|
139
|
+
path.join(pkgDir, 'components', 'AcmeButton.doc.mjs'),
|
|
140
|
+
"export default {type: 'component', name: 'AcmeButton', displayName: 'Acme Button', description: 'A button.', props: []};\n",
|
|
141
|
+
);
|
|
142
|
+
fs.writeFileSync(
|
|
143
|
+
path.join(pkgDir, 'components', 'AcmeButton.tsx'),
|
|
144
|
+
'export function AcmeButton() { return null; }\n',
|
|
145
|
+
);
|
|
146
|
+
fs.mkdirSync(path.join(pkgDir, 'templates'));
|
|
147
|
+
fs.writeFileSync(
|
|
148
|
+
path.join(pkgDir, 'templates', 'acme-card.doc.mjs'),
|
|
149
|
+
"export default {type: 'block', name: 'Acme card', description: 'A card.'};\n",
|
|
150
|
+
);
|
|
151
|
+
fs.writeFileSync(
|
|
152
|
+
path.join(pkgDir, 'templates', 'acme-card.tsx'),
|
|
153
|
+
'export default function Fixture() { return null; }\n',
|
|
154
|
+
);
|
|
155
|
+
|
|
156
|
+
const detail = await docs('using-widgets', undefined, {cwd: tmpDir, full: true});
|
|
157
|
+
|
|
158
|
+
const prose = JSON.stringify(detail.data.sections);
|
|
159
|
+
expect(prose).toContain('`astryx component AcmeButton --package @acme/widgets`');
|
|
160
|
+
expect(prose).toContain(
|
|
161
|
+
'`astryx template acme-card --type block --package @acme/widgets`',
|
|
162
|
+
);
|
|
163
|
+
expect(prose).toContain('`astryx component Button`');
|
|
164
|
+
expect(prose).not.toContain('{@link');
|
|
165
|
+
}, SLOW);
|
|
166
|
+
|
|
167
|
+
it('selects Core in a link only where the bare name would open something else', async () => {
|
|
168
|
+
const core = await discoverCoreTemplates();
|
|
169
|
+
const page = core.find(template => template.type === 'page')?.dirName;
|
|
170
|
+
const block = core.find(template => template.type === 'block')?.dirName;
|
|
171
|
+
scaffold({
|
|
172
|
+
'using-widgets.doc.mjs': topic({
|
|
173
|
+
name: 'using-widgets',
|
|
174
|
+
title: 'Using widgets',
|
|
175
|
+
sections: [
|
|
176
|
+
{
|
|
177
|
+
title: 'Overview',
|
|
178
|
+
content: [
|
|
179
|
+
{
|
|
180
|
+
type: 'prose',
|
|
181
|
+
text:
|
|
182
|
+
'Core: {@link @astryxdesign/core:component:Button}, {@link @astryxdesign/core:component:Badge}, ' +
|
|
183
|
+
`{@link @astryxdesign/core:page:${page}}, {@link @astryxdesign/core:block:${block}}.`,
|
|
184
|
+
},
|
|
185
|
+
],
|
|
186
|
+
},
|
|
187
|
+
],
|
|
188
|
+
}),
|
|
189
|
+
});
|
|
190
|
+
const pkgDir = path.join(tmpDir, 'node_modules', '@acme', 'widgets');
|
|
191
|
+
// The CLI range that turns component replacement on.
|
|
192
|
+
fs.writeFileSync(
|
|
193
|
+
path.join(pkgDir, 'package.json'),
|
|
194
|
+
JSON.stringify({
|
|
195
|
+
name: '@acme/widgets',
|
|
196
|
+
version: '1.0.0',
|
|
197
|
+
peerDependencies: {'@astryxdesign/cli': '>=0.6.7'},
|
|
198
|
+
peerDependenciesMeta: {'@astryxdesign/cli': {optional: true}},
|
|
199
|
+
}),
|
|
200
|
+
);
|
|
201
|
+
fs.writeFileSync(
|
|
202
|
+
path.join(pkgDir, 'astryx.integration.mjs'),
|
|
203
|
+
"export default {components: './components', templates: './templates', docs: './docs'};\n",
|
|
204
|
+
);
|
|
205
|
+
fs.mkdirSync(path.join(pkgDir, 'components'));
|
|
206
|
+
// AcmeButton replaces Core's Button, so bare `Button` opens AcmeButton.
|
|
207
|
+
fs.writeFileSync(
|
|
208
|
+
path.join(pkgDir, 'components', 'AcmeButton.doc.mjs'),
|
|
209
|
+
"export default {type: 'component', name: 'AcmeButton', displayName: 'Acme Button', description: 'A button.', replaces: 'Button', props: []};\n",
|
|
210
|
+
);
|
|
211
|
+
fs.writeFileSync(
|
|
212
|
+
path.join(pkgDir, 'components', 'AcmeButton.tsx'),
|
|
213
|
+
'export function AcmeButton() { return null; }\n',
|
|
214
|
+
);
|
|
215
|
+
// A page template with a Core page's id makes the bare id ambiguous.
|
|
216
|
+
fs.mkdirSync(path.join(pkgDir, 'templates'));
|
|
217
|
+
fs.writeFileSync(
|
|
218
|
+
path.join(pkgDir, 'templates', `${page}.doc.mjs`),
|
|
219
|
+
"export default {type: 'page', name: 'Acme page', displayName: 'Acme page', description: 'A page.'};\n",
|
|
220
|
+
);
|
|
221
|
+
fs.writeFileSync(
|
|
222
|
+
path.join(pkgDir, 'templates', `${page}.tsx`),
|
|
223
|
+
'export default function Fixture() { return null; }\n',
|
|
224
|
+
);
|
|
225
|
+
|
|
226
|
+
const detail = await docs('using-widgets', undefined, {cwd: tmpDir, full: true});
|
|
227
|
+
|
|
228
|
+
const prose = JSON.stringify(detail.data.sections);
|
|
229
|
+
expect(prose).toContain('`astryx component Button --package @astryxdesign/core`');
|
|
230
|
+
expect(prose).toContain('`astryx component Badge`');
|
|
231
|
+
expect(prose).toContain(
|
|
232
|
+
`\`astryx template ${page} --type page --package @astryxdesign/core\``,
|
|
233
|
+
);
|
|
234
|
+
expect(prose).toContain(`\`astryx template ${block} --type block\``);
|
|
235
|
+
}, SLOW);
|
|
236
|
+
|
|
113
237
|
it('is invisible to a project that does not configure the integration', async () => {
|
|
114
238
|
scaffold({'deploying.doc.mjs': topic()}, {config: 'export default {};\n'});
|
|
115
239
|
const listed = await docs(undefined, undefined, {cwd: tmpDir});
|
|
@@ -736,7 +736,7 @@ export async function checkAppThemes(cwd) {
|
|
|
736
736
|
label: 'App imports the theme module',
|
|
737
737
|
status: 'warn',
|
|
738
738
|
message: `Could not prove that project source imports ${state.module.path}${importEvidence.parseFailures ? `; ${importEvidence.parseFailures} source file(s) could not be parsed` : ''}.`,
|
|
739
|
-
fix: `Import {themes, defaultThemeSlug} from the generated module and {Theme} from '@astryxdesign/core', then render <Theme theme={themes[defaultThemeSlug]}>.`,
|
|
739
|
+
fix: `Import {themes, defaultThemeSlug} from the generated module and {Theme} from '@astryxdesign/core/theme', then render <Theme theme={themes[defaultThemeSlug]}>.`,
|
|
740
740
|
});
|
|
741
741
|
}
|
|
742
742
|
|
|
@@ -24,6 +24,7 @@ import {
|
|
|
24
24
|
findComponentReadme,
|
|
25
25
|
findIntegrationComponent,
|
|
26
26
|
integrationRecordHold,
|
|
27
|
+
isIntegrationMember,
|
|
27
28
|
unscopedComponentOwners,
|
|
28
29
|
} from '../../foundation/discovery/component-discovery.mjs';
|
|
29
30
|
import {legacyExternalKeeps} from '../component/_adapter.mjs';
|
|
@@ -197,7 +198,7 @@ async function selectTarget(project, component, packageName) {
|
|
|
197
198
|
discoverIntegrationComponents(integration).flatMap(r =>
|
|
198
199
|
r.name.toLowerCase() === wanted
|
|
199
200
|
? [{...r, hold: integrationRecordHold(r)}]
|
|
200
|
-
: docStem(r.docPath).toLowerCase() === wanted
|
|
201
|
+
: docStem(r.docPath).toLowerCase() === wanted && !isIntegrationMember(r)
|
|
201
202
|
? [{...r, hold: 'doc'}]
|
|
202
203
|
: [],
|
|
203
204
|
),
|
package/api/index.d.mts
CHANGED
|
@@ -16,6 +16,7 @@ export { init } from "./init/init.mjs";
|
|
|
16
16
|
export { doctor } from "./doctor/doctor.mjs";
|
|
17
17
|
export { integrationAddTheme } from "./integration/add-theme.mjs";
|
|
18
18
|
export { integrationPackCheck } from "./integration/pack-check.mjs";
|
|
19
|
+
export { integrationCheck } from "./integration/check/check.mjs";
|
|
19
20
|
export { AstryxError } from "./error.mjs";
|
|
20
21
|
export { logger } from "./logger.mjs";
|
|
21
22
|
export * from "../foundation/response/batch.type.mjs";
|
|
@@ -37,6 +38,7 @@ export * from "./integration/integration-authoring.type.mjs";
|
|
|
37
38
|
export * from "./integration/pack-check.type.mjs";
|
|
38
39
|
export * from "./integration/validate-integration.type.mjs";
|
|
39
40
|
export * from "./integration/authoring-checks.type.mjs";
|
|
41
|
+
export * from "./integration/integration-check.type.mjs";
|
|
40
42
|
export type Logger = import("./logger.mjs").Logger;
|
|
41
43
|
export { themeBuild, themeAdd, themeRemove, themeUse, themeEject, themeTemplate, themeList, themeListAvailable, themeListCopySources, themeTargets, themePaletteGenerate, generateTonalPalette, listThemes } from "./theme/theme.mjs";
|
|
42
44
|
export { integrationAdd, integrationAddAgentDoc, integrationAddCodemod, integrationAddComponent, integrationAddDoc, integrationAddTemplate } from "./integration/add-contribution.mjs";
|
package/api/index.mjs
CHANGED
|
@@ -67,6 +67,7 @@ export {
|
|
|
67
67
|
integrationComponentConflicts,
|
|
68
68
|
integrationDocConflicts,
|
|
69
69
|
} from './integration/authoring-checks.mjs';
|
|
70
|
+
export {integrationCheck} from './integration/check/check.mjs';
|
|
70
71
|
export {AstryxError} from './error.mjs';
|
|
71
72
|
// The one shared logger: the `logger` instance side-effecting commands write
|
|
72
73
|
// through, plus its generated `Logger` type. Part of the public surface so an
|
|
@@ -100,3 +101,4 @@ export * from './integration/integration-authoring.type.mjs';
|
|
|
100
101
|
export * from './integration/pack-check.type.mjs';
|
|
101
102
|
export * from './integration/validate-integration.type.mjs';
|
|
102
103
|
export * from './integration/authoring-checks.type.mjs';
|
|
104
|
+
export * from './integration/integration-check.type.mjs';
|
package/api/init/run/run.mjs
CHANGED
|
@@ -50,11 +50,11 @@ export function getNextSteps(invocation) {
|
|
|
50
50
|
` (run \`${invocation} doctor\` to verify)`,
|
|
51
51
|
" 2. Import base styles: import '@astryxdesign/core/reset.css'",
|
|
52
52
|
" and import '@astryxdesign/core/astryx.css'",
|
|
53
|
-
" 3. Import components: import { Button } from '@astryxdesign/core'",
|
|
53
|
+
" 3. Import components: import { Button } from '@astryxdesign/core/Button'",
|
|
54
54
|
' 4. Add and wire a theme:',
|
|
55
55
|
' npm install @astryxdesign/theme-neutral',
|
|
56
56
|
` ${invocation} theme add neutral`,
|
|
57
|
-
" import { Theme } from '@astryxdesign/core'",
|
|
57
|
+
" import { Theme } from '@astryxdesign/core/theme'",
|
|
58
58
|
" import { themes, defaultThemeSlug } from './astryx-themes'",
|
|
59
59
|
' <Theme theme={themes[defaultThemeSlug]}>...</Theme>',
|
|
60
60
|
` Extend an imported theme to customize it. Run \`${invocation} theme eject <slug>\` only to fork source.`,
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// @generated by scripts/sync-api-types.mjs from the JSDoc in api/**/*.mjs.
|
|
2
|
+
// DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Each component doc's props compared with the component's TypeScript props,
|
|
6
|
+
* read with the project's own compiler (spec:AST-039 FR12). Without one, the
|
|
7
|
+
* report says the comparison was skipped.
|
|
8
|
+
* @param {any} integration a loaded integration
|
|
9
|
+
* @param {string} cwd
|
|
10
|
+
* @returns {Promise<import('../../foundation/discovery/prop-drift.mjs').PropDriftReport>}
|
|
11
|
+
*/
|
|
12
|
+
export function integrationPropDrift(integration: any, cwd: string): Promise<import("../../foundation/discovery/prop-drift.mjs").PropDriftReport>;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file The integration subject's access to the environment (INV21): reading
|
|
5
|
+
* one package's component docs and sources with the project's own TypeScript.
|
|
6
|
+
*
|
|
7
|
+
* @input a loaded integration and the directory the command runs in
|
|
8
|
+
* @output the reports the integration checks attach to their results
|
|
9
|
+
* @position api/integration (internal; not exported from ./api)
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
import {
|
|
13
|
+
discoverValidIntegrationComponents,
|
|
14
|
+
forEachIntegrationDoc,
|
|
15
|
+
integrationSourceForDoc,
|
|
16
|
+
} from '../../foundation/discovery/component-discovery.mjs';
|
|
17
|
+
import {comparePropDocs} from '../../foundation/discovery/prop-drift.mjs';
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Each component doc's props compared with the component's TypeScript props,
|
|
21
|
+
* read with the project's own compiler (spec:AST-039 FR12). Without one, the
|
|
22
|
+
* report says the comparison was skipped.
|
|
23
|
+
* @param {any} integration a loaded integration
|
|
24
|
+
* @param {string} cwd
|
|
25
|
+
* @returns {Promise<import('../../foundation/discovery/prop-drift.mjs').PropDriftReport>}
|
|
26
|
+
*/
|
|
27
|
+
export async function integrationPropDrift(integration, cwd) {
|
|
28
|
+
const packageDir = /** @type {{__packageDir?: string}} */ (integration)
|
|
29
|
+
.__packageDir;
|
|
30
|
+
const {components} = await discoverValidIntegrationComponents(integration);
|
|
31
|
+
// Every doc the package ships has its prop tables compared or listed as not
|
|
32
|
+
// compared. A doc discovery leaves out (a hidden one, a second doc for one
|
|
33
|
+
// name, or one whose source or own file doesn't load) gets a record under
|
|
34
|
+
// its file name.
|
|
35
|
+
const recorded = new Set(components.map(c => c.docPath));
|
|
36
|
+
/** @type {typeof components} */
|
|
37
|
+
const left = [];
|
|
38
|
+
forEachIntegrationDoc(integration?.components, (docPath, stem) => {
|
|
39
|
+
if (recorded.has(docPath)) return;
|
|
40
|
+
recorded.add(docPath);
|
|
41
|
+
left.push({
|
|
42
|
+
name: stem,
|
|
43
|
+
package: integration.name,
|
|
44
|
+
docPath,
|
|
45
|
+
sourcePath: integrationSourceForDoc(docPath),
|
|
46
|
+
issuesUrl: integration.issuesUrl,
|
|
47
|
+
group: null,
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
return comparePropDocs([...components, ...left], {
|
|
51
|
+
packageDir: packageDir ?? cwd,
|
|
52
|
+
resolveFrom: [cwd, packageDir],
|
|
53
|
+
});
|
|
54
|
+
}
|
|
@@ -98,6 +98,72 @@ describe('integrationAddComponent name collisions', () => {
|
|
|
98
98
|
expect(snapshot()).toEqual(before);
|
|
99
99
|
});
|
|
100
100
|
|
|
101
|
+
it('adds a name a family doc lists but the module it imports does not export', async () => {
|
|
102
|
+
fs.writeFileSync(
|
|
103
|
+
path.join(tmpDir, 'package.json'),
|
|
104
|
+
`${JSON.stringify({name: '@acme/widgets', version: '1.0.0', files: ['dist'], exports: {'./tabs': './components/tabs/index.ts'}}, null, 2)}\n`,
|
|
105
|
+
);
|
|
106
|
+
const tabs = path.join(tmpDir, 'components', 'tabs');
|
|
107
|
+
fs.mkdirSync(tabs, {recursive: true});
|
|
108
|
+
fs.writeFileSync(
|
|
109
|
+
path.join(tabs, 'AcmeTabs.doc.mjs'),
|
|
110
|
+
"export default {type: 'component', name: 'AcmeTabs', import: '@acme/widgets/tabs', description: 'x', components: [{name: 'AcmeTabExtra', description: 'x'}]};\n",
|
|
111
|
+
);
|
|
112
|
+
fs.writeFileSync(
|
|
113
|
+
path.join(tabs, 'AcmeTabs.tsx'),
|
|
114
|
+
'export function AcmeTabs() { return null; }\nexport function AcmeTabExtra() { return null; }\n',
|
|
115
|
+
);
|
|
116
|
+
fs.writeFileSync(
|
|
117
|
+
path.join(tabs, 'index.ts'),
|
|
118
|
+
"export {AcmeTabs} from './AcmeTabs';\n",
|
|
119
|
+
);
|
|
120
|
+
|
|
121
|
+
const result = await integrationAdd('component', 'AcmeTabExtra', {
|
|
122
|
+
cwd: tmpDir,
|
|
123
|
+
dryRun: true,
|
|
124
|
+
});
|
|
125
|
+
expect(result.data.files).toContain('components/AcmeTabExtra.doc.mjs');
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it('refuses a member a family exports through built output', async () => {
|
|
129
|
+
fs.writeFileSync(
|
|
130
|
+
path.join(tmpDir, 'package.json'),
|
|
131
|
+
`${JSON.stringify({name: '@acme/widgets', version: '1.0.0', files: ['dist'], exports: {'./tabs': './dist/tabs/index.js'}}, null, 2)}\n`,
|
|
132
|
+
);
|
|
133
|
+
const tabs = path.join(tmpDir, 'components', 'tabs');
|
|
134
|
+
fs.mkdirSync(tabs, {recursive: true});
|
|
135
|
+
fs.writeFileSync(
|
|
136
|
+
path.join(tabs, 'AcmeTabs.doc.mjs'),
|
|
137
|
+
"export default {type: 'component', name: 'AcmeTabs', import: '@acme/widgets/tabs', description: 'x', components: [{name: 'AcmeTab', description: 'x'}]};\n",
|
|
138
|
+
);
|
|
139
|
+
fs.writeFileSync(
|
|
140
|
+
path.join(tabs, 'AcmeTabs.tsx'),
|
|
141
|
+
'export function AcmeTabs() { return null; }\n',
|
|
142
|
+
);
|
|
143
|
+
fs.writeFileSync(
|
|
144
|
+
path.join(tabs, 'AcmeTab.tsx'),
|
|
145
|
+
'export function AcmeTab() { return null; }\n',
|
|
146
|
+
);
|
|
147
|
+
const dist = path.join(tmpDir, 'dist', 'tabs');
|
|
148
|
+
fs.mkdirSync(dist, {recursive: true});
|
|
149
|
+
fs.writeFileSync(
|
|
150
|
+
path.join(dist, 'index.js'),
|
|
151
|
+
"export {AcmeTabs} from './tabs.js';\nexport {AcmeTab} from './tab.js';\n",
|
|
152
|
+
);
|
|
153
|
+
fs.writeFileSync(
|
|
154
|
+
path.join(dist, 'tabs.js'),
|
|
155
|
+
'export function AcmeTabs() { return null; }\n',
|
|
156
|
+
);
|
|
157
|
+
fs.writeFileSync(
|
|
158
|
+
path.join(dist, 'tab.js'),
|
|
159
|
+
'export function AcmeTab() { return null; }\n',
|
|
160
|
+
);
|
|
161
|
+
|
|
162
|
+
await expect(
|
|
163
|
+
integrationAdd('component', 'AcmeTab', {cwd: tmpDir, dryRun: true}),
|
|
164
|
+
).rejects.toThrow('Refusing to add component "AcmeTab"');
|
|
165
|
+
});
|
|
166
|
+
|
|
101
167
|
it('still adds a component whose name is free', async () => {
|
|
102
168
|
writeAuthoredComponent('components/AcmeWidget/AcmeWidget.doc.mjs');
|
|
103
169
|
|
|
@@ -264,9 +264,13 @@ async function addComponent(name, options) {
|
|
|
264
264
|
ERROR_CODES.ERR_FILE_EXISTS,
|
|
265
265
|
);
|
|
266
266
|
}
|
|
267
|
-
//
|
|
268
|
-
//
|
|
269
|
-
|
|
267
|
+
// A second doc under a name discovery already records, by a doc's file name
|
|
268
|
+
// anywhere under the root or by a name a doc documents, would shadow one of
|
|
269
|
+
// the two.
|
|
270
|
+
const existingDoc = findIntegrationComponentDoc(
|
|
271
|
+
{name: owner, components: root, __packageDir: packageDir},
|
|
272
|
+
name,
|
|
273
|
+
);
|
|
270
274
|
if (existingDoc != null) {
|
|
271
275
|
throw new AstryxError(
|
|
272
276
|
`Refusing to add component "${name}": ${projectPath(path.relative(packageDir, existingDoc))} already defines it.`,
|
|
@@ -691,7 +695,7 @@ async function addTemplate(name, options) {
|
|
|
691
695
|
const sourcePath = projectPath(path.relative(packageDir, sourceFile));
|
|
692
696
|
const extensionlessPath = sourcePath.replace(/\.tsx?$/u, '');
|
|
693
697
|
const blockFields = templateType === 'block' ? '\n aspectRatio: 1,' : '';
|
|
694
|
-
const specContents = `/** @type {import('@astryxdesign/cli/authoring').
|
|
698
|
+
const specContents = `/** @type {import('@astryxdesign/cli/authoring').IntegrationTemplateDoc} */\nexport default {\n type: '${templateType}',\n name: '${name}',\n displayName: '${kebabToTitle(name)}',\n description: '${kebabToTitle(name)} template.',${blockFields}\n};\n`;
|
|
695
699
|
const sourceContents = `export default function ${pascalName}() {\n return <div>${kebabToTitle(name)}</div>;\n}\n`;
|
|
696
700
|
|
|
697
701
|
/** @type {import('./add-helpers.mjs').WritePlan[]} */
|