@astryxdesign/cli 0.7.2-canary.fe2c655 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +119 -0
- package/README.md +175 -154
- package/api/build/_adapter.d.mts +8 -0
- package/api/build/_adapter.mjs +12 -1
- package/api/build/build.doc.mjs +4 -0
- package/api/build/help/help.mjs +1 -1
- package/api/build/kit/kit.mjs +3 -11
- package/api/component/_adapter.d.mts +72 -1
- package/api/component/_adapter.mjs +212 -18
- package/api/component/component.doc.mjs +6 -1
- package/api/component/component.mjs +82 -15
- package/api/component/component.test.mjs +80 -0
- package/api/component/doc-links.test.mjs +386 -0
- package/api/component/integration-export-name.test.mjs +644 -0
- package/api/component/list/list.mjs +42 -4
- package/api/discover/_adapter.d.mts +132 -12
- package/api/discover/_adapter.mjs +488 -27
- package/api/discover/_adapter.test.mjs +599 -17
- package/api/discover/_catalog-view.d.mts +16 -5
- package/api/discover/_catalog-view.mjs +32 -8
- package/api/discover/detail/doc/doc.mjs +9 -1
- package/api/discover/discover.d.mts +11 -0
- package/api/discover/discover.doc.mjs +9 -7
- package/api/discover/discover.mjs +121 -19
- package/api/discover/discover.type.d.mts +20 -7
- package/api/discover/discover.type.mjs +17 -7
- package/api/discover/list/list.d.mts +4 -3
- package/api/discover/list/list.mjs +17 -10
- package/api/docs/_adapter.d.mts +74 -0
- package/api/docs/_adapter.mjs +553 -16
- package/api/docs/docs.doc.mjs +2 -1
- package/api/docs/docs.mjs +2 -1
- package/api/docs/docs.test.mjs +5 -2
- package/api/docs/integration-tree.test.mjs +22 -0
- package/api/docs/integrationDocs.test.mjs +124 -0
- package/api/docs/list/list.mjs +12 -2
- package/api/docs/reference-blocks.test.mjs +1 -3
- package/api/doctor/_adapter.d.mts +108 -0
- package/api/doctor/_adapter.mjs +223 -4
- package/api/doctor/doctor.d.mts +199 -0
- package/api/doctor/doctor.doc.mjs +3 -2
- package/api/doctor/doctor.mjs +530 -34
- package/api/doctor/doctor.test.mjs +180 -14
- package/api/doctor/release-checks.test.mjs +156 -0
- package/api/doctor/theme-checks.mjs +17 -4
- package/api/doctor/theme-checks.test.mjs +223 -7
- package/api/error.d.mts +10 -0
- package/api/error.mjs +25 -0
- package/api/gap-report/gap-report.d.mts +3 -0
- package/api/gap-report/gap-report.doc.mjs +11 -3
- package/api/gap-report/gap-report.mjs +219 -52
- package/api/gap-report/gap-report.test.mjs +233 -0
- package/api/gap-report/gap-report.type.d.mts +41 -0
- package/api/gap-report/gap-report.type.mjs +18 -0
- package/api/hook/_adapter.mjs +3 -11
- package/api/hook/hook.doc.mjs +4 -0
- package/api/hook/list/list.d.mts +1 -1
- package/api/index.d.mts +2 -0
- package/api/index.mjs +2 -0
- package/api/init/_adapter.d.mts +22 -0
- package/api/init/_adapter.mjs +59 -0
- package/api/init/init.d.mts +7 -5
- package/api/init/init.doc.mjs +28 -7
- package/api/init/init.mjs +28 -4
- package/api/init/init.type.d.mts +48 -3
- package/api/init/init.type.mjs +37 -3
- package/api/init/run/run.d.mts +1 -1
- package/api/init/run/run.mjs +17 -6
- package/api/init/user/user.d.mts +14 -0
- package/api/init/user/user.mjs +87 -0
- package/api/init/user/user.test.mjs +232 -0
- package/api/integration/_adapter.d.mts +45 -0
- package/api/integration/_adapter.mjs +112 -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 +110 -6
- package/api/integration/authoring-checks.test.mjs +808 -0
- package/api/integration/authoring-checks.type.d.mts +143 -0
- package/api/integration/authoring-checks.type.mjs +74 -2
- 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 +45 -6
- package/api/integration/integrationDocConflicts.doc.mjs +22 -5
- package/api/integration/pack-check.mjs +364 -120
- package/api/integration/pack-check.test.mjs +730 -10
- package/api/integration/validate-integration-fixes.test.mjs +67 -0
- package/api/integration/validate-integration.d.mts +8 -0
- package/api/integration/validate-integration.mjs +63 -9
- package/api/integration/validate-integration.test.mjs +88 -8
- package/api/integration/validate-integration.type.d.mts +16 -0
- package/api/integration/validate-integration.type.mjs +14 -1
- package/api/integration/validate-unread-theme-folders.test.mjs +3 -2
- package/api/integration/validateIntegration.doc.mjs +19 -3
- package/api/search/_adapter.d.mts +11 -0
- package/api/search/_adapter.mjs +25 -0
- package/api/search/search.d.mts +82 -13
- package/api/search/search.doc.mjs +8 -3
- package/api/search/search.domain-priority.test.mjs +108 -18
- package/api/search/search.integration-check.test.mjs +24 -0
- package/api/search/search.mjs +645 -64
- package/api/search/search.test.mjs +179 -1
- package/api/search/search.type.d.mts +14 -1
- package/api/search/search.type.mjs +6 -1
- package/api/swizzle/_adapter.mjs +2 -2
- package/api/swizzle/copy/copy.mjs +29 -15
- package/api/template/template-integration.test.mjs +1 -1
- package/api/template/template.test.mjs +120 -3
- package/api/theme/_adapter.d.mts +16 -0
- package/api/theme/_adapter.mjs +32 -5
- package/api/theme/build/build.d.mts +2 -1
- package/api/theme/build/build.family.test.mjs +64 -0
- package/api/theme/build/build.mjs +250 -38
- package/api/theme/build/build.packed-old-core.test.mjs +20 -3
- package/api/theme/build/font-warning.mjs +5 -3
- package/api/theme/build/font-warning.test.mjs +2 -1
- package/api/theme/remove/remove.test.mjs +2 -2
- package/api/theme/targets/targets.mjs +3 -10
- package/api/theme/themeBuild.doc.mjs +4 -4
- package/api/theme/themeTargets.doc.mjs +4 -0
- package/api/theme/use/use.test.mjs +1 -1
- package/api/upgrade/_adapter.d.mts +40 -2
- package/api/upgrade/_adapter.mjs +118 -5
- package/api/upgrade/run/cli-behind-core.test.mjs +438 -0
- package/api/upgrade/run/run.mjs +35 -2
- package/api/upgrade/status/status.d.mts +21 -5
- package/api/upgrade/status/status.mjs +45 -8
- package/api/upgrade/upgrade.doc.mjs +6 -3
- package/api/upgrade/upgrade.mjs +5 -1
- package/api/upgrade/upgrade.type.d.mts +23 -0
- package/api/upgrade/upgrade.type.mjs +16 -1
- package/assets/codemods/__tests__/registry.test.mjs +1 -0
- package/assets/codemods/registry.mjs +1 -0
- package/assets/codemods/runner.mjs +7 -1
- package/assets/codemods/transforms/v0.7.2/__tests__/migrate-list-edge-compensation-to-edge.test.mjs +120 -0
- package/assets/codemods/transforms/v0.7.2/index.mjs +20 -0
- package/assets/codemods/transforms/v0.7.2/migrate-list-edge-compensation-to-edge.mjs +198 -0
- package/assets/discover/official-packages.json +367 -0
- package/assets/docs/README.md +10 -0
- package/assets/docs/author-a-theme.doc.mjs +3 -3
- package/assets/docs/browser-support.doc.mjs +1 -1
- package/assets/docs/getting-started.doc.mjs +26 -6
- package/assets/docs/styling-overview.doc.mjs +1 -1
- package/assets/docs/theme.doc.dense.mjs +1 -1
- package/assets/docs/theme.doc.mjs +2 -2
- package/assets/docs/theme.doc.zh.mjs +1 -1
- package/assets/docs/tree/add-a-component.doc.mjs +22 -2
- package/assets/docs/tree/add-a-theme.doc.mjs +13 -3
- package/assets/docs/tree/add-a-topic.doc.mjs +54 -9
- package/assets/docs/tree/agent-guidance.doc.mjs +19 -5
- package/assets/docs/tree/block-template.doc.mjs +8 -20
- package/assets/docs/tree/build-the-template.doc.mjs +1 -1
- package/assets/docs/tree/building-blocks.doc.mjs +4 -0
- package/assets/docs/tree/check-the-props.doc.mjs +201 -0
- package/assets/docs/tree/check-your-docs.doc.mjs +69 -11
- package/assets/docs/tree/checks.doc.mjs +32 -24
- package/assets/docs/tree/ci-and-containers.doc.mjs +88 -0
- package/assets/docs/tree/cli-command.doc.mjs +142 -0
- package/assets/docs/tree/cli.doc.mjs +6 -0
- package/assets/docs/tree/codemods.doc.mjs +17 -7
- package/assets/docs/tree/commands.doc.mjs +7 -1
- package/assets/docs/tree/component-family.doc.mjs +8 -6
- package/assets/docs/tree/component-imports.doc.mjs +21 -3
- package/assets/docs/tree/components.doc.mjs +7 -1
- package/assets/docs/tree/computer-agent-guide.doc.mjs +160 -0
- package/assets/docs/tree/computer-integrations.doc.mjs +93 -0
- package/assets/docs/tree/configuration.doc.mjs +7 -3
- package/assets/docs/tree/debug-and-gap-reports.doc.mjs +41 -22
- package/assets/docs/tree/define-the-theme.doc.mjs +6 -5
- package/assets/docs/tree/describe-the-component.doc.mjs +3 -3
- package/assets/docs/tree/docs.doc.mjs +9 -3
- package/assets/docs/tree/document-the-template.doc.mjs +1 -1
- package/assets/docs/tree/document-the-theme.doc.mjs +3 -3
- package/assets/docs/tree/export-template-assets.doc.mjs +1 -1
- package/assets/docs/tree/extend-or-replace.doc.mjs +19 -9
- package/assets/docs/tree/fonts-and-assets.doc.mjs +2 -2
- package/assets/docs/tree/generate-a-palette.doc.mjs +7 -5
- package/assets/docs/tree/global-integrations.doc.mjs +124 -0
- package/assets/docs/tree/global.doc.mjs +131 -0
- package/assets/docs/tree/grade-template-with-agent.doc.mjs +5 -5
- package/assets/docs/tree/install-once.doc.mjs +105 -0
- package/assets/docs/tree/integrations.doc.mjs +13 -1
- package/assets/docs/tree/layout-spacing.doc.mjs +2 -3
- package/assets/docs/tree/layout.doc.mjs +6 -6
- package/assets/docs/tree/links.doc.mjs +7 -6
- package/assets/docs/tree/migration-setup.doc.mjs +3 -2
- package/assets/docs/tree/migration-verification.doc.mjs +0 -1
- package/assets/docs/tree/migration.doc.mjs +0 -1
- package/assets/docs/tree/monorepos.doc.mjs +84 -0
- package/assets/docs/tree/package-and-test.doc.mjs +1 -1
- package/assets/docs/tree/page-template.doc.mjs +4 -8
- package/assets/docs/tree/problems.doc.mjs +205 -0
- package/assets/docs/tree/project-global-or-both.doc.mjs +131 -0
- package/assets/docs/tree/publishing.doc.mjs +6 -6
- package/assets/docs/tree/quick-start.doc.mjs +53 -27
- package/assets/docs/tree/reference.doc.mjs +192 -0
- package/assets/docs/tree/replace-a-core-component.doc.mjs +15 -7
- package/assets/docs/tree/replace-a-core-template.doc.mjs +10 -12
- package/assets/docs/tree/scaffold.doc.mjs +1 -1
- package/assets/docs/tree/sections-and-placement.doc.mjs +9 -11
- package/assets/docs/tree/see-it-in-an-app.doc.mjs +17 -5
- package/assets/docs/tree/short-and-findable.doc.mjs +9 -8
- package/assets/docs/tree/single-component.doc.mjs +15 -6
- package/assets/docs/tree/start-a-template.doc.mjs +18 -8
- package/assets/docs/tree/subcomponent.doc.mjs +6 -6
- package/assets/docs/tree/template-assets.doc.mjs +2 -2
- package/assets/docs/tree/template-doc-overview.doc.mjs +6 -17
- package/assets/docs/tree/template-fonts.doc.mjs +1 -1
- package/assets/docs/tree/template-icons.doc.mjs +1 -1
- package/assets/docs/tree/template-images-media.doc.mjs +1 -1
- package/assets/docs/tree/template-styles.doc.mjs +2 -2
- package/assets/docs/tree/templates.doc.mjs +7 -1
- package/assets/docs/tree/test-in-an-app.doc.mjs +7 -7
- package/assets/docs/tree/test-template-in-app.doc.mjs +5 -5
- package/assets/docs/tree/themes.doc.mjs +4 -0
- package/assets/docs/tree/tokens-and-setup.doc.mjs +19 -15
- package/assets/docs/tree/troubleshooting.doc.mjs +29 -13
- package/assets/docs/tree/type-scale.doc.mjs +3 -3
- package/assets/docs/tree/uninstall.doc.mjs +109 -0
- package/assets/docs/tree/updates.doc.mjs +92 -0
- package/assets/docs/tree/upgrading.doc.mjs +6 -6
- package/assets/docs/tree/use-a-theme-in-an-app.doc.mjs +14 -2
- package/assets/docs/tree/verify-packed-template.doc.mjs +3 -3
- package/assets/docs/tree/versioning.doc.mjs +10 -9
- package/assets/docs/tree/who-answers.doc.mjs +119 -0
- package/assets/docs/tree/write-the-template-file.doc.mjs +7 -6
- package/assets/docs/use-a-theme.doc.mjs +2 -2
- package/assets/docs/working-with-ai.doc.mjs +66 -13
- package/assets/theme.template.ts +1 -1
- package/authoring/codemod/codemod.doc.mjs +7 -3
- package/authoring/config/config.doc.mjs +9 -6
- package/authoring/config/type.ts +4 -2
- package/authoring/debug/parse.d.mts +5 -5
- package/authoring/discover/discover.doc.mjs +7 -1
- package/authoring/doctypes/_schema.d.mts +8 -3
- package/authoring/doctypes/_schema.mjs +1 -0
- package/authoring/doctypes/base/graph-fields.doc.mjs +6 -4
- package/authoring/doctypes/command/command.doc.mjs +20 -12
- package/authoring/doctypes/command/type.ts +14 -0
- package/authoring/doctypes/component/component.doc.mjs +30 -27
- package/authoring/doctypes/component/type.ts +21 -8
- package/authoring/doctypes/enum/enum.doc.mjs +7 -4
- package/authoring/doctypes/function/function.doc.mjs +9 -8
- package/authoring/doctypes/hook/hook.doc.mjs +5 -4
- package/authoring/doctypes/hook/type.ts +4 -0
- package/authoring/doctypes/namespace/namespace.doc.mjs +7 -6
- package/authoring/doctypes/reference/reference.doc.mjs +12 -11
- package/authoring/doctypes/schema/schema.doc.mjs +9 -9
- 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 +3 -3
- package/authoring/doctypes/template/type.ts +22 -0
- package/authoring/doctypes/theme/theme.doc.mjs +2 -2
- package/authoring/gap-report/gap-report.doc.mjs +2 -2
- package/authoring/identity/identity.doc.mjs +3 -3
- package/authoring/index.d.ts +2 -0
- package/authoring/integration/integration.doc.mjs +30 -6
- package/authoring/integration/parse.test.mjs +21 -0
- package/authoring/integration/schema.d.mts +16 -3
- package/authoring/integration/schema.mjs +34 -2
- package/authoring/integration/type.ts +12 -0
- package/clients/cli/bin/astryx.mjs +20 -3
- package/clients/cli/cli-command.test.mjs +166 -0
- package/clients/cli/commands/blog.doc.mjs +1 -0
- package/clients/cli/commands/build-theme.batch-report.test.mjs +17 -3
- package/clients/cli/commands/build-theme.font-warning.test.mjs +3 -3
- package/clients/cli/commands/build-theme.mjs +26 -13
- package/clients/cli/commands/build-theme.path-safety.test.mjs +224 -6
- package/clients/cli/commands/build-theme.registry.test.mjs +5 -2
- package/clients/cli/commands/build.doc.mjs +1 -0
- package/clients/cli/commands/build.exit-codes-doc.test.mjs +4 -0
- package/clients/cli/commands/cli-postinstall.test.mjs +49 -1
- package/clients/cli/commands/component.doc.mjs +1 -0
- package/clients/cli/commands/discover.broken-integration.test.mjs +11 -7
- package/clients/cli/commands/discover.doc.mjs +9 -1
- package/clients/cli/commands/discover.mjs +144 -93
- package/clients/cli/commands/discover.no-source.test.mjs +448 -33
- package/clients/cli/commands/discover.sources.test.mjs +20 -1
- package/clients/cli/commands/docs.doc.mjs +1 -0
- package/clients/cli/commands/docs.mjs +49 -19
- package/clients/cli/commands/docs.test.mjs +2 -2
- package/clients/cli/commands/doctor-integration-components.doc.mjs +19 -4
- package/clients/cli/commands/doctor-integration-docs.doc.mjs +20 -5
- package/clients/cli/commands/doctor-integration-templates.doc.mjs +1 -0
- package/clients/cli/commands/doctor-integration-validate.doc.mjs +22 -2
- package/clients/cli/commands/doctor-integration.test.mjs +888 -3
- package/clients/cli/commands/doctor.doc.mjs +12 -2
- package/clients/cli/commands/doctor.mjs +292 -7
- package/clients/cli/commands/doctor.test.mjs +10 -4
- package/clients/cli/commands/gap-report.doc.mjs +15 -2
- package/clients/cli/commands/gap-report.mjs +24 -2
- package/clients/cli/commands/gap-report.test.mjs +79 -0
- package/clients/cli/commands/hook.doc.mjs +1 -0
- package/clients/cli/commands/init.behavior.test.mjs +5 -0
- package/clients/cli/commands/init.doc.mjs +29 -3
- package/clients/cli/commands/integration-add.doc.mjs +7 -0
- package/clients/cli/commands/integration-authoring.test.mjs +49 -3
- package/clients/cli/commands/integration-check.doc.mjs +93 -0
- package/clients/cli/commands/integration-check.test.mjs +441 -0
- package/clients/cli/commands/integration-pack.doc.mjs +8 -1
- package/clients/cli/commands/integration-verify.doc.mjs +8 -1
- package/clients/cli/commands/integration.doc.mjs +6 -2
- package/clients/cli/commands/integration.mjs +119 -7
- package/clients/cli/commands/json-contract.test.mjs +11 -2
- package/clients/cli/commands/manifest.doc.mjs +1 -0
- package/clients/cli/commands/outside-project.test.mjs +774 -0
- package/clients/cli/commands/search.doc.mjs +1 -0
- package/clients/cli/commands/search.mjs +16 -11
- package/clients/cli/commands/search.test.mjs +429 -296
- package/clients/cli/commands/setup-nudge.test.mjs +102 -2
- package/clients/cli/commands/swizzle.doc.mjs +7 -0
- package/clients/cli/commands/swizzle.mjs +5 -3
- package/clients/cli/commands/swizzle.routing.test.mjs +19 -2
- package/clients/cli/commands/template.doc.mjs +1 -0
- package/clients/cli/commands/text-json-parity.test.mjs +5 -0
- package/clients/cli/commands/theme-add-lifecycle.test.mjs +3 -3
- package/clients/cli/commands/theme-add.doc.mjs +8 -1
- package/clients/cli/commands/theme-build.doc.mjs +3 -2
- package/clients/cli/commands/theme-eject.doc.mjs +1 -0
- package/clients/cli/commands/theme-list.behavior.test.mjs +6 -0
- package/clients/cli/commands/theme-list.doc.mjs +1 -0
- package/clients/cli/commands/theme-palette-generate.doc.mjs +1 -0
- package/clients/cli/commands/theme-remove.doc.mjs +7 -0
- package/clients/cli/commands/theme-targets.doc.mjs +1 -0
- package/clients/cli/commands/theme-template.doc.mjs +1 -0
- package/clients/cli/commands/theme-use.doc.mjs +7 -0
- package/clients/cli/commands/upgrade.config-ordering.test.mjs +2 -1
- package/clients/cli/commands/upgrade.doc.mjs +22 -1
- package/clients/cli/commands/upgrade.file-protection.test.mjs +3 -2
- package/clients/cli/commands/upgrade.hook-output.test.mjs +2 -1
- package/clients/cli/commands/upgrade.older-cli.test.mjs +160 -0
- package/clients/cli/index.mjs +112 -16
- package/clients/cli/lib/cli-error.mjs +4 -1
- package/clients/cli/lib/component-format.test.mjs +1 -1
- package/clients/cli/lib/define-command.mjs +2 -2
- package/clients/cli/lib/json-shim.mjs +3 -1
- package/clients/cli/lib/manifest.d.ts +9 -0
- package/clients/cli/lib/manifest.mjs +17 -1
- package/clients/cli/lib/manifest.test.mjs +25 -0
- package/foundation/agent-docs/agent-doc-state.d.mts +35 -6
- package/foundation/agent-docs/agent-doc-state.mjs +66 -6
- package/foundation/agent-docs/agent-docs.d.mts +4 -3
- package/foundation/agent-docs/agent-docs.mjs +11 -9
- package/foundation/agent-docs/computer-agent-text.d.mts +133 -0
- package/foundation/agent-docs/computer-agent-text.mjs +623 -0
- package/foundation/agent-docs/computer-agent-text.test.mjs +602 -0
- package/foundation/config/project.d.mts +35 -3
- package/foundation/config/project.mjs +226 -7
- package/foundation/config/project.test.mjs +66 -0
- package/foundation/config/theme-state.mjs +5 -4
- package/foundation/discovery/authoring-self-docs.mjs +2 -1
- package/foundation/discovery/cli-self-docs.mjs +20 -3
- package/foundation/discovery/cli-self-docs.test.mjs +3 -2
- package/foundation/discovery/component-discovery.d.mts +190 -10
- package/foundation/discovery/component-discovery.export-names.test.mjs +760 -0
- package/foundation/discovery/component-discovery.mjs +864 -56
- package/foundation/discovery/component-discovery.test.mjs +96 -0
- package/foundation/discovery/component-replacement.mjs +20 -1
- package/foundation/discovery/component-replacement.test.mjs +40 -0
- package/foundation/discovery/copied-passages.d.mts +216 -0
- package/foundation/discovery/copied-passages.mjs +720 -0
- package/foundation/discovery/copied-passages.test.mjs +124 -0
- package/foundation/discovery/doc-consistency.d.mts +34 -0
- package/foundation/discovery/doc-consistency.mjs +513 -0
- package/foundation/discovery/doc-consistency.test.mjs +347 -0
- package/foundation/discovery/doc-fluff.d.mts +112 -0
- package/foundation/discovery/doc-fluff.mjs +328 -0
- package/foundation/discovery/doc-fluff.test.mjs +142 -0
- package/foundation/discovery/doc-types.d.mts +157 -0
- package/foundation/discovery/doc-types.mjs +1231 -0
- package/foundation/discovery/doc-types.test.mjs +744 -0
- package/foundation/discovery/docs-discovery.d.mts +88 -0
- package/foundation/discovery/docs-discovery.mjs +83 -2
- 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 +27 -0
- package/foundation/discovery/module-exports.mjs +356 -31
- package/foundation/discovery/module-exports.test.mjs +172 -0
- 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 +32 -0
- package/foundation/discovery/project-typescript.mjs +89 -0
- package/foundation/discovery/prop-drift.d.mts +297 -0
- package/foundation/discovery/prop-drift.mjs +2428 -0
- package/foundation/discovery/prop-drift.test.mjs +2337 -0
- package/foundation/discovery/runner-allowlist.d.mts +40 -0
- package/foundation/discovery/runner-allowlist.mjs +53 -0
- package/foundation/discovery/stray-pointers.d.mts +52 -0
- package/foundation/discovery/stray-pointers.mjs +293 -0
- package/foundation/discovery/stray-pointers.test.mjs +86 -0
- package/foundation/discovery/template-adapter.mjs +74 -5
- package/foundation/discovery/template-needs.mjs +5 -2
- package/foundation/discovery/theme-imports.mjs +8 -4
- package/foundation/discovery/theme-imports.test.mjs +1 -1
- 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 +51 -1
- package/foundation/doc-compiler/inputs.mjs +27 -1
- package/foundation/doc-compiler/inputs.test.mjs +0 -1
- package/foundation/doc-compiler/links.d.mts +41 -5
- package/foundation/doc-compiler/links.mjs +167 -28
- package/foundation/doc-compiler/links.test.mjs +97 -4
- package/foundation/doc-compiler/read.d.mts +1 -1
- package/foundation/doc-compiler/tree.mjs +30 -1
- package/foundation/doc-compiler/tree.test.mjs +8 -1
- package/foundation/env/cli-command.d.mts +83 -0
- package/foundation/env/cli-command.mjs +152 -0
- package/foundation/env/cli-command.test.mjs +129 -0
- package/foundation/env/node-version.test.mjs +15 -3
- package/foundation/env/package-manager.d.mts +93 -9
- package/foundation/env/package-manager.global.test.mjs +66 -0
- package/foundation/env/package-manager.mjs +184 -13
- package/foundation/env/package-manager.test.mjs +341 -15
- package/foundation/env/project-scope.d.mts +9 -0
- package/foundation/env/project-scope.mjs +33 -0
- package/foundation/env/search-path.d.mts +42 -0
- package/foundation/env/search-path.mjs +205 -0
- package/foundation/env/search-path.test.mjs +122 -0
- package/foundation/env/user-dirs.d.mts +39 -0
- package/foundation/env/user-dirs.mjs +93 -0
- package/foundation/env/user-dirs.test.mjs +72 -0
- package/foundation/env/user-settings.d.mts +46 -0
- package/foundation/env/user-settings.mjs +106 -0
- package/foundation/env/user-settings.test.mjs +64 -0
- package/foundation/fs/file-protection.mjs +15 -1
- package/foundation/fs/module-loader.d.mts +2 -1
- package/foundation/fs/module-loader.mjs +60 -4
- package/foundation/fs/module-loader.stdout.test.mjs +3 -2
- package/foundation/fs/module-loader.test.mjs +194 -0
- package/foundation/fs/path-compare.d.mts +33 -0
- package/foundation/fs/path-compare.mjs +73 -0
- package/foundation/fs/paths.d.mts +57 -1
- package/foundation/fs/paths.mjs +131 -3
- package/foundation/fs/paths.test.mjs +10 -1
- package/foundation/integrations/computer-integrations.d.mts +78 -0
- package/foundation/integrations/computer-integrations.mjs +316 -0
- package/foundation/integrations/computer-integrations.test.mjs +292 -0
- package/foundation/integrations/contribution-inventory.d.mts +11 -0
- package/foundation/integrations/contribution-inventory.mjs +56 -3
- package/foundation/integrations/integration-warnings.mjs +3 -2
- package/foundation/integrations/integration-warnings.test.mjs +8 -9
- package/foundation/integrations/integrations.d.mts +25 -1
- package/foundation/integrations/integrations.mjs +46 -3
- package/foundation/integrations/issue.ts +6 -0
- package/foundation/integrations/validate-contributions.d.mts +2 -0
- package/foundation/integrations/validate-contributions.mjs +41 -1
- package/foundation/release/agent-text-worker.d.mts +4 -0
- package/foundation/release/agent-text-worker.mjs +52 -0
- package/foundation/release/cache.d.mts +310 -0
- package/foundation/release/cache.mjs +1216 -0
- package/foundation/release/cache.test.mjs +920 -0
- package/foundation/release/choose.d.mts +207 -0
- package/foundation/release/choose.mjs +677 -0
- package/foundation/release/choose.test.mjs +427 -0
- package/foundation/release/core-worker.d.mts +4 -0
- package/foundation/release/core-worker.mjs +38 -0
- package/foundation/release/global-state.d.mts +259 -0
- package/foundation/release/global-state.mjs +472 -0
- package/foundation/release/global-state.test.mjs +381 -0
- package/foundation/release/handoff.d.mts +60 -0
- package/foundation/release/handoff.e2e.test.mjs +278 -0
- package/foundation/release/handoff.mjs +357 -0
- package/foundation/release/lock-lease.d.mts +23 -0
- package/foundation/release/lock-lease.mjs +80 -0
- package/foundation/release/notices.d.mts +253 -0
- package/foundation/release/notices.mjs +596 -0
- package/foundation/release/notices.test.mjs +565 -0
- package/foundation/release/npm-guard.d.mts +4 -0
- package/foundation/release/npm-guard.mjs +126 -0
- package/foundation/release/project.d.mts +141 -0
- package/foundation/release/project.mjs +466 -0
- package/foundation/release/project.test.mjs +288 -0
- package/foundation/release/refresh-worker.d.mts +4 -0
- package/foundation/release/refresh-worker.mjs +27 -0
- package/foundation/release/run-context.d.mts +47 -0
- package/foundation/release/run-context.mjs +149 -0
- package/foundation/release/update-notice-env.d.mts +28 -0
- package/foundation/release/update-notice-env.mjs +39 -0
- package/foundation/response/base.d.ts +26 -3
- package/foundation/response/error-codes.d.mts +3 -1
- package/foundation/response/error-codes.doc.mjs +12 -0
- package/foundation/response/error-codes.mjs +17 -0
- package/foundation/response/error-codes.test.mjs +2 -0
- package/foundation/response/json-contract.test.mjs +7 -2
- package/foundation/response/json.mjs +4 -1
- package/foundation/response/response-types.doc.mjs +22 -11
- package/foundation/response/response-types.doc.test.mjs +46 -0
- package/foundation/response/response.doc.mjs +3 -3
- package/foundation/xle/browser-imports.test.mjs +74 -0
- package/foundation/xle/registry.mjs +4 -0
- package/foundation/xle/registry.test.mjs +28 -0
- package/package.json +11 -11
- package/scripts/postinstall.mjs +24 -5
|
@@ -0,0 +1,367 @@
|
|
|
1
|
+
{
|
|
2
|
+
"packages": [
|
|
3
|
+
{
|
|
4
|
+
"package": "@astryxdesign/charts",
|
|
5
|
+
"description": "Astryx charts — a config-model data visualization library (d3-based). Published to npm only under the @canary dist-tag for early testing; never released as a stable (latest) version.",
|
|
6
|
+
"canaryOnly": true,
|
|
7
|
+
"contributions": [
|
|
8
|
+
{
|
|
9
|
+
"kind": "component",
|
|
10
|
+
"name": "Chart"
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"kind": "component",
|
|
14
|
+
"name": "ChartAxis"
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
"kind": "component",
|
|
18
|
+
"name": "ChartGrid"
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "component",
|
|
22
|
+
"name": "ChartLegend"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"kind": "component",
|
|
26
|
+
"name": "ChartSwatch"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"kind": "component",
|
|
30
|
+
"name": "ChartTooltip"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"kind": "template",
|
|
34
|
+
"name": "ChartShowcase"
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"kind": "template",
|
|
38
|
+
"name": "ChartTrendComparison"
|
|
39
|
+
}
|
|
40
|
+
]
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"package": "@astryxdesign/lab",
|
|
44
|
+
"description": "Experimental Astryx components — published to npm only under the @canary dist-tag for early testing; never released as a stable (latest) version.",
|
|
45
|
+
"canaryOnly": true,
|
|
46
|
+
"contributions": [
|
|
47
|
+
{
|
|
48
|
+
"kind": "component",
|
|
49
|
+
"name": "ChartArea"
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"kind": "component",
|
|
53
|
+
"name": "ChartBar"
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"kind": "component",
|
|
57
|
+
"name": "ChartCandlestick"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"kind": "component",
|
|
61
|
+
"name": "ChartDot"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"kind": "component",
|
|
65
|
+
"name": "ChartDotGL"
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"kind": "component",
|
|
69
|
+
"name": "ChartDotGLInteractive"
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"kind": "component",
|
|
73
|
+
"name": "ChartHeatmapGL"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"kind": "component",
|
|
77
|
+
"name": "ChartLine"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"kind": "component",
|
|
81
|
+
"name": "ChartStreamGL"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"kind": "component",
|
|
85
|
+
"name": "ChatEmojiPicker"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"kind": "component",
|
|
89
|
+
"name": "ChatReactionBar"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"kind": "component",
|
|
93
|
+
"name": "ChatReasoning"
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"kind": "component",
|
|
97
|
+
"name": "ChatTypingIndicator"
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"kind": "component",
|
|
101
|
+
"name": "ChatUnreadDivider"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"kind": "component",
|
|
105
|
+
"name": "CircularProgress"
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"kind": "component",
|
|
109
|
+
"name": "CodeEditor"
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"kind": "component",
|
|
113
|
+
"name": "CommentComposer"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"kind": "component",
|
|
117
|
+
"name": "CommentPin"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"kind": "component",
|
|
121
|
+
"name": "Comments"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"kind": "component",
|
|
125
|
+
"name": "CommentThread"
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"kind": "component",
|
|
129
|
+
"name": "DiffViewer"
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"kind": "component",
|
|
133
|
+
"name": "EmojiPicker"
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"kind": "component",
|
|
137
|
+
"name": "InfoTip"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"kind": "component",
|
|
141
|
+
"name": "ListInput"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"kind": "component",
|
|
145
|
+
"name": "LogStream"
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"kind": "component",
|
|
149
|
+
"name": "MobileTokenizer"
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
"kind": "component",
|
|
153
|
+
"name": "RadialChart"
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"kind": "component",
|
|
157
|
+
"name": "SankeyChart"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"kind": "component",
|
|
161
|
+
"name": "Schedule"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"kind": "component",
|
|
165
|
+
"name": "Stat"
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"kind": "component",
|
|
169
|
+
"name": "SVGIcon"
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"kind": "component",
|
|
173
|
+
"name": "ThreeDBar"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"kind": "component",
|
|
177
|
+
"name": "ThreeDChart"
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
"kind": "component",
|
|
181
|
+
"name": "ThreeDScatter"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"kind": "component",
|
|
185
|
+
"name": "ThreeDScatterGL"
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"kind": "component",
|
|
189
|
+
"name": "ThreeDSurface"
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"kind": "component",
|
|
193
|
+
"name": "Tour"
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"kind": "component",
|
|
197
|
+
"name": "TourStep"
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"kind": "component",
|
|
201
|
+
"name": "TransferList"
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
"kind": "template",
|
|
205
|
+
"name": "CommentComposerShowcase"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"kind": "template",
|
|
209
|
+
"name": "CommentPinInMargin"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"kind": "template",
|
|
213
|
+
"name": "CommentPinShowcase"
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"kind": "template",
|
|
217
|
+
"name": "CommentsInCard"
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"kind": "template",
|
|
221
|
+
"name": "CommentsInline"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"kind": "template",
|
|
225
|
+
"name": "CommentsShowcase"
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"kind": "template",
|
|
229
|
+
"name": "CommentThreadInPopover"
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
"kind": "template",
|
|
233
|
+
"name": "CommentThreadShowcase"
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"kind": "template",
|
|
237
|
+
"name": "DiffViewerShowcase"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"kind": "template",
|
|
241
|
+
"name": "EmojiPickerInPopover"
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"kind": "template",
|
|
245
|
+
"name": "EmojiPickerShowcase"
|
|
246
|
+
}
|
|
247
|
+
]
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"package": "@astryxdesign/richtext",
|
|
251
|
+
"description": "Astryx rich text — a Lexical-based rich text editor and viewer, styled with Astryx design tokens.",
|
|
252
|
+
"releasedWithCore": true,
|
|
253
|
+
"contributions": [
|
|
254
|
+
{
|
|
255
|
+
"kind": "component",
|
|
256
|
+
"name": "RichTextEditor"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"kind": "template",
|
|
260
|
+
"name": "RichTextEditorShowcase"
|
|
261
|
+
}
|
|
262
|
+
]
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"package": "@astryxdesign/theme-butter",
|
|
266
|
+
"description": "Warm, creamy yellows with a friendly blue accent. Playful enough for consumer surfaces, soft enough to stay readable.",
|
|
267
|
+
"releasedWithCore": true,
|
|
268
|
+
"contributions": [
|
|
269
|
+
{
|
|
270
|
+
"kind": "theme",
|
|
271
|
+
"name": "butter",
|
|
272
|
+
"title": "Butter",
|
|
273
|
+
"summary": "Warm, creamy yellows with a friendly blue accent. Playful enough for consumer surfaces, soft enough to stay readable."
|
|
274
|
+
}
|
|
275
|
+
]
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"package": "@astryxdesign/theme-chocolate",
|
|
279
|
+
"description": "Warm chocolate theme for Astryx — rich brown palette with Fraunces headings, Albert Sans body, and Lucide icons",
|
|
280
|
+
"releasedWithCore": true,
|
|
281
|
+
"contributions": [
|
|
282
|
+
{
|
|
283
|
+
"kind": "theme",
|
|
284
|
+
"name": "chocolate",
|
|
285
|
+
"title": "Chocolate",
|
|
286
|
+
"summary": "Warm chocolate theme for Astryx — rich brown palette with Fraunces headings, Albert Sans body, and Lucide icons"
|
|
287
|
+
}
|
|
288
|
+
]
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
"package": "@astryxdesign/theme-gothic",
|
|
292
|
+
"description": "Deep blue-grays and a signature display serif. Dramatic and editorial, for surfaces that want to be remembered.",
|
|
293
|
+
"releasedWithCore": true,
|
|
294
|
+
"contributions": [
|
|
295
|
+
{
|
|
296
|
+
"kind": "theme",
|
|
297
|
+
"name": "gothic",
|
|
298
|
+
"title": "Gothic",
|
|
299
|
+
"summary": "Deep blue-grays and a signature display serif. Dramatic and editorial, for surfaces that want to be remembered."
|
|
300
|
+
}
|
|
301
|
+
]
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"package": "@astryxdesign/theme-matcha",
|
|
305
|
+
"description": "Earthy greens with a calm, organic feel. Naturalistic and grounded, great for wellness or content-first apps.",
|
|
306
|
+
"releasedWithCore": true,
|
|
307
|
+
"contributions": [
|
|
308
|
+
{
|
|
309
|
+
"kind": "theme",
|
|
310
|
+
"name": "matcha",
|
|
311
|
+
"title": "Matcha",
|
|
312
|
+
"summary": "Earthy greens with a calm, organic feel. Naturalistic and grounded, great for wellness or content-first apps."
|
|
313
|
+
}
|
|
314
|
+
]
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"package": "@astryxdesign/theme-neutral",
|
|
318
|
+
"description": "Restrained warm grays. Minimal and quiet, so the content stays the focus.",
|
|
319
|
+
"releasedWithCore": true,
|
|
320
|
+
"contributions": [
|
|
321
|
+
{
|
|
322
|
+
"kind": "theme",
|
|
323
|
+
"name": "neutral",
|
|
324
|
+
"title": "Neutral",
|
|
325
|
+
"summary": "Restrained warm grays. Minimal and quiet, so the content stays the focus."
|
|
326
|
+
}
|
|
327
|
+
]
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"package": "@astryxdesign/theme-stone",
|
|
331
|
+
"description": "Warm stone and slate, earthy and understated, with just enough character to feel handcrafted.",
|
|
332
|
+
"releasedWithCore": true,
|
|
333
|
+
"contributions": [
|
|
334
|
+
{
|
|
335
|
+
"kind": "theme",
|
|
336
|
+
"name": "stone",
|
|
337
|
+
"title": "Stone",
|
|
338
|
+
"summary": "Warm stone and slate, earthy and understated, with just enough character to feel handcrafted."
|
|
339
|
+
}
|
|
340
|
+
]
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"package": "@astryxdesign/theme-y2k",
|
|
344
|
+
"description": "Hot pinks, lime greens, and Poppins. Bubbly, playful, and unmistakably retro.",
|
|
345
|
+
"releasedWithCore": true,
|
|
346
|
+
"contributions": [
|
|
347
|
+
{
|
|
348
|
+
"kind": "theme",
|
|
349
|
+
"name": "y2k",
|
|
350
|
+
"title": "Y2K",
|
|
351
|
+
"summary": "Hot pinks, lime greens, and Poppins. Bubbly, playful, and unmistakably retro."
|
|
352
|
+
}
|
|
353
|
+
]
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"package": "@astryxdesign/vega",
|
|
357
|
+
"description": "Astryx Vega wrapper — chart and data visualization components. Published to npm only under the @canary dist-tag for early testing; never released as a stable (latest) version.",
|
|
358
|
+
"canaryOnly": true,
|
|
359
|
+
"contributions": [
|
|
360
|
+
{
|
|
361
|
+
"kind": "component",
|
|
362
|
+
"name": "VegaChart"
|
|
363
|
+
}
|
|
364
|
+
]
|
|
365
|
+
}
|
|
366
|
+
]
|
|
367
|
+
}
|
package/assets/docs/README.md
CHANGED
|
@@ -51,6 +51,16 @@ The material is usually good; the finding is placement, not quality. It goes in
|
|
|
51
51
|
|
|
52
52
|
Worked example: a responsive-and-interaction readiness rubric is grading criteria → **Component-Audit-Rubric**, or **Component-Lifecycle** if it is a promotion gate.
|
|
53
53
|
|
|
54
|
+
## Imports in code samples
|
|
55
|
+
|
|
56
|
+
Import each Core export from the path `astryx component <Name>` prints: the
|
|
57
|
+
component's own entry when Core has one (`@astryxdesign/core/VStack`,
|
|
58
|
+
`@astryxdesign/core/Heading`), and `@astryxdesign/core/theme` for `Theme`,
|
|
59
|
+
`defineTheme` and the rest of the theme API. A reader copies one sample and then
|
|
60
|
+
reads `astryx component`, and two paths for one export read as two different
|
|
61
|
+
things. The no-build CDN page is the exception: its import map names only the
|
|
62
|
+
package root.
|
|
63
|
+
|
|
54
64
|
## Sections are read one at a time
|
|
55
65
|
|
|
56
66
|
`astryx docs <topic> --index` lists a topic's sections, and readers then open
|
|
@@ -17,14 +17,14 @@ export const docs = {
|
|
|
17
17
|
{type: 'prose', text: "Use an installed built theme as the base for ordinary customization. Import it into your source and pass it as `extends` to `defineTheme({extends: importedTheme, ...})`. Build the result, then add the local slug. Only eject when you need to own and maintain a full source fork."},
|
|
18
18
|
{type: 'code', lang: 'bash', label: 'Add to use, eject to fork', code: 'astryx theme list\nastryx theme add stone\nastryx theme eject stone\nastryx theme build src/themes/stone/stoneTheme.ts\nastryx theme add stone'},
|
|
19
19
|
{type: 'prose', text: "For an annotated map of the whole surface (every defineTheme field, the token families, and the component override syntax, each with the CLI command that prints its reference), run `astryx theme template`. It writes `theme.template.ts` into your project to read and copy from (`astryx init --features theme` writes it as part of project setup)."},
|
|
20
|
-
{type: 'prose', text: 'To apply a theme you created, see {@link generic:use-a-theme}. To generate colors from seed values, see the Palette section below.
|
|
20
|
+
{type: 'prose', text: 'To apply a theme you created, see {@link generic:use-a-theme}. To generate colors from seed values, see the Palette section below. Before you eject a package theme instead, see when that fits in {@link generic:use-a-theme}.'},
|
|
21
21
|
],
|
|
22
22
|
},
|
|
23
23
|
{
|
|
24
24
|
id: 'palette',
|
|
25
25
|
title: 'Generate a palette',
|
|
26
26
|
content: [
|
|
27
|
-
{type: 'prose', text: '
|
|
27
|
+
{type: 'prose', text: 'Name a few seed colors and generate every shade a theme needs, light and dark; {@link generic:generate-a-palette} explains what a palette holds.'},
|
|
28
28
|
{type: 'code', lang: 'json', label: 'Minimal palette config (palette.config.json)', code: '{"families": [{"id": "ocean", "seed": "#0074e2"}]}'},
|
|
29
29
|
{type: 'code', lang: 'bash', label: 'Generate and preview', code: '# Print the palette without writing files\nastryx theme palette generate palette.config.json\n\n# Write palette + receipt, and open a visual preview\nastryx theme palette generate palette.config.json \\\n --out src/themes/ocean/tokens/ocean.palette.ts \\\n --preview preview.html'},
|
|
30
30
|
{type: 'prose', text: "The command writes a `.ts` file exporting 21 shades (stops 0–100) for both light and dark, plus a `.receipt.json` to regenerate later. Point your theme's tokens at the palette, then run defineTheme (see below)."},
|
|
@@ -120,7 +120,7 @@ export const docs = {
|
|
|
120
120
|
['ocean.variants.d.ts', "(Optional) Module augmentations for custom component prop values"],
|
|
121
121
|
]},
|
|
122
122
|
{type: 'prose', text: 'The `__built: true` flag tells Theme to skip runtime `<style>` injection; the CSS file handles it. Load the generated CSS wherever you load the module.'},
|
|
123
|
-
{type: 'code', lang: 'tsx', label: 'Using a custom built theme', code: "import {Theme} from '@astryxdesign/core';\nimport {oceanTheme} from './themes/ocean';\nimport './themes/ocean.css';\n\n<Theme theme={oceanTheme}>\n <App />\n</Theme>"},
|
|
123
|
+
{type: 'code', lang: 'tsx', label: 'Using a custom built theme', code: "import {Theme} from '@astryxdesign/core/theme';\nimport {oceanTheme} from './themes/ocean';\nimport './themes/ocean.css';\n\n<Theme theme={oceanTheme}>\n <App />\n</Theme>"},
|
|
124
124
|
{type: 'prose', text: "After upgrading Astryx, rerun `astryx theme build` for every custom prebuilt theme. Deploy the regenerated files together. The runtime intentionally trusts `__built: true` and will not repair stale CSS from an older build. The build also warns when the theme names font families it does not load. See {@link generic:font-setup} for the full recipe."},
|
|
125
125
|
{type: 'prose', text: 'For the runtime vs built tradeoff, see the Runtime vs Built section of {@link generic:use-a-theme}.'},
|
|
126
126
|
],
|
|
@@ -149,7 +149,7 @@ export const docs = {
|
|
|
149
149
|
type: 'list',
|
|
150
150
|
style: 'ordered',
|
|
151
151
|
items: [
|
|
152
|
-
'Polyfill anchor positioning. Load a CSS anchor positioning polyfill conditionally behind an `@supports` check so it costs nothing on Tier 1. This is the lowest-effort way to get correct positioning;
|
|
152
|
+
'Polyfill anchor positioning. Load a CSS anchor positioning polyfill conditionally behind an `@supports` check so it costs nothing on Tier 1. This is the lowest-effort way to get correct positioning; polyfills may not cover every position-fallback feature.',
|
|
153
153
|
'Provide a JS positioning fallback. Detect missing support with `CSS.supports("anchor-name", "--x")` and position layers with a measurement-based library (e.g. a floating-element positioner) when it returns false. More code, full control.',
|
|
154
154
|
'Accept degraded positioning. Document for your users that on Tier 2 browsers, layered surfaces open correctly but may not sit next to their trigger. Cheapest, and often fine for internal tools on evergreen browsers.',
|
|
155
155
|
],
|
|
@@ -21,7 +21,7 @@ export const docs = {
|
|
|
21
21
|
type: 'code',
|
|
22
22
|
lang: 'text',
|
|
23
23
|
label: 'Set up the design system',
|
|
24
|
-
code: 'Install @astryxdesign/core, @stylexjs/stylex, @astryxdesign/theme-neutral, and @astryxdesign/cli in this project, then run `
|
|
24
|
+
code: 'Install @astryxdesign/core, @stylexjs/stylex, @astryxdesign/theme-neutral, and @astryxdesign/cli in this project, then run `astryx init` to set up agent docs. Read the generated files to learn the conventions.',
|
|
25
25
|
},
|
|
26
26
|
{
|
|
27
27
|
type: 'prose',
|
|
@@ -31,7 +31,7 @@ export const docs = {
|
|
|
31
31
|
type: 'code',
|
|
32
32
|
lang: 'text',
|
|
33
33
|
label: 'Give it a look',
|
|
34
|
-
code: 'Ask me what look and feel this app should have. Run `
|
|
34
|
+
code: 'Ask me what look and feel this app should have. Run `astryx theme list`, install the closest theme package, and run `theme add <slug>`; use `--package` when owners share a slug. Import `themes` and `defaultThemeSlug` from the generated module once and pass `themes[defaultThemeSlug]` to `<Theme>`. Customize with `defineTheme({extends: importedTheme, ...})`. Use `theme eject` only when I ask for an independent source fork. Default to neutral if I have no preference, and show me the result before moving on.',
|
|
35
35
|
},
|
|
36
36
|
],
|
|
37
37
|
},
|
|
@@ -60,7 +60,27 @@ export const docs = {
|
|
|
60
60
|
type: 'code',
|
|
61
61
|
lang: 'bash',
|
|
62
62
|
label: 'Terminal',
|
|
63
|
-
code: `
|
|
63
|
+
code: `astryx init`,
|
|
64
|
+
},
|
|
65
|
+
],
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
id: 'install-once',
|
|
69
|
+
title: 'Install once, use everywhere',
|
|
70
|
+
content: [
|
|
71
|
+
{
|
|
72
|
+
type: 'prose',
|
|
73
|
+
text: "Install the CLI once for your computer too, and the astryx command works in any folder, for you and for any coding agent, even before a project exists. Inside a project, the project's own version still answers, so a global install never changes what your team and CI get. Keep it in the project as well; that is the recommended setup.",
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
type: 'code',
|
|
77
|
+
lang: 'bash',
|
|
78
|
+
label: 'Terminal',
|
|
79
|
+
code: `npm i -g @astryxdesign/cli`,
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
type: 'prose',
|
|
83
|
+
text: 'Project, global, or both: {@link generic:project-global-or-both}. Everything else about global mode: {@link namespace:global}.',
|
|
64
84
|
},
|
|
65
85
|
],
|
|
66
86
|
},
|
|
@@ -86,7 +106,7 @@ export const docs = {
|
|
|
86
106
|
type: 'code',
|
|
87
107
|
lang: 'tsx',
|
|
88
108
|
label: 'App root',
|
|
89
|
-
code: `import {Theme} from '@astryxdesign/core';
|
|
109
|
+
code: `import {Theme} from '@astryxdesign/core/theme';
|
|
90
110
|
import {themes, defaultThemeSlug} from './astryx-themes';
|
|
91
111
|
|
|
92
112
|
<Theme theme={themes[defaultThemeSlug]}><App /></Theme>`,
|
|
@@ -119,14 +139,14 @@ import {themes, defaultThemeSlug} from './astryx-themes';
|
|
|
119
139
|
content: [
|
|
120
140
|
{
|
|
121
141
|
type: 'prose',
|
|
122
|
-
text: '
|
|
142
|
+
text: 'Import each component from its own entry, the path `astryx component <Name>` prints. This keeps bundles small and makes intent clear.',
|
|
123
143
|
},
|
|
124
144
|
{
|
|
125
145
|
type: 'code',
|
|
126
146
|
lang: 'tsx',
|
|
127
147
|
label: 'app/page.tsx',
|
|
128
148
|
code: `import {Button} from '@astryxdesign/core/Button';
|
|
129
|
-
import {VStack} from '@astryxdesign/core/
|
|
149
|
+
import {VStack} from '@astryxdesign/core/VStack';
|
|
130
150
|
|
|
131
151
|
export default function Page() {
|
|
132
152
|
return (
|
|
@@ -158,7 +158,7 @@ export const docs = {
|
|
|
158
158
|
},
|
|
159
159
|
{
|
|
160
160
|
type: 'prose',
|
|
161
|
-
text: 'If a swizzled component
|
|
161
|
+
text: 'If a swizzled component fails at runtime with a `stylex.create` error, the app is missing a StyleX compiler: see the StyleX Build Setup section of {@link generic:tokens-and-setup}.',
|
|
162
162
|
},
|
|
163
163
|
],
|
|
164
164
|
},
|
|
@@ -9,7 +9,7 @@ export const docsDense = {
|
|
|
9
9
|
section: 'Wrap your app in a theme',
|
|
10
10
|
title: 'Quick start',
|
|
11
11
|
content: [
|
|
12
|
-
{type: 'prose', text: "Install a theme, wrap in `<Theme>` (`import {Theme} from '@astryxdesign/core'`). {@link generic:use-a-theme} for full guide."},
|
|
12
|
+
{type: 'prose', text: "Install a theme, wrap in `<Theme>` (`import {Theme} from '@astryxdesign/core/theme'`). {@link generic:use-a-theme} for full guide."},
|
|
13
13
|
],
|
|
14
14
|
},
|
|
15
15
|
{
|
|
@@ -23,7 +23,7 @@ export const docs = {
|
|
|
23
23
|
type: 'code',
|
|
24
24
|
lang: 'tsx',
|
|
25
25
|
label: 'Wire the generated module once',
|
|
26
|
-
code: "import {Theme} from '@astryxdesign/core';\nimport {themes, defaultThemeSlug} from './astryx-themes';\n\nfunction App() {\n return (\n <Theme theme={themes[defaultThemeSlug]}>\n <YourApp />\n </Theme>\n );\n}",
|
|
26
|
+
code: "import {Theme} from '@astryxdesign/core/theme';\nimport {themes, defaultThemeSlug} from './astryx-themes';\n\nfunction App() {\n return (\n <Theme theme={themes[defaultThemeSlug]}>\n <YourApp />\n </Theme>\n );\n}",
|
|
27
27
|
},
|
|
28
28
|
],
|
|
29
29
|
},
|
|
@@ -59,7 +59,7 @@ export const docs = {
|
|
|
59
59
|
content: [
|
|
60
60
|
{
|
|
61
61
|
type: 'prose',
|
|
62
|
-
text:
|
|
62
|
+
text: 'Light, dark, and system modes: {@link generic:use-a-theme}.',
|
|
63
63
|
},
|
|
64
64
|
{
|
|
65
65
|
type: 'code',
|
|
@@ -11,7 +11,7 @@ export const docsZh = {
|
|
|
11
11
|
content: [
|
|
12
12
|
{
|
|
13
13
|
type: 'prose',
|
|
14
|
-
text: "安装主题包,用 `<Theme>`(`import {Theme} from '@astryxdesign/core'`)包裹应用,选择浅色或深色模式。完整指南——可用主题、集成主题、深色模式、嵌套主题和生产构建——请参阅 {@link generic:use-a-theme}。",
|
|
14
|
+
text: "安装主题包,用 `<Theme>`(`import {Theme} from '@astryxdesign/core/theme'`)包裹应用,选择浅色或深色模式。完整指南——可用主题、集成主题、深色模式、嵌套主题和生产构建——请参阅 {@link generic:use-a-theme}。",
|
|
15
15
|
},
|
|
16
16
|
],
|
|
17
17
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @file `astryx docs cli/integrations/components/add-a-component`: choose a
|
|
4
|
+
* @file `astryx docs cli/integrations/building-blocks/components/add-a-component`: choose a
|
|
5
5
|
* component name and generate its first source and doc files.
|
|
6
6
|
*/
|
|
7
7
|
|
|
@@ -45,7 +45,7 @@ export const docs = {
|
|
|
45
45
|
{
|
|
46
46
|
type: 'code',
|
|
47
47
|
lang: 'bash',
|
|
48
|
-
code: '
|
|
48
|
+
code: 'astryx integration add component AcmeCarousel',
|
|
49
49
|
},
|
|
50
50
|
{
|
|
51
51
|
type: 'code',
|
|
@@ -71,5 +71,25 @@ Declare component root ./components in astryx.integration.mjs.
|
|
|
71
71
|
},
|
|
72
72
|
],
|
|
73
73
|
},
|
|
74
|
+
{
|
|
75
|
+
id: 'document-an-existing-component',
|
|
76
|
+
title: 'Document a component you already have',
|
|
77
|
+
content: [
|
|
78
|
+
{
|
|
79
|
+
type: 'prose',
|
|
80
|
+
text: "To document a component your package already has, write its doc beside the source file and name the doc after that file, such as `acme-gallery.doc.mjs` beside `acme-gallery.tsx`. Set `name` to the export apps import, such as `name: 'AcmeGallery'`, and keep both files inside the components root that `astryx.integration.mjs` declares. The file does not have to be named after the component; {@link generic:component-imports} shows how apps then find it.",
|
|
81
|
+
},
|
|
82
|
+
],
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
id: 'global-mode',
|
|
86
|
+
title: 'In global mode',
|
|
87
|
+
content: [
|
|
88
|
+
{
|
|
89
|
+
type: 'prose',
|
|
90
|
+
text: "In global mode: when users install your package for their computer, beside the global CLI, your components show up in folders outside any project; inside a project, only if the project installs your package. See {@link namespace:global} and {@link generic:global-integrations}.",
|
|
91
|
+
},
|
|
92
|
+
],
|
|
93
|
+
},
|
|
74
94
|
],
|
|
75
95
|
};
|
|
@@ -26,7 +26,7 @@ export const docs = {
|
|
|
26
26
|
{
|
|
27
27
|
type: 'code',
|
|
28
28
|
lang: 'bash',
|
|
29
|
-
code: '
|
|
29
|
+
code: 'astryx integration add theme ocean',
|
|
30
30
|
},
|
|
31
31
|
{
|
|
32
32
|
type: 'code',
|
|
@@ -44,7 +44,7 @@ Declare theme root ./themes in astryx.integration.mjs.
|
|
|
44
44
|
},
|
|
45
45
|
{
|
|
46
46
|
type: 'prose',
|
|
47
|
-
text:
|
|
47
|
+
text: '`oceanTheme.ts` exports `oceanTheme`, a `defineTheme` source, and `oceanTheme.doc.mjs` is the descriptor that `theme list` reads. The command also declares `./themes/ocean` and `./themes/ocean.css` package exports. Every field is in {@link schema:theme-doc}.',
|
|
48
48
|
},
|
|
49
49
|
{
|
|
50
50
|
type: 'prose',
|
|
@@ -63,7 +63,7 @@ Declare theme root ./themes in astryx.integration.mjs.
|
|
|
63
63
|
{
|
|
64
64
|
type: 'code',
|
|
65
65
|
lang: 'bash',
|
|
66
|
-
code: '
|
|
66
|
+
code: 'astryx integration add theme ocean --from neutral',
|
|
67
67
|
},
|
|
68
68
|
{
|
|
69
69
|
type: 'prose',
|
|
@@ -85,5 +85,15 @@ Declare theme root ./themes in astryx.integration.mjs.
|
|
|
85
85
|
},
|
|
86
86
|
],
|
|
87
87
|
},
|
|
88
|
+
{
|
|
89
|
+
id: 'global-mode',
|
|
90
|
+
title: 'In global mode',
|
|
91
|
+
content: [
|
|
92
|
+
{
|
|
93
|
+
type: 'prose',
|
|
94
|
+
text: 'In global mode: when users install your package for their computer, beside the global CLI, your themes are listed in folders outside any project, where `theme add` lists but writes nothing; inside a project, only if the project installs your package. See {@link namespace:global} and {@link generic:global-integrations}.',
|
|
95
|
+
},
|
|
96
|
+
],
|
|
97
|
+
},
|
|
88
98
|
],
|
|
89
99
|
};
|