@astryxdesign/cli 0.6.3-canary.db4e378 → 0.6.3-canary.db52d98
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 +38 -15
- package/api/blog/blog.doc.mjs +1 -0
- package/api/build/_adapter.d.mts +50 -0
- package/api/build/_adapter.mjs +60 -0
- package/api/build/build.doc.mjs +14 -7
- package/api/build/build.test.mjs +184 -6
- package/api/build/build.type.d.mts +57 -2
- package/api/build/build.type.mjs +30 -7
- package/api/build/help/help.d.mts +4 -0
- package/api/build/help/help.mjs +24 -11
- package/api/build/kit/kit.d.mts +4 -1
- package/api/build/kit/kit.mjs +165 -49
- package/api/build/kit/rank.d.mts +44 -0
- package/api/build/kit/rank.mjs +432 -0
- package/api/build/kit/rank.test.mjs +196 -0
- package/api/component/_adapter.d.mts +6 -12
- package/api/component/_adapter.mjs +20 -10
- package/api/component/component.doc.mjs +1 -0
- package/api/component/component.mjs +60 -12
- package/api/component/list/list.mjs +3 -2
- package/api/discover/discover.doc.mjs +1 -0
- package/api/docs/_adapter.d.mts +252 -34
- package/api/docs/_adapter.mjs +923 -132
- package/api/docs/detail/detail.mjs +11 -3
- package/api/docs/detail/section/section.mjs +24 -13
- package/api/docs/detail/section/section.test.mjs +15 -6
- package/api/docs/docs.d.mts +5 -3
- package/api/docs/docs.doc.mjs +39 -17
- package/api/docs/docs.mjs +44 -8
- package/api/docs/docs.test.mjs +158 -4
- package/api/docs/docs.type.d.mts +181 -2
- package/api/docs/docs.type.mjs +117 -3
- package/api/docs/index/index.mjs +11 -3
- package/api/docs/index/index.test.mjs +1 -1
- package/api/docs/integration-tree.test.mjs +555 -0
- package/api/docs/integrationDocs.test.mjs +14 -14
- package/api/docs/list/list.mjs +28 -12
- package/api/docs/node/node.d.mts +43 -0
- package/api/docs/node/node.mjs +192 -0
- package/api/docs/reference-blocks.test.mjs +406 -0
- package/api/doctor/doctor.d.mts +54 -4
- package/api/doctor/doctor.doc.mjs +1 -0
- package/api/doctor/doctor.mjs +331 -16
- package/api/doctor/doctor.test.mjs +420 -7
- package/api/gap-report/gap-report.doc.mjs +1 -0
- package/api/hook/_adapter.mjs +19 -5
- package/api/hook/hook.doc.mjs +1 -0
- package/api/hook/list/list.d.mts +1 -1
- package/api/hook/list/list.mjs +69 -17
- package/api/index.d.mts +1 -1
- package/api/index.mjs +1 -0
- package/api/init/init.doc.mjs +2 -1
- package/api/integration/add-contribution.d.mts +2 -1
- package/api/integration/add-contribution.mjs +114 -12
- package/api/integration/add-contribution.test.mjs +174 -3
- package/api/integration/add-theme.mjs +34 -64
- package/api/integration/add-theme.test.mjs +105 -21
- package/api/integration/authoring-checks.mjs +138 -28
- package/api/integration/authoring-checks.test.mjs +179 -7
- package/api/integration/authoring-checks.type.mjs +6 -1
- package/api/integration/integration-authoring.type.d.mts +2 -0
- package/api/integration/integration-authoring.type.mjs +2 -0
- package/api/integration/integration-block-exports.test.mjs +10 -6
- package/api/integration/integrationAdd.doc.mjs +7 -0
- package/api/integration/integrationAddAgentDoc.doc.mjs +1 -0
- package/api/integration/integrationAddCodemod.doc.mjs +1 -0
- package/api/integration/integrationAddComponent.doc.mjs +1 -0
- package/api/integration/integrationAddDoc.doc.mjs +8 -1
- package/api/integration/integrationAddTemplate.doc.mjs +1 -0
- package/api/integration/integrationAddTheme.doc.mjs +6 -5
- package/api/integration/integrationComponentConflicts.doc.mjs +1 -0
- package/api/integration/integrationDocConflicts.doc.mjs +2 -1
- package/api/integration/integrationPackCheck.doc.mjs +2 -1
- package/api/integration/integrationTemplateConflicts.doc.d.mts +3 -0
- package/api/integration/integrationTemplateConflicts.doc.mjs +4 -0
- package/api/integration/pack-check.mjs +34 -0
- package/api/integration/pack-check.test.mjs +138 -47
- package/api/integration/pack-check.type.d.mts +26 -2
- package/api/integration/pack-check.type.mjs +14 -1
- package/api/integration/summarizeIssues.doc.mjs +1 -0
- package/api/integration/template-conflict-compatibility.test.mjs +73 -0
- package/api/integration/validate-integration-fixes.test.mjs +1389 -0
- package/api/integration/validate-integration.mjs +50 -102
- package/api/integration/validate-integration.test.mjs +88 -26
- package/api/integration/validate-unread-theme-folders.test.mjs +110 -0
- package/api/integration/validateIntegration.doc.mjs +2 -1
- package/api/json/assertResponse.doc.mjs +1 -0
- package/api/json/index.ts +2 -0
- package/api/json/isError.doc.mjs +1 -0
- package/api/json/parseResponse.doc.mjs +1 -0
- package/api/layout/_adapter.mjs +20 -5
- package/api/layout/layoutCheck.doc.mjs +1 -0
- package/api/layout/layoutExpand.doc.mjs +1 -0
- package/api/layout/layoutGrammar.doc.mjs +1 -0
- package/api/search/search.d.mts +59 -1
- package/api/search/search.doc.mjs +5 -3
- package/api/search/search.mjs +458 -77
- package/api/search/search.test.mjs +91 -2
- package/api/search/search.type.d.mts +13 -1
- package/api/search/search.type.mjs +4 -1
- package/api/swizzle/swizzle.doc.mjs +1 -0
- package/api/template/list/list.mjs +1 -0
- package/api/template/table-floating-bulk-actions.test.mjs +66 -0
- package/api/template/template-integration.test.mjs +1072 -3
- package/api/template/template-suffix.test.mjs +41 -21
- package/api/template/template.doc.mjs +28 -7
- package/api/template/template.mjs +45 -8
- package/api/template/template.type.d.mts +6 -8
- package/api/template/template.type.mjs +3 -2
- package/api/theme/_adapter.d.mts +2 -3
- package/api/theme/_adapter.mjs +4 -5
- package/api/theme/add/add.binary.test.mjs +10 -17
- package/api/theme/add/add.test.mjs +14 -1
- package/api/theme/generateTonalPalette.doc.mjs +1 -0
- package/api/theme/integration-themes.test.mjs +39 -28
- package/api/theme/list/list.test.mjs +19 -20
- package/api/theme/listThemes.doc.mjs +6 -5
- package/api/theme/template/template.test.mjs +5 -0
- package/api/theme/themeAdd.doc.mjs +4 -3
- package/api/theme/themeBuild.doc.mjs +1 -0
- package/api/theme/themeList.doc.mjs +6 -3
- package/api/theme/themeListAvailable.doc.mjs +5 -3
- package/api/theme/themePaletteGenerate.doc.mjs +1 -0
- package/api/theme/themeTargets.doc.mjs +1 -0
- package/api/theme/themeTemplate.doc.mjs +2 -1
- package/api/upgrade/_adapter.d.mts +32 -5
- package/api/upgrade/_adapter.mjs +97 -69
- package/api/upgrade/provider-agreement.test.mjs +152 -0
- package/api/upgrade/run/run.mjs +356 -59
- package/api/upgrade/upgrade.doc.mjs +6 -1
- package/api/upgrade/upgrade.type.d.mts +34 -0
- package/api/upgrade/upgrade.type.mjs +15 -0
- package/assets/codemods/__tests__/runner.test.mjs +330 -8
- package/assets/codemods/integration-discovery.mjs +8 -2
- package/assets/codemods/integration-discovery.test.mjs +15 -0
- package/assets/codemods/integration-runner.mjs +56 -4
- package/assets/codemods/integration-runner.protection.test.mjs +153 -0
- package/assets/codemods/run-codemod.mjs +177 -34
- package/assets/codemods/runner.mjs +350 -102
- package/assets/codemods/transforms/next/__tests__/migrate-native-picker-to-presentation.test.mjs +63 -0
- package/assets/codemods/transforms/next/__tests__/migrate-theme-catalog-to-descriptors.test.mjs +220 -0
- package/assets/codemods/transforms/next/index.mjs +19 -1
- package/assets/codemods/transforms/next/migrate-native-picker-to-presentation.mjs +148 -0
- package/assets/codemods/transforms/next/migrate-theme-catalog-to-descriptors.mjs +141 -0
- package/assets/docs/getting-started.doc.mjs +2 -2
- package/assets/docs/layout.doc.dense.mjs +2 -2
- package/assets/docs/layout.doc.mjs +1 -1
- package/assets/docs/principles.doc.mjs +6 -6
- package/assets/docs/styling-libraries.doc.mjs +3 -3
- package/assets/docs/styling.doc.mjs +4 -4
- package/assets/docs/theme.doc.mjs +5 -5
- package/assets/docs/tokens.doc.mjs +1 -1
- package/assets/docs/tree/api.doc.mjs +30 -0
- package/assets/docs/tree/cli.doc.mjs +23 -0
- package/assets/docs/tree/commands.doc.mjs +25 -0
- package/assets/docs/{cli-integrations.doc.mjs → tree/integrations.doc.mjs} +66 -38
- package/assets/docs/tree/integrations.test.mjs +62 -0
- package/assets/docs/tree/writing-docs.doc.mjs +286 -0
- package/assets/docs/working-with-ai.doc.mjs +3 -3
- package/assets/templates/blocks/components/CheckboxList/CheckboxListSelectAllPattern.doc.mjs +1 -1
- package/assets/templates/blocks/components/CheckboxList/CheckboxListSelectAllPattern.tsx +1 -3
- package/assets/templates/blocks/components/DateInput/DateInputDateRange.tsx +1 -1
- package/assets/templates/blocks/components/Item/ItemDocumentTabs.doc.mjs +14 -0
- package/assets/templates/blocks/components/Item/ItemDocumentTabs.tsx +100 -0
- package/assets/templates/blocks/components/Table/TableBulkActionsTable.doc.mjs +14 -0
- package/assets/templates/blocks/components/Table/TableBulkActionsTable.tsx +71 -0
- package/assets/templates/blocks/components/Table/TableFloatingBulkActionsTable.doc.mjs +19 -0
- package/assets/templates/blocks/components/Table/TableFloatingBulkActionsTable.tsx +139 -0
- package/assets/templates/blocks/components/TimeInput/TimeInputConstrained.tsx +1 -0
- package/assets/templates/themes/butter/butterTheme.doc.mjs +11 -0
- package/assets/templates/themes/chocolate/chocolateTheme.doc.mjs +11 -0
- package/assets/templates/themes/gothic/gothicTheme.doc.mjs +11 -0
- package/assets/templates/themes/matcha/matchaTheme.doc.mjs +11 -0
- package/assets/templates/themes/neutral/neutralTheme.doc.mjs +11 -0
- package/assets/templates/themes/stone/stoneTheme.doc.mjs +11 -0
- package/assets/templates/themes/y2k/y2kTheme.doc.mjs +11 -0
- package/authoring/codemod/codemod.doc.mjs +1 -1
- package/authoring/codemod/type.ts +12 -0
- package/authoring/config/config.doc.mjs +1 -1
- package/authoring/debug/debug.doc.d.mts +11 -0
- package/authoring/debug/debug.doc.mjs +182 -0
- package/authoring/debug/parse.d.mts +3 -3
- package/authoring/doctypes/_schema.d.mts +119 -117
- package/authoring/doctypes/_schema.mjs +54 -3
- package/authoring/doctypes/base/graph-fields.doc.mjs +8 -6
- package/authoring/doctypes/base/type.ts +6 -5
- package/authoring/doctypes/command/command.doc.mjs +1 -1
- package/authoring/doctypes/command/type.ts +2 -2
- package/authoring/doctypes/component/type.ts +2 -2
- package/authoring/doctypes/doctypes-new.test.mjs +48 -6
- package/authoring/doctypes/enum/enum.doc.mjs +1 -1
- package/authoring/doctypes/enum/type.ts +1 -1
- package/authoring/doctypes/function/function.doc.mjs +3 -2
- package/authoring/doctypes/function/type.ts +3 -2
- package/authoring/doctypes/hook/type.ts +2 -2
- package/authoring/doctypes/load-contract.test.mjs +28 -2
- package/authoring/doctypes/namespace/namespace.doc.mjs +6 -10
- package/authoring/doctypes/namespace/parse.test.mjs +23 -25
- package/authoring/doctypes/namespace/type.ts +5 -2
- package/authoring/doctypes/parse.d.mts +4 -2
- package/authoring/doctypes/parse.mjs +10 -5
- package/authoring/doctypes/reference/reference.doc.mjs +35 -6
- package/authoring/doctypes/reference/type.ts +30 -13
- package/authoring/doctypes/schema/schema.doc.mjs +1 -1
- package/authoring/doctypes/schema/type.ts +1 -2
- package/authoring/doctypes/template/parse.d.mts +2 -0
- package/authoring/doctypes/template/parse.mjs +4 -0
- package/authoring/doctypes/template/parse.test.mjs +18 -0
- package/authoring/doctypes/template/template.doc.mjs +9 -3
- package/authoring/doctypes/template/type.ts +8 -0
- package/authoring/doctypes/theme/parse.d.mts +35 -0
- package/authoring/doctypes/theme/parse.mjs +76 -0
- package/authoring/doctypes/theme/theme.doc.d.mts +9 -0
- package/authoring/doctypes/theme/theme.doc.mjs +79 -0
- package/authoring/doctypes/theme/type.ts +42 -0
- package/authoring/doctypes/types.ts +2 -1
- package/authoring/gap-report/gap-report.doc.d.mts +12 -0
- package/authoring/gap-report/gap-report.doc.mjs +183 -0
- package/authoring/identity/identity.doc.mjs +2 -2
- package/authoring/index.d.mts +1 -0
- package/authoring/index.d.ts +7 -4
- package/authoring/index.mjs +2 -1
- package/authoring/integration/integration.doc.mjs +2 -2
- package/authoring/integration/type.ts +4 -10
- package/clients/cli/__tests__/cliManifest.test.ts +27 -29
- package/clients/cli/commands/blog.doc.mjs +1 -1
- package/clients/cli/commands/build-theme.adaptations.test.mjs +100 -1
- package/clients/cli/commands/build-theme.mjs +11 -45
- package/clients/cli/commands/build.doc.mjs +12 -7
- package/clients/cli/commands/build.mjs +105 -67
- package/clients/cli/commands/build.text-fields.test.mjs +41 -0
- package/clients/cli/commands/component/index.mjs +1 -1
- package/clients/cli/commands/component-ownership.test.mjs +3 -3
- package/clients/cli/commands/component.doc.mjs +1 -1
- package/clients/cli/commands/discover.broken-integration.test.mjs +7 -8
- package/clients/cli/commands/discover.doc.mjs +1 -1
- package/clients/cli/commands/discover.mjs +1 -1
- package/clients/cli/commands/docs.doc.mjs +21 -9
- package/clients/cli/commands/docs.mjs +184 -70
- package/clients/cli/commands/docs.test.mjs +120 -16
- package/clients/cli/commands/doctor-integration-components.doc.mjs +1 -1
- package/clients/cli/commands/doctor-integration-docs.doc.mjs +3 -3
- package/clients/cli/commands/doctor-integration-templates.doc.mjs +15 -8
- package/clients/cli/commands/doctor-integration-validate.doc.mjs +1 -1
- package/clients/cli/commands/doctor-integration.doc.mjs +1 -1
- package/clients/cli/commands/doctor-integration.test.mjs +90 -8
- package/clients/cli/commands/doctor.doc.mjs +1 -1
- package/clients/cli/commands/doctor.mjs +53 -16
- package/clients/cli/commands/gap-report.doc.mjs +1 -1
- package/clients/cli/commands/hook.doc.mjs +1 -1
- package/clients/cli/commands/init.doc.mjs +1 -1
- package/clients/cli/commands/integration-add.controls.test.mjs +1 -1
- package/clients/cli/commands/integration-add.doc.mjs +11 -1
- package/clients/cli/commands/integration-pack.doc.mjs +1 -1
- package/clients/cli/commands/integration-real-world.test.mjs +3 -9
- package/clients/cli/commands/integration.doc.mjs +1 -1
- package/clients/cli/commands/integration.mjs +1 -0
- package/clients/cli/commands/layout-check.doc.mjs +1 -1
- package/clients/cli/commands/layout-expand.doc.mjs +1 -1
- package/clients/cli/commands/layout-grammar.doc.mjs +1 -1
- package/clients/cli/commands/layout.doc.mjs +1 -1
- package/clients/cli/commands/manifest.doc.mjs +1 -1
- package/clients/cli/commands/search.doc.mjs +1 -1
- package/clients/cli/commands/search.mjs +11 -2
- package/clients/cli/commands/setup-nudge.test.mjs +6 -0
- package/clients/cli/commands/swizzle.doc.mjs +1 -1
- package/clients/cli/commands/template.doc.mjs +24 -7
- package/clients/cli/commands/template.mjs +4 -91
- package/clients/cli/commands/text-json-parity.test.mjs +719 -0
- package/clients/cli/commands/theme-add.doc.mjs +2 -2
- package/clients/cli/commands/theme-build.doc.mjs +1 -1
- package/clients/cli/commands/theme-list.doc.mjs +2 -2
- package/clients/cli/commands/theme-palette-generate.doc.mjs +3 -3
- package/clients/cli/commands/theme-palette.doc.mjs +1 -1
- package/clients/cli/commands/theme-targets.behavior.test.mjs +4 -3
- package/clients/cli/commands/theme-targets.doc.mjs +1 -1
- package/clients/cli/commands/theme-template.doc.mjs +1 -1
- package/clients/cli/commands/theme.doc.mjs +1 -1
- package/clients/cli/commands/upgrade.doc.mjs +3 -2
- package/clients/cli/commands/upgrade.file-protection.test.mjs +228 -0
- package/clients/cli/commands/upgrade.mjs +29 -7
- package/clients/cli/formatters/index.mjs +2 -0
- package/clients/cli/formatters/index.test.mjs +6 -0
- package/clients/cli/index.mjs +8 -0
- package/clients/cli/lib/hook-format.mjs +14 -5
- package/clients/cli/lib/manifest.mjs +9 -2
- package/foundation/agent-docs/agent-docs.d.mts +3 -2
- package/foundation/agent-docs/agent-docs.mjs +13 -9
- package/foundation/agent-docs/agent-docs.test.mjs +19 -1
- package/foundation/config/project-themes.test.mjs +11 -19
- package/foundation/config/project.d.mts +20 -11
- package/foundation/config/project.mjs +123 -80
- package/foundation/config/project.test.mjs +144 -21
- package/foundation/discovery/authoring-self-docs.d.mts +18 -0
- package/foundation/discovery/authoring-self-docs.mjs +37 -15
- package/foundation/discovery/authoring-self-docs.test.mjs +25 -9
- package/foundation/discovery/authoring-surface.d.mts +74 -0
- package/foundation/discovery/authoring-surface.mjs +525 -0
- package/foundation/discovery/authoring-surface.test.mjs +392 -0
- package/foundation/discovery/cli-self-docs.d.mts +119 -0
- package/foundation/discovery/cli-self-docs.mjs +490 -0
- package/foundation/discovery/cli-self-docs.test.mjs +375 -0
- package/foundation/discovery/component-discovery.d.mts +38 -0
- package/foundation/discovery/component-discovery.mjs +48 -0
- package/foundation/discovery/component-loader.d.mts +35 -38
- package/foundation/discovery/component-loader.mjs +53 -222
- package/foundation/discovery/docs-discovery.d.mts +112 -11
- package/foundation/discovery/docs-discovery.mjs +231 -36
- package/foundation/discovery/docs-discovery.test.mjs +111 -32
- package/foundation/discovery/docs-output-budget.d.mts +2 -2
- package/foundation/discovery/docs-output-budget.mjs +1 -1
- package/foundation/discovery/docs-section-key.d.mts +28 -10
- package/foundation/discovery/docs-section-key.mjs +134 -33
- package/foundation/discovery/docs-section-key.test.mjs +41 -19
- package/foundation/discovery/template-adapter.d.mts +99 -6
- package/foundation/discovery/template-adapter.mjs +480 -57
- package/foundation/discovery/template-adapter.test.mjs +57 -0
- package/foundation/discovery/template-conflict-release.d.mts +13 -0
- package/foundation/discovery/template-conflict-release.mjs +40 -0
- package/foundation/discovery/template-conflict-release.test.mjs +40 -0
- package/foundation/discovery/theme-discovery.d.mts +67 -7
- package/foundation/discovery/theme-discovery.mjs +916 -186
- package/foundation/discovery/theme-discovery.test.mjs +613 -219
- package/foundation/doc-compiler/bundle.d.mts +47 -0
- package/foundation/doc-compiler/bundle.mjs +278 -0
- package/foundation/doc-compiler/bundle.test.mjs +266 -0
- package/foundation/doc-compiler/compile.d.mts +220 -39
- package/foundation/doc-compiler/compile.mjs +311 -15
- package/foundation/doc-compiler/diagnostics.d.mts +126 -0
- package/foundation/doc-compiler/diagnostics.mjs +305 -0
- package/foundation/doc-compiler/doc-compiler.test.mjs +28 -1
- package/foundation/doc-compiler/doc-loads.test.mjs +1642 -0
- package/foundation/doc-compiler/import.d.mts +24 -0
- package/foundation/doc-compiler/import.mjs +59 -0
- package/foundation/doc-compiler/inputs.d.mts +102 -0
- package/foundation/doc-compiler/inputs.mjs +291 -0
- package/foundation/doc-compiler/inputs.test.mjs +299 -0
- package/foundation/doc-compiler/ir.d.mts +13 -0
- package/foundation/doc-compiler/ir.mjs +196 -12
- package/foundation/doc-compiler/lenses.d.mts +8 -5
- package/foundation/doc-compiler/lenses.mjs +50 -4
- package/foundation/doc-compiler/links.d.mts +162 -0
- package/foundation/doc-compiler/links.mjs +294 -0
- package/foundation/doc-compiler/links.test.mjs +192 -0
- package/foundation/doc-compiler/lower-doc.test.mjs +495 -0
- package/foundation/doc-compiler/overlays.d.mts +37 -0
- package/foundation/doc-compiler/overlays.mjs +206 -0
- package/foundation/doc-compiler/parse-readable.d.mts +9 -0
- package/foundation/doc-compiler/parse-readable.mjs +29 -0
- package/foundation/doc-compiler/read.d.mts +127 -0
- package/foundation/doc-compiler/read.mjs +325 -0
- package/foundation/doc-compiler/read.test.mjs +313 -0
- package/foundation/doc-compiler/source.d.mts +33 -0
- package/foundation/doc-compiler/source.mjs +128 -0
- package/foundation/doc-compiler/tree.d.mts +288 -0
- package/foundation/doc-compiler/tree.mjs +876 -0
- package/foundation/doc-compiler/tree.test.mjs +598 -0
- package/foundation/fs/file-protection.d.mts +33 -0
- package/foundation/fs/file-protection.mjs +825 -0
- package/foundation/fs/file-protection.test.mjs +250 -0
- package/foundation/integrations/autolink.d.mts +58 -1
- package/foundation/integrations/autolink.mjs +143 -57
- package/foundation/integrations/autolink.test.mjs +1 -1
- package/foundation/integrations/cli-requirement.d.mts +45 -0
- package/foundation/integrations/cli-requirement.mjs +154 -0
- package/foundation/integrations/cli-requirement.test.mjs +84 -0
- package/foundation/integrations/contribution-fixes.d.mts +145 -0
- package/foundation/integrations/contribution-fixes.mjs +1284 -0
- package/foundation/integrations/contribution-inventory.d.mts +3 -2
- package/foundation/integrations/contribution-inventory.mjs +27 -24
- package/foundation/integrations/contribution-inventory.test.mjs +86 -27
- package/foundation/integrations/integration-warnings.d.mts +9 -2
- package/foundation/integrations/integration-warnings.mjs +51 -26
- package/foundation/integrations/integration-warnings.test.mjs +74 -1
- package/foundation/integrations/integrations.d.mts +3 -0
- package/foundation/integrations/integrations.mjs +11 -97
- package/foundation/integrations/provider-ledger.test.mjs +275 -0
- package/foundation/integrations/provider-resolution.d.mts +152 -0
- package/foundation/integrations/provider-resolution.mjs +576 -0
- package/foundation/integrations/provider-resolution.test.mjs +369 -0
- package/foundation/integrations/theme-descriptor.d.mts +8 -0
- package/foundation/integrations/theme-descriptor.mjs +44 -0
- package/foundation/integrations/validate-contributions.mjs +121 -29
- package/foundation/response/error-codes.d.mts +3 -1
- package/foundation/response/error-codes.d.ts +2 -0
- package/foundation/response/error-codes.doc.mjs +12 -2
- package/foundation/response/error-codes.mjs +7 -1
- package/foundation/response/error-codes.test.mjs +55 -11
- package/foundation/response/response-types.doc.d.mts +5 -1
- package/foundation/response/response-types.doc.mjs +20 -11
- package/foundation/response/response.doc.mjs +1 -1
- package/foundation/text/string-utils.d.mts +8 -0
- package/foundation/text/string-utils.mjs +40 -10
- package/foundation/xle/expand.mjs +1 -1
- package/foundation/xle/xle.test.mjs +13 -0
- package/package.json +10 -9
- package/assets/templates/themes/manifest.json +0 -95
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
import {afterEach, beforeEach, describe, expect, it} from 'vitest';
|
|
4
|
+
import * as fs from 'node:fs';
|
|
5
|
+
import * as os from 'node:os';
|
|
6
|
+
import * as path from 'node:path';
|
|
7
|
+
import {
|
|
8
|
+
createFileProtectionResolver,
|
|
9
|
+
ProtectionSourceError,
|
|
10
|
+
} from './file-protection.mjs';
|
|
11
|
+
|
|
12
|
+
let root;
|
|
13
|
+
|
|
14
|
+
beforeEach(() => {
|
|
15
|
+
root = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-protection-'));
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
afterEach(() => {
|
|
19
|
+
fs.rmSync(root, {recursive: true, force: true});
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
function write(relative, contents = '') {
|
|
23
|
+
const file = path.join(root, relative);
|
|
24
|
+
fs.mkdirSync(path.dirname(file), {recursive: true});
|
|
25
|
+
fs.writeFileSync(file, contents);
|
|
26
|
+
return file;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
function declarations(relative) {
|
|
30
|
+
return createFileProtectionResolver(root)
|
|
31
|
+
.classify(path.join(root, relative))
|
|
32
|
+
.map(item => item.declaration);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
describe('working-tree .gitattributes', () => {
|
|
36
|
+
it('honors nested later rules and explicit false or unset values', () => {
|
|
37
|
+
write(
|
|
38
|
+
'.gitattributes',
|
|
39
|
+
[
|
|
40
|
+
'*.css linguist-generated=true',
|
|
41
|
+
'vendor/** linguist-vendored',
|
|
42
|
+
'authored.css -linguist-generated',
|
|
43
|
+
'unset.css !linguist-generated',
|
|
44
|
+
'',
|
|
45
|
+
].join('\n'),
|
|
46
|
+
);
|
|
47
|
+
write('generated.css', 'body {}');
|
|
48
|
+
write('authored.css', 'body {}');
|
|
49
|
+
write('unset.css', 'body {}');
|
|
50
|
+
write('nested/keep.css', 'body {}');
|
|
51
|
+
write('nested/.gitattributes', 'keep.css linguist-generated=false\n');
|
|
52
|
+
write('vendor/pkg/index.js', 'export {};');
|
|
53
|
+
|
|
54
|
+
expect(declarations('generated.css')).toContain(
|
|
55
|
+
'linguist-generated in .gitattributes:1',
|
|
56
|
+
);
|
|
57
|
+
expect(declarations('authored.css')).toEqual([]);
|
|
58
|
+
expect(declarations('unset.css')).toEqual([]);
|
|
59
|
+
expect(declarations('nested/keep.css')).toEqual([]);
|
|
60
|
+
expect(declarations('vendor/pkg/index.js')).toContain(
|
|
61
|
+
'linguist-vendored in .gitattributes:2',
|
|
62
|
+
);
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
it('expands top-level attribute macros, including forward definitions', () => {
|
|
66
|
+
write(
|
|
67
|
+
'.gitattributes',
|
|
68
|
+
'via-macro/** outer\n[attr]outer generated\n[attr]generated linguist-generated\n',
|
|
69
|
+
);
|
|
70
|
+
write('via-macro/output.js', 'export {};');
|
|
71
|
+
expect(declarations('via-macro/output.js')).toContain(
|
|
72
|
+
'linguist-generated in .gitattributes:1',
|
|
73
|
+
);
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
it('preserves escaped wildcards as literal path characters', () => {
|
|
77
|
+
write('.gitattributes', 'literal\\*.js linguist-generated\n');
|
|
78
|
+
write('literal*.js', 'export {};');
|
|
79
|
+
write('literalX.js', 'export {};');
|
|
80
|
+
expect(declarations('literal*.js')).toHaveLength(1);
|
|
81
|
+
expect(declarations('literalX.js')).toEqual([]);
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
it('supports quoted attribute patterns with spaces', () => {
|
|
85
|
+
write('.gitattributes', '"generated output/*.js" linguist-generated\n');
|
|
86
|
+
write('generated output/theme.js', 'export {};');
|
|
87
|
+
expect(declarations('generated output/theme.js')).toHaveLength(1);
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
it('matches basename patterns below the declaring directory', () => {
|
|
91
|
+
write('.gitattributes', '*.gen.ts linguist-generated\n');
|
|
92
|
+
write('src/deep/theme.gen.ts', 'export {};');
|
|
93
|
+
expect(declarations('src/deep/theme.gen.ts')).toHaveLength(1);
|
|
94
|
+
});
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
describe('working-tree ignore rules', () => {
|
|
98
|
+
it('honors gitignore negation and nested precedence', () => {
|
|
99
|
+
write('.gitignore', ['src/**/*.js', '!src/keep.js', ''].join('\n'));
|
|
100
|
+
write('src/drop.js', 'drop');
|
|
101
|
+
write('src/keep.js', 'keep');
|
|
102
|
+
write('src/deep/drop.js', 'drop');
|
|
103
|
+
write('src/.gitignore', '!deep/keep.js\n');
|
|
104
|
+
write('src/deep/keep.js', 'keep');
|
|
105
|
+
|
|
106
|
+
expect(declarations('src/drop.js')[0]).toBe('excluded by .gitignore');
|
|
107
|
+
expect(declarations('src/deep/drop.js')[0]).toBe('excluded by .gitignore');
|
|
108
|
+
expect(declarations('src/keep.js')).toEqual([]);
|
|
109
|
+
expect(declarations('src/deep/keep.js')).toEqual([]);
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
it('uses case-sensitive Git matching on case-sensitive platforms', () => {
|
|
113
|
+
write('.gitignore', 'FOO\n');
|
|
114
|
+
write('FOO', 'x');
|
|
115
|
+
write('foo', 'x');
|
|
116
|
+
|
|
117
|
+
expect(declarations('FOO')[0]).toBe('excluded by .gitignore');
|
|
118
|
+
expect(declarations('foo')).toEqual([]);
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
it('does not let a nested ignore file re-include beneath an excluded parent', () => {
|
|
122
|
+
write('.gitignore', 'ignored/\n');
|
|
123
|
+
write('ignored/.gitignore', '!keep.js\n');
|
|
124
|
+
write('ignored/keep.js', 'keep');
|
|
125
|
+
|
|
126
|
+
expect(declarations('ignored/keep.js')[0]).toBe('excluded by .gitignore');
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
it('ignores nested .hgignore files unless the root file includes them', () => {
|
|
130
|
+
write('sub/.hgignore', 'syntax: glob\n*.tmp\n');
|
|
131
|
+
write('sub/file.tmp', 'x');
|
|
132
|
+
expect(declarations('sub/file.tmp')).toEqual([]);
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
it('reads Mercurial glob and regexp syntax without a repository process', () => {
|
|
136
|
+
write(
|
|
137
|
+
'.hgignore',
|
|
138
|
+
['syntax: glob', '**/*.generated.css', 're:^legacy/.+\\.js$', ''].join(
|
|
139
|
+
'\n',
|
|
140
|
+
),
|
|
141
|
+
);
|
|
142
|
+
write('src/theme.generated.css', 'x');
|
|
143
|
+
write('legacy/file.js', 'x');
|
|
144
|
+
write('src/file.js', 'x');
|
|
145
|
+
|
|
146
|
+
expect(declarations('src/theme.generated.css')[0]).toMatch(/\.hgignore:2/);
|
|
147
|
+
expect(declarations('legacy/file.js')[0]).toMatch(/\.hgignore:3/);
|
|
148
|
+
expect(declarations('src/file.js')).toEqual([]);
|
|
149
|
+
});
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
describe('leading generated comments', () => {
|
|
153
|
+
it.each([
|
|
154
|
+
['// @generated\nexport const x = 1;\n', '@generated'],
|
|
155
|
+
[
|
|
156
|
+
'/* @partially-generated */\nexport const x = 1;\n',
|
|
157
|
+
'@partially-generated',
|
|
158
|
+
],
|
|
159
|
+
[
|
|
160
|
+
'// Code generated by Acme. DO NOT EDIT.\nconst x = 1;\n',
|
|
161
|
+
'Code generated',
|
|
162
|
+
],
|
|
163
|
+
['#!/usr/bin/env node\n// @generated\nconsole.log(1);\n', '@generated'],
|
|
164
|
+
])('protects a recognized leading marker', (source, expected) => {
|
|
165
|
+
write('file.js', source);
|
|
166
|
+
expect(declarations('file.js')[0]).toContain(expected);
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
it('recognizes hash comments after a shebang in an extensionless file', () => {
|
|
170
|
+
write('script', '#!/bin/sh\n# @generated\necho hi\n');
|
|
171
|
+
expect(declarations('script')[0]).toContain('@generated');
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
it('does not treat a marker after authored code as protection', () => {
|
|
175
|
+
write('file.js', 'export const authored = true;\n// @generated\n');
|
|
176
|
+
expect(declarations('file.js')).toEqual([]);
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
it('does not accept longer generated-like annotations', () => {
|
|
180
|
+
write('file.js', '// @generated-code\nexport const authored = true;\n');
|
|
181
|
+
expect(declarations('file.js')).toEqual([]);
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
it('does not mistake a leading CSS id selector for a comment', () => {
|
|
185
|
+
write('file.css', '#root { color: red; }\n/* @generated */\n');
|
|
186
|
+
expect(declarations('file.css')).toEqual([]);
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
it('extracts an exact regeneration command from a generated header', () => {
|
|
190
|
+
const file = write(
|
|
191
|
+
'theme.css',
|
|
192
|
+
'/*\n * @generated\n * Command: pnpm astryx theme build src/theme.ts\n */\n',
|
|
193
|
+
);
|
|
194
|
+
const protection = createFileProtectionResolver(root).classify(file)[0];
|
|
195
|
+
expect(protection.command).toBe('pnpm astryx theme build src/theme.ts');
|
|
196
|
+
});
|
|
197
|
+
});
|
|
198
|
+
|
|
199
|
+
describe('hard boundaries and fail-closed parsing', () => {
|
|
200
|
+
it('protects dependency metadata, VCS metadata leaves, symlinks, and paths outside root', () => {
|
|
201
|
+
const dependency = write('node_modules/pkg/index.js', 'x');
|
|
202
|
+
const yarnDependency = write('.yarn/unplugged/pkg/index.js', 'x');
|
|
203
|
+
const yarnVirtual = write('.yarn/__virtual__/pkg/index.js', 'x');
|
|
204
|
+
const yarnInstallState = write('.yarn/install-state.gz', 'x');
|
|
205
|
+
const yarnPatch = write('.yarn/patches/pkg.patch', 'x');
|
|
206
|
+
const pnp = write('.pnp.cjs', 'x');
|
|
207
|
+
const pnpData = write('.pnp.data.json', '{}');
|
|
208
|
+
const metadata = write('.git', 'gitdir: elsewhere\n');
|
|
209
|
+
const target = write('target.js', 'x');
|
|
210
|
+
const link = path.join(root, 'link.js');
|
|
211
|
+
fs.symlinkSync(target, link);
|
|
212
|
+
const resolver = createFileProtectionResolver(root);
|
|
213
|
+
|
|
214
|
+
expect(resolver.classify(dependency)[0].reason).toBe('dependency');
|
|
215
|
+
expect(resolver.classify(yarnDependency)[0].reason).toBe('dependency');
|
|
216
|
+
expect(resolver.classify(yarnVirtual)[0].reason).toBe('dependency');
|
|
217
|
+
expect(resolver.classify(yarnInstallState)[0].reason).toBe('dependency');
|
|
218
|
+
expect(resolver.classify(yarnPatch)).toEqual([]);
|
|
219
|
+
expect(resolver.classify(pnp)[0].reason).toBe('dependency');
|
|
220
|
+
expect(resolver.classify(pnpData)[0].reason).toBe('dependency');
|
|
221
|
+
expect(resolver.classify(metadata)[0].reason).toBe('vcs');
|
|
222
|
+
expect(resolver.classify(link)[0].reason).toBe('symlink');
|
|
223
|
+
expect(
|
|
224
|
+
resolver.classify(path.join(root, '..', 'outside.js'))[0].reason,
|
|
225
|
+
).toBe('outside-root');
|
|
226
|
+
});
|
|
227
|
+
|
|
228
|
+
it('rejects an .hgignore include reached through a symlink', () => {
|
|
229
|
+
const outside = path.join(
|
|
230
|
+
os.tmpdir(),
|
|
231
|
+
`astryx-ignore-${process.pid}-${Date.now()}`,
|
|
232
|
+
);
|
|
233
|
+
fs.writeFileSync(outside, 'syntax: glob\n*.generated\n');
|
|
234
|
+
try {
|
|
235
|
+
fs.symlinkSync(outside, path.join(root, 'rules'));
|
|
236
|
+
write('.hgignore', 'include:rules\n');
|
|
237
|
+
expect(() => createFileProtectionResolver(root)).toThrow(/symbolic link/);
|
|
238
|
+
} finally {
|
|
239
|
+
fs.rmSync(outside, {force: true});
|
|
240
|
+
}
|
|
241
|
+
});
|
|
242
|
+
|
|
243
|
+
it('fails before use when a protection source cannot be parsed', () => {
|
|
244
|
+
write('.hgignore', 'syntax: regexp\n[unterminated\n');
|
|
245
|
+
expect(() => createFileProtectionResolver(root)).toThrow(
|
|
246
|
+
ProtectionSourceError,
|
|
247
|
+
);
|
|
248
|
+
expect(() => createFileProtectionResolver(root)).toThrow(/\.hgignore/);
|
|
249
|
+
});
|
|
250
|
+
});
|
|
@@ -35,6 +35,28 @@ export function resolveInstalledPackageDir(name: string, fromDir: string): {
|
|
|
35
35
|
packageDir: string;
|
|
36
36
|
hostDir: string;
|
|
37
37
|
} | null;
|
|
38
|
+
/**
|
|
39
|
+
* @typedef {object} AutolinkCandidate
|
|
40
|
+
* @property {string} spec
|
|
41
|
+
* @property {string} field
|
|
42
|
+
* @property {string} packageDir
|
|
43
|
+
* @property {string} hostDir
|
|
44
|
+
* @property {boolean} [repeat] the directory is already loaded or already a
|
|
45
|
+
* candidate under another dependency key; it is not loaded again
|
|
46
|
+
*/
|
|
47
|
+
/**
|
|
48
|
+
* Every declared dependency that ships exactly one root manifest, in
|
|
49
|
+
* declaration order, including the ones whose directory is already loaded or
|
|
50
|
+
* already a candidate (`repeat`), so a caller can account for each of them.
|
|
51
|
+
*
|
|
52
|
+
* @param {string} projectDir directory holding the project's package.json
|
|
53
|
+
* @param {{exclude?: Iterable<string>}} [options] `exclude` — package
|
|
54
|
+
* directories already loaded (from config); matched through symlinks
|
|
55
|
+
* @returns {AutolinkCandidate[]}
|
|
56
|
+
*/
|
|
57
|
+
export function scanAutolinkCandidates(projectDir: string, { exclude }?: {
|
|
58
|
+
exclude?: Iterable<string>;
|
|
59
|
+
}): AutolinkCandidate[];
|
|
38
60
|
/**
|
|
39
61
|
* Declared dependencies that ship an integration manifest and are not already
|
|
40
62
|
* loaded, in declaration order.
|
|
@@ -50,7 +72,7 @@ export function resolveInstalledPackageDir(name: string, fromDir: string): {
|
|
|
50
72
|
* directories already loaded (from config); matched through symlinks
|
|
51
73
|
* @returns {Array<{spec: string, field: string, packageDir: string, hostDir: string}>}
|
|
52
74
|
*/
|
|
53
|
-
export function findAutolinkCandidates(projectDir: string,
|
|
75
|
+
export function findAutolinkCandidates(projectDir: string, options?: {
|
|
54
76
|
exclude?: Iterable<string>;
|
|
55
77
|
}): Array<{
|
|
56
78
|
spec: string;
|
|
@@ -58,6 +80,24 @@ export function findAutolinkCandidates(projectDir: string, { exclude }?: {
|
|
|
58
80
|
packageDir: string;
|
|
59
81
|
hostDir: string;
|
|
60
82
|
}>;
|
|
83
|
+
/**
|
|
84
|
+
* Load every autolink candidate, each in isolation, as provider candidates for
|
|
85
|
+
* {@link resolveProviders}. Nothing is filtered here: a candidate whose load
|
|
86
|
+
* throws or whose manifest fails comes back with its error, and a repeated
|
|
87
|
+
* directory comes back unloaded, so the resolver records each one.
|
|
88
|
+
*
|
|
89
|
+
* @param {object} options
|
|
90
|
+
* @param {string} options.projectDir directory holding the project's package.json
|
|
91
|
+
* @param {import('./integrations.mjs').LoadedIntegration[]} [options.loaded]
|
|
92
|
+
* integrations already loaded from config
|
|
93
|
+
* @param {boolean} [options.fresh]
|
|
94
|
+
* @returns {Promise<import('./provider-resolution.mjs').ProviderCandidate[]>}
|
|
95
|
+
*/
|
|
96
|
+
export function loadAutolinkCandidates({ projectDir, loaded, fresh, }: {
|
|
97
|
+
projectDir: string;
|
|
98
|
+
loaded?: import("./integrations.mjs").LoadedIntegration[] | undefined;
|
|
99
|
+
fresh?: boolean | undefined;
|
|
100
|
+
}): Promise<import("./provider-resolution.mjs").ProviderCandidate[]>;
|
|
61
101
|
/**
|
|
62
102
|
* Load every declared dependency that ships an integration manifest and is not
|
|
63
103
|
* already loaded from config.
|
|
@@ -72,6 +112,12 @@ export function findAutolinkCandidates(projectDir: string, { exclude }?: {
|
|
|
72
112
|
* consuming project can neither fix nor silence, and which
|
|
73
113
|
* `astryx doctor integration validate <package>` reports on demand.
|
|
74
114
|
*
|
|
115
|
+
* One package reached twice (an alias beside the package it aliases, at the
|
|
116
|
+
* same version) loads once. The same name at another version is kept, so the
|
|
117
|
+
* provider pass reports it instead of dropping it. Project.load does not call
|
|
118
|
+
* this; it hands {@link loadAutolinkCandidates} to the resolver, whose ledger
|
|
119
|
+
* records every candidate dropped here.
|
|
120
|
+
*
|
|
75
121
|
* @param {object} options
|
|
76
122
|
* @param {string} options.projectDir directory holding the project's package.json
|
|
77
123
|
* @param {import('./integrations.mjs').LoadedIntegration[]} [options.loaded]
|
|
@@ -94,3 +140,14 @@ export function autolinkIntegrations({ projectDir, loaded, fresh, }: {
|
|
|
94
140
|
* @type {readonly string[]}
|
|
95
141
|
*/
|
|
96
142
|
export const DEPENDENCY_FIELDS: readonly string[];
|
|
143
|
+
export type AutolinkCandidate = {
|
|
144
|
+
spec: string;
|
|
145
|
+
field: string;
|
|
146
|
+
packageDir: string;
|
|
147
|
+
hostDir: string;
|
|
148
|
+
/**
|
|
149
|
+
* the directory is already loaded or already a
|
|
150
|
+
* candidate under another dependency key; it is not loaded again
|
|
151
|
+
*/
|
|
152
|
+
repeat?: boolean | undefined;
|
|
153
|
+
};
|
|
@@ -29,8 +29,9 @@
|
|
|
29
29
|
* package's own package.json `name` (see loadIntegrations), so an aliased
|
|
30
30
|
* dependency reports the package it actually is.
|
|
31
31
|
*
|
|
32
|
-
* An explicit config entry always wins:
|
|
33
|
-
*
|
|
32
|
+
* An explicit config entry always wins: a dependency whose directory is
|
|
33
|
+
* already loaded from config is never imported again, and comes back as a
|
|
34
|
+
* repeat so the provider ledger still records it.
|
|
34
35
|
*
|
|
35
36
|
* @position lib — sits between config/project (the caller) and
|
|
36
37
|
* integrations/integrations (the loader); contributes no discovery of its own.
|
|
@@ -39,6 +40,7 @@
|
|
|
39
40
|
import * as fs from 'node:fs';
|
|
40
41
|
import * as path from 'node:path';
|
|
41
42
|
import {findManifestPaths, loadIntegrations} from './integrations.mjs';
|
|
43
|
+
import {resolveProviders} from './provider-resolution.mjs';
|
|
42
44
|
|
|
43
45
|
/**
|
|
44
46
|
* package.json fields whose keys name a dependency this project installs.
|
|
@@ -164,36 +166,44 @@ function realPath(target) {
|
|
|
164
166
|
}
|
|
165
167
|
|
|
166
168
|
/**
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
|
|
169
|
+
* @typedef {object} AutolinkCandidate
|
|
170
|
+
* @property {string} spec
|
|
171
|
+
* @property {string} field
|
|
172
|
+
* @property {string} packageDir
|
|
173
|
+
* @property {string} hostDir
|
|
174
|
+
* @property {boolean} [repeat] the directory is already loaded or already a
|
|
175
|
+
* candidate under another dependency key; it is not loaded again
|
|
176
|
+
*/
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Every declared dependency that ships exactly one root manifest, in
|
|
180
|
+
* declaration order, including the ones whose directory is already loaded or
|
|
181
|
+
* already a candidate (`repeat`), so a caller can account for each of them.
|
|
175
182
|
*
|
|
176
183
|
* @param {string} projectDir directory holding the project's package.json
|
|
177
184
|
* @param {{exclude?: Iterable<string>}} [options] `exclude` — package
|
|
178
185
|
* directories already loaded (from config); matched through symlinks
|
|
179
|
-
* @returns {
|
|
186
|
+
* @returns {AutolinkCandidate[]}
|
|
180
187
|
*/
|
|
181
|
-
export function
|
|
188
|
+
export function scanAutolinkCandidates(projectDir, {exclude = []} = {}) {
|
|
182
189
|
const taken = new Set([...exclude].map(realPath));
|
|
183
|
-
/** @type {
|
|
190
|
+
/** @type {AutolinkCandidate[]} */
|
|
184
191
|
const candidates = [];
|
|
185
192
|
|
|
186
193
|
for (const {name, field} of readDeclaredDependencies(projectDir)) {
|
|
187
194
|
const resolved = resolveInstalledPackageDir(name, projectDir);
|
|
188
195
|
if (!resolved) continue;
|
|
189
196
|
|
|
197
|
+
if (findManifestPaths(resolved.packageDir).length !== 1) continue;
|
|
198
|
+
|
|
190
199
|
// Two dependency keys can name one installed package — an npm alias beside
|
|
191
200
|
// the package it aliases, or the two spellings of a package mid-rename
|
|
192
201
|
// resolving through one store entry. Load it once.
|
|
193
202
|
const identity = realPath(resolved.packageDir);
|
|
194
|
-
if (taken.has(identity))
|
|
195
|
-
|
|
196
|
-
|
|
203
|
+
if (taken.has(identity)) {
|
|
204
|
+
candidates.push({spec: name, field, ...resolved, repeat: true});
|
|
205
|
+
continue;
|
|
206
|
+
}
|
|
197
207
|
|
|
198
208
|
taken.add(identity);
|
|
199
209
|
candidates.push({spec: name, field, ...resolved});
|
|
@@ -202,6 +212,100 @@ export function findAutolinkCandidates(projectDir, {exclude = []} = {}) {
|
|
|
202
212
|
return candidates;
|
|
203
213
|
}
|
|
204
214
|
|
|
215
|
+
/**
|
|
216
|
+
* Declared dependencies that ship an integration manifest and are not already
|
|
217
|
+
* loaded, in declaration order.
|
|
218
|
+
*
|
|
219
|
+
* A candidate must have EXACTLY ONE root manifest. Zero is the ordinary case
|
|
220
|
+
* (almost every dependency), and more than one is a packaging mistake the
|
|
221
|
+
* loader treats as a hard error — an error the project did not ask for and
|
|
222
|
+
* cannot fix, so an ambiguous package is passed over here rather than allowed
|
|
223
|
+
* to fail the load of a project that merely depends on it.
|
|
224
|
+
*
|
|
225
|
+
* @param {string} projectDir directory holding the project's package.json
|
|
226
|
+
* @param {{exclude?: Iterable<string>}} [options] `exclude` — package
|
|
227
|
+
* directories already loaded (from config); matched through symlinks
|
|
228
|
+
* @returns {Array<{spec: string, field: string, packageDir: string, hostDir: string}>}
|
|
229
|
+
*/
|
|
230
|
+
export function findAutolinkCandidates(projectDir, options) {
|
|
231
|
+
return scanAutolinkCandidates(projectDir, options)
|
|
232
|
+
.filter(candidate => !candidate.repeat)
|
|
233
|
+
.map(({spec, field, packageDir, hostDir}) => ({
|
|
234
|
+
spec,
|
|
235
|
+
field,
|
|
236
|
+
packageDir,
|
|
237
|
+
hostDir,
|
|
238
|
+
}));
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Load every autolink candidate, each in isolation, as provider candidates for
|
|
243
|
+
* {@link resolveProviders}. Nothing is filtered here: a candidate whose load
|
|
244
|
+
* throws or whose manifest fails comes back with its error, and a repeated
|
|
245
|
+
* directory comes back unloaded, so the resolver records each one.
|
|
246
|
+
*
|
|
247
|
+
* @param {object} options
|
|
248
|
+
* @param {string} options.projectDir directory holding the project's package.json
|
|
249
|
+
* @param {import('./integrations.mjs').LoadedIntegration[]} [options.loaded]
|
|
250
|
+
* integrations already loaded from config
|
|
251
|
+
* @param {boolean} [options.fresh]
|
|
252
|
+
* @returns {Promise<import('./provider-resolution.mjs').ProviderCandidate[]>}
|
|
253
|
+
*/
|
|
254
|
+
export async function loadAutolinkCandidates({
|
|
255
|
+
projectDir,
|
|
256
|
+
loaded = [],
|
|
257
|
+
fresh = false,
|
|
258
|
+
}) {
|
|
259
|
+
const scanned = scanAutolinkCandidates(projectDir, {
|
|
260
|
+
// A configured entry that never resolved to a directory has none to exclude.
|
|
261
|
+
exclude: loaded.flatMap(integration =>
|
|
262
|
+
typeof integration.__packageDir === 'string'
|
|
263
|
+
? [integration.__packageDir]
|
|
264
|
+
: [],
|
|
265
|
+
),
|
|
266
|
+
});
|
|
267
|
+
|
|
268
|
+
/** @type {import('./provider-resolution.mjs').ProviderCandidate[]} */
|
|
269
|
+
const candidates = [];
|
|
270
|
+
for (const candidate of scanned) {
|
|
271
|
+
const {spec, packageDir} = candidate;
|
|
272
|
+
if (candidate.repeat) {
|
|
273
|
+
candidates.push({source: 'autolinked', spec, packageDir, repeat: true});
|
|
274
|
+
continue;
|
|
275
|
+
}
|
|
276
|
+
try {
|
|
277
|
+
// Resolve from the directory whose node_modules actually holds the
|
|
278
|
+
// package, so a hoisted dependency resolves the same way Node found it.
|
|
279
|
+
const [integration] = await loadIntegrations([spec], {
|
|
280
|
+
cwd: candidate.hostDir,
|
|
281
|
+
fresh,
|
|
282
|
+
});
|
|
283
|
+
candidates.push({
|
|
284
|
+
source: 'autolinked',
|
|
285
|
+
spec,
|
|
286
|
+
packageDir,
|
|
287
|
+
...(integration == null
|
|
288
|
+
? {}
|
|
289
|
+
: {
|
|
290
|
+
integration: {
|
|
291
|
+
...integration,
|
|
292
|
+
__autolinked: true,
|
|
293
|
+
__dependencyField: candidate.field,
|
|
294
|
+
},
|
|
295
|
+
}),
|
|
296
|
+
});
|
|
297
|
+
} catch (error) {
|
|
298
|
+
candidates.push({
|
|
299
|
+
source: 'autolinked',
|
|
300
|
+
spec,
|
|
301
|
+
packageDir,
|
|
302
|
+
error: error instanceof Error ? error.message : String(error),
|
|
303
|
+
});
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
return candidates;
|
|
307
|
+
}
|
|
308
|
+
|
|
205
309
|
/**
|
|
206
310
|
* Load every declared dependency that ships an integration manifest and is not
|
|
207
311
|
* already loaded from config.
|
|
@@ -216,6 +320,12 @@ export function findAutolinkCandidates(projectDir, {exclude = []} = {}) {
|
|
|
216
320
|
* consuming project can neither fix nor silence, and which
|
|
217
321
|
* `astryx doctor integration validate <package>` reports on demand.
|
|
218
322
|
*
|
|
323
|
+
* One package reached twice (an alias beside the package it aliases, at the
|
|
324
|
+
* same version) loads once. The same name at another version is kept, so the
|
|
325
|
+
* provider pass reports it instead of dropping it. Project.load does not call
|
|
326
|
+
* this; it hands {@link loadAutolinkCandidates} to the resolver, whose ledger
|
|
327
|
+
* records every candidate dropped here.
|
|
328
|
+
*
|
|
219
329
|
* @param {object} options
|
|
220
330
|
* @param {string} options.projectDir directory holding the project's package.json
|
|
221
331
|
* @param {import('./integrations.mjs').LoadedIntegration[]} [options.loaded]
|
|
@@ -228,50 +338,26 @@ export async function autolinkIntegrations({
|
|
|
228
338
|
loaded = [],
|
|
229
339
|
fresh = false,
|
|
230
340
|
}) {
|
|
231
|
-
const candidates =
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
),
|
|
238
|
-
|
|
239
|
-
|
|
341
|
+
const candidates = await loadAutolinkCandidates({projectDir, loaded, fresh});
|
|
342
|
+
const {ledger} = resolveProviders([
|
|
343
|
+
...loaded.map(integration => ({
|
|
344
|
+
source: /** @type {const} */ ('configured'),
|
|
345
|
+
integration,
|
|
346
|
+
spec: integration.__spec,
|
|
347
|
+
})),
|
|
348
|
+
...candidates,
|
|
349
|
+
]);
|
|
240
350
|
/** @type {import('./integrations.mjs').LoadedIntegration[]} */
|
|
241
351
|
const autolinked = [];
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
for (const candidate of candidates) {
|
|
251
|
-
/** @type {import('./integrations.mjs').LoadedIntegration|undefined} */
|
|
252
|
-
let integration;
|
|
253
|
-
try {
|
|
254
|
-
// Resolve from the directory whose node_modules actually holds the
|
|
255
|
-
// package, so a hoisted dependency resolves the same way Node found it.
|
|
256
|
-
[integration] = await loadIntegrations([candidate.spec], {
|
|
257
|
-
cwd: candidate.hostDir,
|
|
258
|
-
fresh,
|
|
259
|
-
});
|
|
260
|
-
} catch {
|
|
261
|
-
continue;
|
|
352
|
+
for (const entry of ledger.values()) {
|
|
353
|
+
const {candidate} = entry;
|
|
354
|
+
if (
|
|
355
|
+
candidate.source === 'autolinked' &&
|
|
356
|
+
candidate.integration != null &&
|
|
357
|
+
(entry.outcome === 'contributes' || entry.outcome === 'set-aside')
|
|
358
|
+
) {
|
|
359
|
+
autolinked.push(candidate.integration);
|
|
262
360
|
}
|
|
263
|
-
if (!integration || integration.__loadError) continue;
|
|
264
|
-
// Identity is the resolved package's own name and version, so an alias and
|
|
265
|
-
// the package it aliases collapse here even when they are two directories
|
|
266
|
-
// on disk.
|
|
267
|
-
if (seen.has(identity(integration))) continue;
|
|
268
|
-
seen.add(identity(integration));
|
|
269
|
-
autolinked.push({
|
|
270
|
-
...integration,
|
|
271
|
-
__autolinked: true,
|
|
272
|
-
__dependencyField: candidate.field,
|
|
273
|
-
});
|
|
274
361
|
}
|
|
275
|
-
|
|
276
362
|
return autolinked;
|
|
277
363
|
}
|
|
@@ -87,7 +87,7 @@ function installPackage(
|
|
|
87
87
|
fs.mkdirSync(componentsDir, {recursive: true});
|
|
88
88
|
fs.writeFileSync(
|
|
89
89
|
path.join(componentsDir, `${componentName}.doc.mjs`),
|
|
90
|
-
`export
|
|
90
|
+
`export default {type: 'component', name: '${componentName}', usage: {description: 'A widget'}, props: []};\n`,
|
|
91
91
|
);
|
|
92
92
|
fs.writeFileSync(
|
|
93
93
|
path.join(componentsDir, `${componentName}.tsx`),
|
|
@@ -0,0 +1,45 @@
|
|
|
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
|
+
* The lowest version a semver range admits: the least of its `||`
|
|
6
|
+
* alternatives. Null when an alternative has no lower bound, or the range is
|
|
7
|
+
* not one this can read, so the caller treats it as admitting every version.
|
|
8
|
+
* @param {unknown} range
|
|
9
|
+
* @returns {string | null}
|
|
10
|
+
*/
|
|
11
|
+
export function lowestAdmitted(range: unknown): string | null;
|
|
12
|
+
/**
|
|
13
|
+
* Why a package that ships a namespace doc or a placed guide would lose its
|
|
14
|
+
* docs on an older CLI, or null when its declared CLI range admits only CLIs
|
|
15
|
+
* that read the docs tree. Published 0.6.3 hides every topic of a package
|
|
16
|
+
* with a namespace doc; builds of main before the docs tree also do so for a
|
|
17
|
+
* placed guide.
|
|
18
|
+
* @param {any} pkg package.json
|
|
19
|
+
* @returns {string | null}
|
|
20
|
+
*/
|
|
21
|
+
export function docsTreeCliProblem(pkg: any): string | null;
|
|
22
|
+
/**
|
|
23
|
+
* Why a package with a template that sets `replaces` would lose its templates
|
|
24
|
+
* and doc topics on an older CLI (spec:AST-035), or null when its declared CLI
|
|
25
|
+
* range admits only CLIs that read the field.
|
|
26
|
+
* @param {any} pkg package.json
|
|
27
|
+
* @returns {string | null}
|
|
28
|
+
*/
|
|
29
|
+
export function replacesCliProblem(pkg: any): string | null;
|
|
30
|
+
/**
|
|
31
|
+
* The package.json with a CLI peer that reads namespace docs: optional, unless
|
|
32
|
+
* the package already says otherwise.
|
|
33
|
+
* @param {any} pkg package.json
|
|
34
|
+
* @returns {any}
|
|
35
|
+
*/
|
|
36
|
+
export function withDocsTreeCli(pkg: any): any;
|
|
37
|
+
export const CLI_PACKAGE: "@astryxdesign/cli";
|
|
38
|
+
/**
|
|
39
|
+
* The first CLI release that reads an integration's docs tree (namespace docs
|
|
40
|
+
* and placed guides) and its templates' `replaces`. A release before it can
|
|
41
|
+
* hide every doc topic a package with a namespace doc or a placed guide
|
|
42
|
+
* ships, with no warning, and it rejects `replaces` and withholds the
|
|
43
|
+
* package's templates and doc topics.
|
|
44
|
+
*/
|
|
45
|
+
export const DOCS_TREE_CLI: "0.7.0";
|