@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
|
@@ -536,7 +536,9 @@ describe('integrationAdd template', () => {
|
|
|
536
536
|
path.join(tmpDir, 'templates/my-widget.doc.mjs'),
|
|
537
537
|
'utf-8',
|
|
538
538
|
);
|
|
539
|
-
expect(spec).toContain(
|
|
539
|
+
expect(spec).toContain(
|
|
540
|
+
"@astryxdesign/cli/authoring').IntegrationTemplateDoc",
|
|
541
|
+
);
|
|
540
542
|
expect(spec).toContain("type: 'page'");
|
|
541
543
|
expect(spec).toContain("name: 'my-widget'");
|
|
542
544
|
|
|
@@ -830,7 +832,7 @@ describe('typed descriptor conformance', () => {
|
|
|
830
832
|
for (const [relativePath, type] of [
|
|
831
833
|
['components/MyWidget.doc.mjs', 'ComponentDoc'],
|
|
832
834
|
['docs/my-guide.doc.mjs', 'ReferenceDoc'],
|
|
833
|
-
['templates/my-page.doc.mjs', '
|
|
835
|
+
['templates/my-page.doc.mjs', 'IntegrationTemplateDoc'],
|
|
834
836
|
['themes/ocean/oceanTheme.doc.mjs', 'ThemeDoc'],
|
|
835
837
|
]) {
|
|
836
838
|
const source = fs.readFileSync(path.join(tmpDir, relativePath), 'utf-8');
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* @file Integration authoring diagnostics against the built-in Core catalog.
|
|
5
5
|
*
|
|
6
|
+
* The components check also compares each component doc's props with the
|
|
7
|
+
* component's TypeScript props (foundation/discovery/prop-drift.mjs); those
|
|
8
|
+
* findings are warnings under `propDrift`.
|
|
9
|
+
*
|
|
6
10
|
* Templates may intentionally replace Core identities; undeclared same-id
|
|
7
11
|
* overlaps stay fail-closed and require package selection. The CLI package
|
|
8
12
|
* version gates replacement-specific fields so 0.6.x keeps its released shape.
|
|
@@ -25,6 +29,7 @@ import {
|
|
|
25
29
|
discoverOwnedComponents,
|
|
26
30
|
} from '../../foundation/discovery/component-discovery.mjs';
|
|
27
31
|
import {loadComponentReplacements} from '../component/_adapter.mjs';
|
|
32
|
+
import {integrationPropDrift} from './_adapter.mjs';
|
|
28
33
|
import {
|
|
29
34
|
discoverBuiltinTopics,
|
|
30
35
|
discoverIntegrationDocs,
|
|
@@ -242,6 +247,10 @@ export async function integrationComponentConflicts(pkg, options = {}) {
|
|
|
242
247
|
};
|
|
243
248
|
}
|
|
244
249
|
|
|
250
|
+
// Each documented prop against the component's TypeScript props, read with
|
|
251
|
+
// the project's own compiler; without one the report says it was skipped.
|
|
252
|
+
const propDrift = await integrationPropDrift(resolved.integration, cwd);
|
|
253
|
+
|
|
245
254
|
const coreDir = findCoreDir(cwd);
|
|
246
255
|
if (!coreDir) {
|
|
247
256
|
issues.push({
|
|
@@ -252,7 +261,7 @@ export async function integrationComponentConflicts(pkg, options = {}) {
|
|
|
252
261
|
});
|
|
253
262
|
return {
|
|
254
263
|
type: 'integration.component-conflicts',
|
|
255
|
-
data: {validated, name, version, conflicts: [], issues},
|
|
264
|
+
data: {validated, name, version, conflicts: [], issues, propDrift},
|
|
256
265
|
};
|
|
257
266
|
}
|
|
258
267
|
|
|
@@ -296,7 +305,7 @@ export async function integrationComponentConflicts(pkg, options = {}) {
|
|
|
296
305
|
|
|
297
306
|
return {
|
|
298
307
|
type: 'integration.component-conflicts',
|
|
299
|
-
data: {validated, name, version, conflicts, issues},
|
|
308
|
+
data: {validated, name, version, conflicts, issues, propDrift},
|
|
300
309
|
};
|
|
301
310
|
}
|
|
302
311
|
|
|
@@ -417,6 +417,45 @@ describe('integrationComponentConflicts', () => {
|
|
|
417
417
|
expect(result.data.conflicts).toEqual([]);
|
|
418
418
|
expect(result.data.issues).toEqual([]);
|
|
419
419
|
});
|
|
420
|
+
|
|
421
|
+
it("compares each component doc's props with the component's TypeScript props, as warnings", async () => {
|
|
422
|
+
writeComponentIntegration('AcmeBadge');
|
|
423
|
+
fs.writeFileSync(
|
|
424
|
+
path.join(tmpDir, 'components', 'AcmeBadge.doc.mjs'),
|
|
425
|
+
`export default {type: 'component', name: 'AcmeBadge', displayName: 'AcmeBadge', description: 'Fixture component.', props: [{name: 'label', type: 'string', description: 'Text.', required: true}, {name: 'size', type: "'sm' | 'md'", description: 'Size.'}]};\n`,
|
|
426
|
+
);
|
|
427
|
+
fs.writeFileSync(
|
|
428
|
+
path.join(tmpDir, 'components', 'AcmeBadge.tsx'),
|
|
429
|
+
'export function AcmeBadge(props: {label: string; count?: number}) { return null; }\n',
|
|
430
|
+
);
|
|
431
|
+
|
|
432
|
+
const result = await integrationComponentConflicts(undefined, {
|
|
433
|
+
cwd: tmpDir,
|
|
434
|
+
});
|
|
435
|
+
|
|
436
|
+
expect(result.data.issues).toEqual([]);
|
|
437
|
+
expect(result.data.propDrift).toMatchObject({
|
|
438
|
+
status: 'checked',
|
|
439
|
+
components: 1,
|
|
440
|
+
unchecked: [],
|
|
441
|
+
});
|
|
442
|
+
expect(
|
|
443
|
+
result.data.propDrift?.findings.map(f => [f.prop, f.kind, f.severity]),
|
|
444
|
+
).toEqual([
|
|
445
|
+
['count', 'not_in_doc', 'warning'],
|
|
446
|
+
['size', 'not_in_code', 'warning'],
|
|
447
|
+
]);
|
|
448
|
+
});
|
|
449
|
+
|
|
450
|
+
it('leaves propDrift out when the package has no components root', async () => {
|
|
451
|
+
writeDocIntegration({name: 'acme-setup'});
|
|
452
|
+
|
|
453
|
+
const result = await integrationComponentConflicts(undefined, {
|
|
454
|
+
cwd: tmpDir,
|
|
455
|
+
});
|
|
456
|
+
|
|
457
|
+
expect(result.data).not.toHaveProperty('propDrift');
|
|
458
|
+
});
|
|
420
459
|
});
|
|
421
460
|
|
|
422
461
|
describe('integrationDocConflicts', () => {
|
|
@@ -47,6 +47,14 @@ export type IntegrationTemplateConflictResponse = {
|
|
|
47
47
|
issues: import("../../foundation/integrations/issue").AstryxIntegrationIssue[];
|
|
48
48
|
};
|
|
49
49
|
};
|
|
50
|
+
/**
|
|
51
|
+
* Documented props compared with the component's TypeScript props. Present
|
|
52
|
+
* when the manifest loads and declares a components root. `status: 'skipped'`
|
|
53
|
+
* means nothing was compared (no TypeScript in the project) and `reason` says
|
|
54
|
+
* why. Every finding is a warning.
|
|
55
|
+
*/
|
|
56
|
+
export type PropDriftReport = import("../../foundation/discovery/prop-drift.mjs").PropDriftReport;
|
|
57
|
+
export type PropDriftFinding = import("../../foundation/discovery/prop-drift.mjs").PropDriftFinding;
|
|
50
58
|
export type IntegrationComponentConflictResponse = {
|
|
51
59
|
type: "integration.component-conflicts";
|
|
52
60
|
data: {
|
|
@@ -55,6 +63,7 @@ export type IntegrationComponentConflictResponse = {
|
|
|
55
63
|
version: string | null;
|
|
56
64
|
conflicts: IntegrationComponentConflict[];
|
|
57
65
|
issues: import("../../foundation/integrations/issue").AstryxIntegrationIssue[];
|
|
66
|
+
propDrift?: PropDriftReport;
|
|
58
67
|
};
|
|
59
68
|
};
|
|
60
69
|
export type IntegrationDocConflictResponse = {
|
|
@@ -58,10 +58,23 @@
|
|
|
58
58
|
* @property {{validated: boolean, name: string | null, version: string | null, conflicts: IntegrationTemplateConflict[], issues: import('../../foundation/integrations/issue').AstryxIntegrationIssue[]}} data
|
|
59
59
|
*/
|
|
60
60
|
|
|
61
|
+
/**
|
|
62
|
+
* Documented props compared with the component's TypeScript props. Present
|
|
63
|
+
* when the manifest loads and declares a components root. `status: 'skipped'`
|
|
64
|
+
* means nothing was compared (no TypeScript in the project) and `reason` says
|
|
65
|
+
* why. Every finding is a warning.
|
|
66
|
+
*
|
|
67
|
+
* @typedef {import('../../foundation/discovery/prop-drift.mjs').PropDriftReport} PropDriftReport
|
|
68
|
+
*/
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* @typedef {import('../../foundation/discovery/prop-drift.mjs').PropDriftFinding} PropDriftFinding
|
|
72
|
+
*/
|
|
73
|
+
|
|
61
74
|
/**
|
|
62
75
|
* @typedef {object} IntegrationComponentConflictResponse
|
|
63
76
|
* @property {'integration.component-conflicts'} type
|
|
64
|
-
* @property {{validated: boolean, name: string | null, version: string | null, conflicts: IntegrationComponentConflict[], issues: import('../../foundation/integrations/issue').AstryxIntegrationIssue[]}} data
|
|
77
|
+
* @property {{validated: boolean, name: string | null, version: string | null, conflicts: IntegrationComponentConflict[], issues: import('../../foundation/integrations/issue').AstryxIntegrationIssue[], propDrift?: PropDriftReport}} data
|
|
65
78
|
*/
|
|
66
79
|
|
|
67
80
|
/**
|
|
@@ -0,0 +1,96 @@
|
|
|
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
|
+
* The code a skipped comparison carries under `--strict`: its key in the
|
|
6
|
+
* check's result, in snake case, then `_skipped` (`propDrift` is
|
|
7
|
+
* `prop_drift_skipped`).
|
|
8
|
+
* @param {string} key
|
|
9
|
+
*/
|
|
10
|
+
export function skippedCode(key: string): string;
|
|
11
|
+
/**
|
|
12
|
+
* Whether a value is a report a check carries beside its issues: a
|
|
13
|
+
* comparison with a `status` of `checked` or `skipped` and its `findings`.
|
|
14
|
+
* @param {unknown} value
|
|
15
|
+
* @returns {value is IntegrationCheckReport}
|
|
16
|
+
*/
|
|
17
|
+
export function isCheckReport(value: unknown): value is IntegrationCheckReport;
|
|
18
|
+
/**
|
|
19
|
+
* Every warning in one check's result, and every piece of work it skipped,
|
|
20
|
+
* as issues: what `--strict` reports as errors. The counts come from the
|
|
21
|
+
* same list, so the default run and the strict run read the same data.
|
|
22
|
+
* @param {IntegrationCheckName} check
|
|
23
|
+
* @param {IntegrationCheckResponse} response
|
|
24
|
+
* @param {{noPackage?: boolean}} [context] `noPackage`: validate found no
|
|
25
|
+
* package.json, which only it reports; then no other check names a
|
|
26
|
+
* missing manifest as skipped work
|
|
27
|
+
* @returns {{warnings: Array<Omit<IntegrationCheckFailure, 'check' | 'severity'>>, skipped: Array<Omit<IntegrationCheckFailure, 'check' | 'severity'>>}}
|
|
28
|
+
*/
|
|
29
|
+
export function strictIssues(check: IntegrationCheckName, response: IntegrationCheckResponse, context?: {
|
|
30
|
+
noPackage?: boolean;
|
|
31
|
+
}): {
|
|
32
|
+
warnings: Array<Omit<IntegrationCheckFailure, "check" | "severity">>;
|
|
33
|
+
skipped: Array<Omit<IntegrationCheckFailure, "check" | "severity">>;
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* Count one check's result the way its own subcommand exits. Errors are what
|
|
37
|
+
* make it exit 1: error-severity issues, and for `docs` error findings.
|
|
38
|
+
* Warnings are warning issues, conflicts and findings, and the findings of
|
|
39
|
+
* any report the check carries. Skipped names work that did not run: no
|
|
40
|
+
* integration manifest, or a report that was skipped.
|
|
41
|
+
* @param {IntegrationCheckResponse} response
|
|
42
|
+
* @param {{noPackage?: boolean}} [context] as {@link strictIssues} takes it
|
|
43
|
+
* @returns {Omit<IntegrationCheckResult, 'check' | 'response'>}
|
|
44
|
+
*/
|
|
45
|
+
export function summarizeCheck(response: IntegrationCheckResponse, context?: {
|
|
46
|
+
noPackage?: boolean;
|
|
47
|
+
}): Omit<IntegrationCheckResult, "check" | "response">;
|
|
48
|
+
/**
|
|
49
|
+
* Run every `doctor integration` check against the integration package in
|
|
50
|
+
* `cwd`, as its own build does, and return the `integration.check` envelope.
|
|
51
|
+
*
|
|
52
|
+
* @param {IntegrationCheckOptions} [options]
|
|
53
|
+
* @returns {Promise<IntegrationCheckCommandResponse>}
|
|
54
|
+
*/
|
|
55
|
+
export function integrationCheck(options?: IntegrationCheckOptions): Promise<IntegrationCheckCommandResponse>;
|
|
56
|
+
/**
|
|
57
|
+
* Count the four checks' results into one summary. Each check's own row
|
|
58
|
+
* counts as its subcommand exits; the totals and `failures` count validate's
|
|
59
|
+
* issues once, though the other checks repeat them, and every other finding
|
|
60
|
+
* on its own, so two findings with one message stay two.
|
|
61
|
+
* @param {IntegrationCheckResponse[]} responses validate first
|
|
62
|
+
* @param {boolean} strict
|
|
63
|
+
*/
|
|
64
|
+
export function combineChecks(responses: IntegrationCheckResponse[], strict: boolean): {
|
|
65
|
+
checks: import("../integration-check.type.mjs").IntegrationCheckResult[];
|
|
66
|
+
errors: number;
|
|
67
|
+
warnings: number;
|
|
68
|
+
skipped: string[];
|
|
69
|
+
unchecked: number;
|
|
70
|
+
failures: import("../integration-check.type.mjs").IntegrationCheckFailure[];
|
|
71
|
+
failed: boolean;
|
|
72
|
+
};
|
|
73
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckName} IntegrationCheckName */
|
|
74
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckReport} IntegrationCheckReport */
|
|
75
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckResponse} IntegrationCheckResponse */
|
|
76
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckResult} IntegrationCheckResult */
|
|
77
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckOptions} IntegrationCheckOptions */
|
|
78
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckCommandResponse} IntegrationCheckCommandResponse */
|
|
79
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckFailure} IntegrationCheckFailure */
|
|
80
|
+
/** The checks `integration check` runs, in the order it runs them. */
|
|
81
|
+
export const INTEGRATION_CHECKS: readonly ["validate", "components", "templates", "docs"];
|
|
82
|
+
/** The skipped-work line for a package with no integration manifest. */
|
|
83
|
+
export const NO_MANIFEST_SKIP: "No astryx.integration.* found next to package.json, so nothing was checked.";
|
|
84
|
+
export namespace CONFLICT_CODES {
|
|
85
|
+
let components: "component_name_conflict";
|
|
86
|
+
let templates: "template_id_conflict";
|
|
87
|
+
}
|
|
88
|
+
/** The code a check with no integration manifest carries under `--strict`. */
|
|
89
|
+
export const NO_MANIFEST_CODE: "missing_manifest";
|
|
90
|
+
export type IntegrationCheckName = import("../integration-check.type.mjs").IntegrationCheckName;
|
|
91
|
+
export type IntegrationCheckReport = import("../integration-check.type.mjs").IntegrationCheckReport;
|
|
92
|
+
export type IntegrationCheckResponse = import("../integration-check.type.mjs").IntegrationCheckResponse;
|
|
93
|
+
export type IntegrationCheckResult = import("../integration-check.type.mjs").IntegrationCheckResult;
|
|
94
|
+
export type IntegrationCheckOptions = import("../integration-check.type.mjs").IntegrationCheckOptions;
|
|
95
|
+
export type IntegrationCheckCommandResponse = import("../integration-check.type.mjs").IntegrationCheckCommandResponse;
|
|
96
|
+
export type IntegrationCheckFailure = import("../integration-check.type.mjs").IntegrationCheckFailure;
|
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file `astryx integration check`: every `doctor integration` check in one
|
|
5
|
+
* call, for a package's own build.
|
|
6
|
+
*
|
|
7
|
+
* Runs `validate`, `components`, `templates` and `docs` against the
|
|
8
|
+
* integration package in `cwd` and counts each result the way that check's
|
|
9
|
+
* own subcommand exits, so the
|
|
10
|
+
* run fails exactly when one of them would. With `strict` it also fails on
|
|
11
|
+
* any warning and on any check, or comparison a check carries, that did not
|
|
12
|
+
* run, so a package can gate its build on its docs staying in sync. `--strict`
|
|
13
|
+
* adds no check: it reports the same warnings and skipped work again, as
|
|
14
|
+
* errors in the checks' own issue format, and fails on them.
|
|
15
|
+
*
|
|
16
|
+
* What fails it is a contract for the builds that run it: a new check, or a
|
|
17
|
+
* new failure code, joins only in a minor release that names it.
|
|
18
|
+
* `test/integration-check-failures.test.mjs` lists each one, so adding one
|
|
19
|
+
* shows up in review.
|
|
20
|
+
*
|
|
21
|
+
* @input A local or installed integration package.
|
|
22
|
+
* @output Each check's own envelope with its errors, warnings and skipped
|
|
23
|
+
* work, the totals, and whether the run fails.
|
|
24
|
+
* @position Backs `astryx integration check`.
|
|
25
|
+
*/
|
|
26
|
+
|
|
27
|
+
import {
|
|
28
|
+
integrationComponentConflicts,
|
|
29
|
+
integrationDocConflicts,
|
|
30
|
+
integrationTemplateConflicts,
|
|
31
|
+
} from '../authoring-checks.mjs';
|
|
32
|
+
import {
|
|
33
|
+
summarizeIssues,
|
|
34
|
+
validateIntegration,
|
|
35
|
+
} from '../validate-integration.mjs';
|
|
36
|
+
|
|
37
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckName} IntegrationCheckName */
|
|
38
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckReport} IntegrationCheckReport */
|
|
39
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckResponse} IntegrationCheckResponse */
|
|
40
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckResult} IntegrationCheckResult */
|
|
41
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckOptions} IntegrationCheckOptions */
|
|
42
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckCommandResponse} IntegrationCheckCommandResponse */
|
|
43
|
+
/** @typedef {import('../integration-check.type.mjs').IntegrationCheckFailure} IntegrationCheckFailure */
|
|
44
|
+
|
|
45
|
+
/** The checks `integration check` runs, in the order it runs them. */
|
|
46
|
+
export const INTEGRATION_CHECKS = /** @type {const} */ ([
|
|
47
|
+
'validate',
|
|
48
|
+
'components',
|
|
49
|
+
'templates',
|
|
50
|
+
'docs',
|
|
51
|
+
]);
|
|
52
|
+
|
|
53
|
+
/** The skipped-work line for a package with no integration manifest. */
|
|
54
|
+
export const NO_MANIFEST_SKIP =
|
|
55
|
+
'No astryx.integration.* found next to package.json, so nothing was checked.';
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* The code a conflict carries when `--strict` reports it: conflicts have no
|
|
59
|
+
* code of their own.
|
|
60
|
+
*/
|
|
61
|
+
export const CONFLICT_CODES = /** @type {const} */ ({
|
|
62
|
+
components: 'component_name_conflict',
|
|
63
|
+
templates: 'template_id_conflict',
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
/** The code a check with no integration manifest carries under `--strict`. */
|
|
67
|
+
export const NO_MANIFEST_CODE = 'missing_manifest';
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* The code a skipped comparison carries under `--strict`: its key in the
|
|
71
|
+
* check's result, in snake case, then `_skipped` (`propDrift` is
|
|
72
|
+
* `prop_drift_skipped`).
|
|
73
|
+
* @param {string} key
|
|
74
|
+
*/
|
|
75
|
+
export function skippedCode(key) {
|
|
76
|
+
return `${key.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase()}_skipped`;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/** Each check's envelope type, by check. */
|
|
80
|
+
const CHECK_OF_TYPE = /** @type {const} */ ({
|
|
81
|
+
'integration.validate': 'validate',
|
|
82
|
+
'integration.component-conflicts': 'components',
|
|
83
|
+
'integration.template-conflicts': 'templates',
|
|
84
|
+
'integration.doc-conflicts': 'docs',
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Whether a value is a report a check carries beside its issues: a
|
|
89
|
+
* comparison with a `status` of `checked` or `skipped` and its `findings`.
|
|
90
|
+
* @param {unknown} value
|
|
91
|
+
* @returns {value is IntegrationCheckReport}
|
|
92
|
+
*/
|
|
93
|
+
export function isCheckReport(value) {
|
|
94
|
+
if (value == null || typeof value !== 'object' || Array.isArray(value)) {
|
|
95
|
+
return false;
|
|
96
|
+
}
|
|
97
|
+
const report = /** @type {{status?: unknown, findings?: unknown}} */ (value);
|
|
98
|
+
return (
|
|
99
|
+
(report.status === 'checked' || report.status === 'skipped') &&
|
|
100
|
+
Array.isArray(report.findings)
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* One finding as an issue: its own code, message, fix, file, and line where
|
|
106
|
+
* it has them.
|
|
107
|
+
* @param {any} finding
|
|
108
|
+
* @param {string} code
|
|
109
|
+
* @returns {Omit<IntegrationCheckFailure, 'check' | 'severity'>}
|
|
110
|
+
*/
|
|
111
|
+
function asIssue(finding, code) {
|
|
112
|
+
const file = finding.file ?? finding.doc ?? finding.source;
|
|
113
|
+
return {
|
|
114
|
+
code,
|
|
115
|
+
message: String(finding.message ?? ''),
|
|
116
|
+
...(typeof finding.component === 'string'
|
|
117
|
+
? {component: finding.component}
|
|
118
|
+
: {}),
|
|
119
|
+
...(typeof finding.prop === 'string' ? {prop: finding.prop} : {}),
|
|
120
|
+
...(typeof finding.fix === 'string' ? {fix: finding.fix} : {}),
|
|
121
|
+
...(typeof file === 'string' ? {file} : {}),
|
|
122
|
+
...(typeof finding.line === 'number' ? {line: finding.line} : {}),
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Every warning in one check's result, and every piece of work it skipped,
|
|
128
|
+
* as issues: what `--strict` reports as errors. The counts come from the
|
|
129
|
+
* same list, so the default run and the strict run read the same data.
|
|
130
|
+
* @param {IntegrationCheckName} check
|
|
131
|
+
* @param {IntegrationCheckResponse} response
|
|
132
|
+
* @param {{noPackage?: boolean}} [context] `noPackage`: validate found no
|
|
133
|
+
* package.json, which only it reports; then no other check names a
|
|
134
|
+
* missing manifest as skipped work
|
|
135
|
+
* @returns {{warnings: Array<Omit<IntegrationCheckFailure, 'check' | 'severity'>>, skipped: Array<Omit<IntegrationCheckFailure, 'check' | 'severity'>>}}
|
|
136
|
+
*/
|
|
137
|
+
export function strictIssues(check, response, context = {}) {
|
|
138
|
+
const data =
|
|
139
|
+
/** @type {Record<string, unknown> & IntegrationCheckResponse['data']} */ (
|
|
140
|
+
response.data
|
|
141
|
+
);
|
|
142
|
+
const warnings = [];
|
|
143
|
+
for (const issue of data.issues) {
|
|
144
|
+
if (issue.severity === 'warning') {
|
|
145
|
+
warnings.push(asIssue(issue, issue.code));
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
const conflictCode = /** @type {Record<string, string>} */ (CONFLICT_CODES)[
|
|
149
|
+
check
|
|
150
|
+
];
|
|
151
|
+
for (const conflict of /** @type {any[]} */ (
|
|
152
|
+
Array.isArray(data.conflicts) ? data.conflicts : []
|
|
153
|
+
)) {
|
|
154
|
+
if (conflict.severity === 'warning' && conflictCode) {
|
|
155
|
+
warnings.push(asIssue(conflict, conflictCode));
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
for (const finding of /** @type {any[]} */ (
|
|
159
|
+
Array.isArray(data.findings) ? data.findings : []
|
|
160
|
+
)) {
|
|
161
|
+
if (finding.severity === 'warning') {
|
|
162
|
+
warnings.push(asIssue(finding, finding.code ?? finding.relationship));
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
const skipped = [];
|
|
166
|
+
const noPackage =
|
|
167
|
+
context.noPackage === true ||
|
|
168
|
+
data.issues.some(issue => issue.code === 'no_package');
|
|
169
|
+
if (!data.validated && !noPackage) {
|
|
170
|
+
skipped.push({code: NO_MANIFEST_CODE, message: NO_MANIFEST_SKIP});
|
|
171
|
+
}
|
|
172
|
+
for (const [key, value] of Object.entries(data)) {
|
|
173
|
+
if (!isCheckReport(value)) continue;
|
|
174
|
+
if (value.status === 'skipped') {
|
|
175
|
+
skipped.push({
|
|
176
|
+
code: skippedCode(key),
|
|
177
|
+
message: value.reason ?? `${key} did not run`,
|
|
178
|
+
});
|
|
179
|
+
continue;
|
|
180
|
+
}
|
|
181
|
+
for (const finding of /** @type {any[]} */ (value.findings)) {
|
|
182
|
+
if ((finding.severity ?? 'warning') !== 'warning') continue;
|
|
183
|
+
warnings.push(
|
|
184
|
+
asIssue(finding, finding.code ?? finding.problem ?? finding.kind),
|
|
185
|
+
);
|
|
186
|
+
}
|
|
187
|
+
// A comparison that ran but judged no prop type (a TypeScript older than
|
|
188
|
+
// the type comparison reads) skipped that work.
|
|
189
|
+
const typesSkipped = /** @type {{typesSkipped?: unknown}} */ (value)
|
|
190
|
+
.typesSkipped;
|
|
191
|
+
if (typeof typesSkipped === 'string') {
|
|
192
|
+
skipped.push({
|
|
193
|
+
code: 'prop_types_skipped',
|
|
194
|
+
message: `prop types not judged: ${typesSkipped}`,
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
return {warnings, skipped};
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Count one check's result the way its own subcommand exits. Errors are what
|
|
203
|
+
* make it exit 1: error-severity issues, and for `docs` error findings.
|
|
204
|
+
* Warnings are warning issues, conflicts and findings, and the findings of
|
|
205
|
+
* any report the check carries. Skipped names work that did not run: no
|
|
206
|
+
* integration manifest, or a report that was skipped.
|
|
207
|
+
* @param {IntegrationCheckResponse} response
|
|
208
|
+
* @param {{noPackage?: boolean}} [context] as {@link strictIssues} takes it
|
|
209
|
+
* @returns {Omit<IntegrationCheckResult, 'check' | 'response'>}
|
|
210
|
+
*/
|
|
211
|
+
export function summarizeCheck(response, context = {}) {
|
|
212
|
+
const check = /** @type {IntegrationCheckName} */ (
|
|
213
|
+
CHECK_OF_TYPE[response.type]
|
|
214
|
+
);
|
|
215
|
+
let errors = summarizeIssues(response.data.issues).errors;
|
|
216
|
+
// The docs check is the one whose findings fail it.
|
|
217
|
+
if (response.type === 'integration.doc-conflicts') {
|
|
218
|
+
errors += response.data.findings.filter(
|
|
219
|
+
finding => finding.severity === 'error',
|
|
220
|
+
).length;
|
|
221
|
+
}
|
|
222
|
+
const {warnings, skipped} = strictIssues(check, response, context);
|
|
223
|
+
return {
|
|
224
|
+
errors,
|
|
225
|
+
warnings: warnings.length,
|
|
226
|
+
skipped: skipped.map(each => each.message),
|
|
227
|
+
failed: errors > 0,
|
|
228
|
+
};
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
* Run every `doctor integration` check against the integration package in
|
|
233
|
+
* `cwd`, as its own build does, and return the `integration.check` envelope.
|
|
234
|
+
*
|
|
235
|
+
* @param {IntegrationCheckOptions} [options]
|
|
236
|
+
* @returns {Promise<IntegrationCheckCommandResponse>}
|
|
237
|
+
*/
|
|
238
|
+
export async function integrationCheck(options = {}) {
|
|
239
|
+
const {cwd = process.cwd(), strict = false} = options;
|
|
240
|
+
// One after another: each loads the package through the same discovery.
|
|
241
|
+
/** @type {IntegrationCheckResponse[]} */
|
|
242
|
+
const responses = [];
|
|
243
|
+
responses.push(await validateIntegration(undefined, {cwd}));
|
|
244
|
+
responses.push(await integrationComponentConflicts(undefined, {cwd}));
|
|
245
|
+
responses.push(await integrationTemplateConflicts(undefined, {cwd}));
|
|
246
|
+
responses.push(await integrationDocConflicts(undefined, {cwd}));
|
|
247
|
+
|
|
248
|
+
const [validation] = responses;
|
|
249
|
+
return {
|
|
250
|
+
type: 'integration.check',
|
|
251
|
+
data: {
|
|
252
|
+
validated: validation.data.validated,
|
|
253
|
+
name: validation.data.name,
|
|
254
|
+
version: validation.data.version,
|
|
255
|
+
strict,
|
|
256
|
+
...combineChecks(responses, strict),
|
|
257
|
+
},
|
|
258
|
+
};
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* Count the four checks' results into one summary. Each check's own row
|
|
263
|
+
* counts as its subcommand exits; the totals and `failures` count validate's
|
|
264
|
+
* issues once, though the other checks repeat them, and every other finding
|
|
265
|
+
* on its own, so two findings with one message stay two.
|
|
266
|
+
* @param {IntegrationCheckResponse[]} responses validate first
|
|
267
|
+
* @param {boolean} strict
|
|
268
|
+
*/
|
|
269
|
+
export function combineChecks(responses, strict) {
|
|
270
|
+
const [validation] = responses;
|
|
271
|
+
// Only validate reports a missing package.json; the other checks read it
|
|
272
|
+
// from there instead of each naming a missing manifest.
|
|
273
|
+
const noPackage = validation.data.issues.some(
|
|
274
|
+
issue => issue.code === 'no_package',
|
|
275
|
+
);
|
|
276
|
+
/** @type {IntegrationCheckResult[]} */
|
|
277
|
+
const checks = responses.map(response => ({
|
|
278
|
+
check: /** @type {IntegrationCheckName} */ (CHECK_OF_TYPE[response.type]),
|
|
279
|
+
...summarizeCheck(response, {noPackage}),
|
|
280
|
+
response,
|
|
281
|
+
}));
|
|
282
|
+
// Later checks repeat validate's issues and its missing manifest: each
|
|
283
|
+
// match is consumed once per check, as from a multiset. Every other issue
|
|
284
|
+
// counts, even a repeat within one check.
|
|
285
|
+
const keyOf = (/** @type {string} */ kind, /** @type {object} */ issue) =>
|
|
286
|
+
`${kind}\0${JSON.stringify(issue)}`;
|
|
287
|
+
const validateFound = strictIssues('validate', validation, {noPackage});
|
|
288
|
+
/** @type {Map<string, number>} */
|
|
289
|
+
const fromValidate = new Map();
|
|
290
|
+
for (const key of [
|
|
291
|
+
...validation.data.issues
|
|
292
|
+
.filter(issue => issue.severity === 'error')
|
|
293
|
+
.map(issue => keyOf('error', asIssue(issue, issue.code))),
|
|
294
|
+
...validateFound.warnings.map(issue => keyOf('warning', issue)),
|
|
295
|
+
...validateFound.skipped.map(issue => keyOf('skipped', issue)),
|
|
296
|
+
]) {
|
|
297
|
+
fromValidate.set(key, (fromValidate.get(key) ?? 0) + 1);
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
let errors = 0;
|
|
301
|
+
let warnings = 0;
|
|
302
|
+
let unchecked = 0;
|
|
303
|
+
/** @type {string[]} */
|
|
304
|
+
const skipped = [];
|
|
305
|
+
// `--strict` adds no check: it reports the same warnings and skipped work
|
|
306
|
+
// as errors, and they fail the run.
|
|
307
|
+
/** @type {IntegrationCheckFailure[]} */
|
|
308
|
+
const failures = [];
|
|
309
|
+
checks.forEach(({check, response}, index) => {
|
|
310
|
+
/** @type {Map<string, number>} */
|
|
311
|
+
const repeats = index === 0 ? new Map() : new Map(fromValidate);
|
|
312
|
+
const isRepeat = (/** @type {string} */ key) => {
|
|
313
|
+
const left = repeats.get(key) ?? 0;
|
|
314
|
+
if (left === 0) return false;
|
|
315
|
+
repeats.set(key, left - 1);
|
|
316
|
+
return true;
|
|
317
|
+
};
|
|
318
|
+
for (const issue of response.data.issues) {
|
|
319
|
+
if (
|
|
320
|
+
issue.severity === 'error' &&
|
|
321
|
+
!isRepeat(keyOf('error', asIssue(issue, issue.code)))
|
|
322
|
+
) {
|
|
323
|
+
errors++;
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
if (response.type === 'integration.doc-conflicts') {
|
|
327
|
+
errors += response.data.findings.filter(
|
|
328
|
+
finding => finding.severity === 'error',
|
|
329
|
+
).length;
|
|
330
|
+
}
|
|
331
|
+
for (const value of Object.values(response.data)) {
|
|
332
|
+
const list = /** @type {{unchecked?: unknown}} */ (value)?.unchecked;
|
|
333
|
+
if (isCheckReport(value) && Array.isArray(list)) unchecked += list.length;
|
|
334
|
+
}
|
|
335
|
+
const found =
|
|
336
|
+
index === 0 ? validateFound : strictIssues(check, response, {noPackage});
|
|
337
|
+
for (const issue of found.warnings) {
|
|
338
|
+
if (isRepeat(keyOf('warning', issue))) continue;
|
|
339
|
+
warnings++;
|
|
340
|
+
if (strict) failures.push({check, severity: 'error', ...issue});
|
|
341
|
+
}
|
|
342
|
+
for (const issue of found.skipped) {
|
|
343
|
+
if (isRepeat(keyOf('skipped', issue))) continue;
|
|
344
|
+
skipped.push(`${check}: ${issue.message}`);
|
|
345
|
+
if (strict) failures.push({check, severity: 'error', ...issue});
|
|
346
|
+
}
|
|
347
|
+
});
|
|
348
|
+
return {
|
|
349
|
+
checks,
|
|
350
|
+
errors,
|
|
351
|
+
warnings,
|
|
352
|
+
skipped,
|
|
353
|
+
unchecked,
|
|
354
|
+
failures,
|
|
355
|
+
failed: checks.some(check => check.failed) || failures.length > 0,
|
|
356
|
+
};
|
|
357
|
+
}
|