@iksnerd/blazon 0.0.0-stage → 0.1.0
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/LICENSE +21 -0
- package/README.md +264 -2
- package/THIRD-PARTY-NOTICES.md +60 -0
- package/bin/blazon.js +4 -0
- package/dist/builder/site-builder.d.ts +10 -0
- package/dist/builder/site-builder.d.ts.map +1 -0
- package/dist/chunks/site-builder-vpzUWoiA.js +13777 -0
- package/dist/cli/commands/approvals.d.ts +8 -0
- package/dist/cli/commands/approvals.d.ts.map +1 -0
- package/dist/cli/commands/build.d.ts +8 -0
- package/dist/cli/commands/build.d.ts.map +1 -0
- package/dist/cli/commands/check.d.ts +33 -0
- package/dist/cli/commands/check.d.ts.map +1 -0
- package/dist/cli/commands/cwd.d.ts +14 -0
- package/dist/cli/commands/cwd.d.ts.map +1 -0
- package/dist/cli/commands/dev.d.ts +5 -0
- package/dist/cli/commands/dev.d.ts.map +1 -0
- package/dist/cli/commands/doctor.d.ts +34 -0
- package/dist/cli/commands/doctor.d.ts.map +1 -0
- package/dist/cli/commands/drift.d.ts +11 -0
- package/dist/cli/commands/drift.d.ts.map +1 -0
- package/dist/cli/commands/explain.d.ts +5 -0
- package/dist/cli/commands/explain.d.ts.map +1 -0
- package/dist/cli/commands/init.d.ts +46 -0
- package/dist/cli/commands/init.d.ts.map +1 -0
- package/dist/cli/commands/mcp-check.d.ts +57 -0
- package/dist/cli/commands/mcp-check.d.ts.map +1 -0
- package/dist/cli/commands/mcp.d.ts +13 -0
- package/dist/cli/commands/mcp.d.ts.map +1 -0
- package/dist/cli/commands/pin.d.ts +7 -0
- package/dist/cli/commands/pin.d.ts.map +1 -0
- package/dist/cli/commands/plugin.d.ts +32 -0
- package/dist/cli/commands/plugin.d.ts.map +1 -0
- package/dist/cli/commands/preview.d.ts +5 -0
- package/dist/cli/commands/preview.d.ts.map +1 -0
- package/dist/cli/commands/tokens.d.ts +5 -0
- package/dist/cli/commands/tokens.d.ts.map +1 -0
- package/dist/cli/errors.d.ts +53 -0
- package/dist/cli/errors.d.ts.map +1 -0
- package/dist/cli/handlers/brand.d.ts +7 -0
- package/dist/cli/handlers/brand.d.ts.map +1 -0
- package/dist/cli/handlers/can.d.ts +7 -0
- package/dist/cli/handlers/can.d.ts.map +1 -0
- package/dist/cli/handlers/fonts.d.ts +4 -0
- package/dist/cli/handlers/fonts.d.ts.map +1 -0
- package/dist/cli/handlers/get.d.ts +7 -0
- package/dist/cli/handlers/get.d.ts.map +1 -0
- package/dist/cli/handlers/index.d.ts +8 -0
- package/dist/cli/handlers/index.d.ts.map +1 -0
- package/dist/cli/handlers/list.d.ts +7 -0
- package/dist/cli/handlers/list.d.ts.map +1 -0
- package/dist/cli/handlers/logo.d.ts +4 -0
- package/dist/cli/handlers/logo.d.ts.map +1 -0
- package/dist/cli/handlers/rules.d.ts +10 -0
- package/dist/cli/handlers/rules.d.ts.map +1 -0
- package/dist/cli/handlers/types.d.ts +17 -0
- package/dist/cli/handlers/types.d.ts.map +1 -0
- package/dist/cli/help.d.ts +18 -0
- package/dist/cli/help.d.ts.map +1 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +3850 -0
- package/dist/cli/init-flow.d.ts +24 -0
- package/dist/cli/init-flow.d.ts.map +1 -0
- package/dist/cli/init-ui.d.ts +20 -0
- package/dist/cli/init-ui.d.ts.map +1 -0
- package/dist/cli/json.d.ts +18 -0
- package/dist/cli/json.d.ts.map +1 -0
- package/dist/cli/operations.d.ts +11 -0
- package/dist/cli/operations.d.ts.map +1 -0
- package/dist/cli/options.d.ts +8 -0
- package/dist/cli/options.d.ts.map +1 -0
- package/dist/cli/project.d.ts +8 -0
- package/dist/cli/project.d.ts.map +1 -0
- package/dist/cli/read.d.ts +13 -0
- package/dist/cli/read.d.ts.map +1 -0
- package/dist/cli/where.d.ts +10 -0
- package/dist/cli/where.d.ts.map +1 -0
- package/dist/core/assets/categories.d.ts +47 -0
- package/dist/core/assets/categories.d.ts.map +1 -0
- package/dist/core/assets/fields.d.ts +12 -0
- package/dist/core/assets/fields.d.ts.map +1 -0
- package/dist/core/assets/image-size.d.ts +10 -0
- package/dist/core/assets/image-size.d.ts.map +1 -0
- package/dist/core/assets/measure.d.ts +22 -0
- package/dist/core/assets/measure.d.ts.map +1 -0
- package/dist/core/assets/scanner.d.ts +26 -0
- package/dist/core/assets/scanner.d.ts.map +1 -0
- package/dist/core/assets/sidecar.d.ts +22 -0
- package/dist/core/assets/sidecar.d.ts.map +1 -0
- package/dist/core/blazon-pin.d.ts +36 -0
- package/dist/core/blazon-pin.d.ts.map +1 -0
- package/dist/core/brand/export.d.ts +128 -0
- package/dist/core/brand/export.d.ts.map +1 -0
- package/dist/core/brand/schema.d.ts +1000 -0
- package/dist/core/brand/schema.d.ts.map +1 -0
- package/dist/core/brand-theme.d.ts +16 -0
- package/dist/core/brand-theme.d.ts.map +1 -0
- package/dist/core/checker/approvals.d.ts +15 -0
- package/dist/core/checker/approvals.d.ts.map +1 -0
- package/dist/core/checker/cascade.d.ts +8 -0
- package/dist/core/checker/cascade.d.ts.map +1 -0
- package/dist/core/checker/catalogue.d.ts +593 -0
- package/dist/core/checker/catalogue.d.ts.map +1 -0
- package/dist/core/checker/contrast.d.ts +30 -0
- package/dist/core/checker/contrast.d.ts.map +1 -0
- package/dist/core/checker/duplicates.d.ts +3 -0
- package/dist/core/checker/duplicates.d.ts.map +1 -0
- package/dist/core/checker/fixes.d.ts +6 -0
- package/dist/core/checker/fixes.d.ts.map +1 -0
- package/dist/core/checker/font-meta.d.ts +8 -0
- package/dist/core/checker/font-meta.d.ts.map +1 -0
- package/dist/core/checker/index.d.ts +23 -0
- package/dist/core/checker/index.d.ts.map +1 -0
- package/dist/core/checker/location.d.ts +7 -0
- package/dist/core/checker/location.d.ts.map +1 -0
- package/dist/core/checker/logo-rules.d.ts +19 -0
- package/dist/core/checker/logo-rules.d.ts.map +1 -0
- package/dist/core/checker/logo-surfaces.d.ts +7 -0
- package/dist/core/checker/logo-surfaces.d.ts.map +1 -0
- package/dist/core/checker/page-tokens.d.ts +5 -0
- package/dist/core/checker/page-tokens.d.ts.map +1 -0
- package/dist/core/checker/print.d.ts +9 -0
- package/dist/core/checker/print.d.ts.map +1 -0
- package/dist/core/checker/proportion.d.ts +3 -0
- package/dist/core/checker/proportion.d.ts.map +1 -0
- package/dist/core/checker/review.d.ts +40 -0
- package/dist/core/checker/review.d.ts.map +1 -0
- package/dist/core/checker/source.d.ts +4 -0
- package/dist/core/checker/source.d.ts.map +1 -0
- package/dist/core/checker/spdx.d.ts +8 -0
- package/dist/core/checker/spdx.d.ts.map +1 -0
- package/dist/core/checker/tier.d.ts +3 -0
- package/dist/core/checker/tier.d.ts.map +1 -0
- package/dist/core/checker/usage.d.ts +4 -0
- package/dist/core/checker/usage.d.ts.map +1 -0
- package/dist/core/checker/variables.d.ts +8 -0
- package/dist/core/checker/variables.d.ts.map +1 -0
- package/dist/core/colors.d.ts +10 -0
- package/dist/core/colors.d.ts.map +1 -0
- package/dist/core/config/defaults.d.ts +3 -0
- package/dist/core/config/defaults.d.ts.map +1 -0
- package/dist/core/config/index.d.ts +15 -0
- package/dist/core/config/index.d.ts.map +1 -0
- package/dist/core/config/validate.d.ts +21 -0
- package/dist/core/config/validate.d.ts.map +1 -0
- package/dist/core/config/vocabulary.d.ts +10 -0
- package/dist/core/config/vocabulary.d.ts.map +1 -0
- package/dist/core/confine.d.ts +25 -0
- package/dist/core/confine.d.ts.map +1 -0
- package/dist/core/docs/directives.d.ts +152 -0
- package/dist/core/docs/directives.d.ts.map +1 -0
- package/dist/core/docs/parser.d.ts +7 -0
- package/dist/core/docs/parser.d.ts.map +1 -0
- package/dist/core/docs/sections.d.ts +11 -0
- package/dist/core/docs/sections.d.ts.map +1 -0
- package/dist/core/drift/compare.d.ts +30 -0
- package/dist/core/drift/compare.d.ts.map +1 -0
- package/dist/core/drift/read.d.ts +22 -0
- package/dist/core/drift/read.d.ts.map +1 -0
- package/dist/core/email-signature.d.ts +35 -0
- package/dist/core/email-signature.d.ts.map +1 -0
- package/dist/core/emit.d.ts +22 -0
- package/dist/core/emit.d.ts.map +1 -0
- package/dist/core/fonts.d.ts +43 -0
- package/dist/core/fonts.d.ts.map +1 -0
- package/dist/core/icons/icon-sets.d.ts +22 -0
- package/dist/core/icons/icon-sets.d.ts.map +1 -0
- package/dist/core/index.d.ts +9 -0
- package/dist/core/index.d.ts.map +1 -0
- package/dist/core/init/answers.d.ts +45 -0
- package/dist/core/init/answers.d.ts.map +1 -0
- package/dist/core/init/from-site/apply.d.ts +7 -0
- package/dist/core/init/from-site/apply.d.ts.map +1 -0
- package/dist/core/init/from-site/clean-colors.d.ts +21 -0
- package/dist/core/init/from-site/clean-colors.d.ts.map +1 -0
- package/dist/core/init/from-site/colors.d.ts +10 -0
- package/dist/core/init/from-site/colors.d.ts.map +1 -0
- package/dist/core/init/from-site/context.d.ts +24 -0
- package/dist/core/init/from-site/context.d.ts.map +1 -0
- package/dist/core/init/from-site/fonts.d.ts +10 -0
- package/dist/core/init/from-site/fonts.d.ts.map +1 -0
- package/dist/core/init/from-site/html.d.ts +10 -0
- package/dist/core/init/from-site/html.d.ts.map +1 -0
- package/dist/core/init/from-site/index.d.ts +6 -0
- package/dist/core/init/from-site/index.d.ts.map +1 -0
- package/dist/core/init/from-site/inspect.d.ts +4 -0
- package/dist/core/init/from-site/inspect.d.ts.map +1 -0
- package/dist/core/init/from-site/logo.d.ts +20 -0
- package/dist/core/init/from-site/logo.d.ts.map +1 -0
- package/dist/core/init/from-site/sections/colors.d.ts +4 -0
- package/dist/core/init/from-site/sections/colors.d.ts.map +1 -0
- package/dist/core/init/from-site/sections/config.d.ts +10 -0
- package/dist/core/init/from-site/sections/config.d.ts.map +1 -0
- package/dist/core/init/from-site/sections/directives.d.ts +3 -0
- package/dist/core/init/from-site/sections/directives.d.ts.map +1 -0
- package/dist/core/init/from-site/sections/fonts.d.ts +8 -0
- package/dist/core/init/from-site/sections/fonts.d.ts.map +1 -0
- package/dist/core/init/from-site/sections/intro.d.ts +4 -0
- package/dist/core/init/from-site/sections/intro.d.ts.map +1 -0
- package/dist/core/init/from-site/sections/logo.d.ts +9 -0
- package/dist/core/init/from-site/sections/logo.d.ts.map +1 -0
- package/dist/core/init/from-site/sections/placeholder.d.ts +5 -0
- package/dist/core/init/from-site/sections/placeholder.d.ts.map +1 -0
- package/dist/core/init/from-site/tree.d.ts +14 -0
- package/dist/core/init/from-site/tree.d.ts.map +1 -0
- package/dist/core/init/from-site/types.d.ts +37 -0
- package/dist/core/init/from-site/types.d.ts.map +1 -0
- package/dist/core/init/palette.d.ts +34 -0
- package/dist/core/init/palette.d.ts.map +1 -0
- package/dist/core/init/prompts.d.ts +78 -0
- package/dist/core/init/prompts.d.ts.map +1 -0
- package/dist/core/init/shared/google-fonts.d.ts +4 -0
- package/dist/core/init/shared/google-fonts.d.ts.map +1 -0
- package/dist/core/init/shared/hex.d.ts +6 -0
- package/dist/core/init/shared/hex.d.ts.map +1 -0
- package/dist/core/init/shared/svg.d.ts +3 -0
- package/dist/core/init/shared/svg.d.ts.map +1 -0
- package/dist/core/init/vocabulary.d.ts +42 -0
- package/dist/core/init/vocabulary.d.ts.map +1 -0
- package/dist/core/inputs.d.ts +25 -0
- package/dist/core/inputs.d.ts.map +1 -0
- package/dist/core/logo/lockup.d.ts +54 -0
- package/dist/core/logo/lockup.d.ts.map +1 -0
- package/dist/core/logo.d.ts +23 -0
- package/dist/core/logo.d.ts.map +1 -0
- package/dist/core/mcp-config.d.ts +65 -0
- package/dist/core/mcp-config.d.ts.map +1 -0
- package/dist/core/operations/check.d.ts +8 -0
- package/dist/core/operations/check.d.ts.map +1 -0
- package/dist/core/operations/index.d.ts +7 -0
- package/dist/core/operations/index.d.ts.map +1 -0
- package/dist/core/operations/limits.d.ts +6 -0
- package/dist/core/operations/limits.d.ts.map +1 -0
- package/dist/core/operations/list.d.ts +8 -0
- package/dist/core/operations/list.d.ts.map +1 -0
- package/dist/core/operations/project.d.ts +10 -0
- package/dist/core/operations/project.d.ts.map +1 -0
- package/dist/core/operations/types.d.ts +96 -0
- package/dist/core/operations/types.d.ts.map +1 -0
- package/dist/core/operations/validate.d.ts +4 -0
- package/dist/core/operations/validate.d.ts.map +1 -0
- package/dist/core/order.d.ts +9 -0
- package/dist/core/order.d.ts.map +1 -0
- package/dist/core/outputs.d.ts +22 -0
- package/dist/core/outputs.d.ts.map +1 -0
- package/dist/core/package-name.d.ts +3 -0
- package/dist/core/package-name.d.ts.map +1 -0
- package/dist/core/package-root.d.ts +3 -0
- package/dist/core/package-root.d.ts.map +1 -0
- package/dist/core/plugin-name.d.ts +27 -0
- package/dist/core/plugin-name.d.ts.map +1 -0
- package/dist/core/preflight.d.ts +10 -0
- package/dist/core/preflight.d.ts.map +1 -0
- package/dist/core/read/can.d.ts +44 -0
- package/dist/core/read/can.d.ts.map +1 -0
- package/dist/core/read/fonts.d.ts +47 -0
- package/dist/core/read/fonts.d.ts.map +1 -0
- package/dist/core/read/index.d.ts +8 -0
- package/dist/core/read/index.d.ts.map +1 -0
- package/dist/core/read/list.d.ts +28 -0
- package/dist/core/read/list.d.ts.map +1 -0
- package/dist/core/read/logo.d.ts +34 -0
- package/dist/core/read/logo.d.ts.map +1 -0
- package/dist/core/read/lookup.d.ts +9 -0
- package/dist/core/read/lookup.d.ts.map +1 -0
- package/dist/core/read/rules.d.ts +80 -0
- package/dist/core/read/rules.d.ts.map +1 -0
- package/dist/core/read/token.d.ts +46 -0
- package/dist/core/read/token.d.ts.map +1 -0
- package/dist/core/shipped-names.d.ts +9 -0
- package/dist/core/shipped-names.d.ts.map +1 -0
- package/dist/core/starter.d.ts +31 -0
- package/dist/core/starter.d.ts.map +1 -0
- package/dist/core/suggest.d.ts +7 -0
- package/dist/core/suggest.d.ts.map +1 -0
- package/dist/core/tokens/alias.d.ts +18 -0
- package/dist/core/tokens/alias.d.ts.map +1 -0
- package/dist/core/tokens/contexts.d.ts +10 -0
- package/dist/core/tokens/contexts.d.ts.map +1 -0
- package/dist/core/tokens/formatters/css.d.ts +15 -0
- package/dist/core/tokens/formatters/css.d.ts.map +1 -0
- package/dist/core/tokens/formatters/json.d.ts +4 -0
- package/dist/core/tokens/formatters/json.d.ts.map +1 -0
- package/dist/core/tokens/formatters/tailwind.d.ts +37 -0
- package/dist/core/tokens/formatters/tailwind.d.ts.map +1 -0
- package/dist/core/tokens/formatters/ts.d.ts +6 -0
- package/dist/core/tokens/formatters/ts.d.ts.map +1 -0
- package/dist/core/tokens/groups.d.ts +44 -0
- package/dist/core/tokens/groups.d.ts.map +1 -0
- package/dist/core/tokens/key-lines.d.ts +8 -0
- package/dist/core/tokens/key-lines.d.ts.map +1 -0
- package/dist/core/tokens/load.d.ts +12 -0
- package/dist/core/tokens/load.d.ts.map +1 -0
- package/dist/core/tokens/merge.d.ts +17 -0
- package/dist/core/tokens/merge.d.ts.map +1 -0
- package/dist/core/tokens/names.d.ts +5 -0
- package/dist/core/tokens/names.d.ts.map +1 -0
- package/dist/core/tokens/resolve.d.ts +8 -0
- package/dist/core/tokens/resolve.d.ts.map +1 -0
- package/dist/core/tokens/resolver/compile.d.ts +17 -0
- package/dist/core/tokens/resolver/compile.d.ts.map +1 -0
- package/dist/core/tokens/resolver/inputs.d.ts +7 -0
- package/dist/core/tokens/resolver/inputs.d.ts.map +1 -0
- package/dist/core/tokens/resolver/parse.d.ts +34 -0
- package/dist/core/tokens/resolver/parse.d.ts.map +1 -0
- package/dist/core/tokens/resolver/sources.d.ts +17 -0
- package/dist/core/tokens/resolver/sources.d.ts.map +1 -0
- package/dist/core/tokens/shadcn.d.ts +43 -0
- package/dist/core/tokens/shadcn.d.ts.map +1 -0
- package/dist/core/tokens/theme.d.ts +17 -0
- package/dist/core/tokens/theme.d.ts.map +1 -0
- package/dist/core/tokens/values/color.d.ts +2 -0
- package/dist/core/tokens/values/color.d.ts.map +1 -0
- package/dist/core/tokens/values/composite.d.ts +7 -0
- package/dist/core/tokens/values/composite.d.ts.map +1 -0
- package/dist/core/tokens/values/font.d.ts +3 -0
- package/dist/core/tokens/values/font.d.ts.map +1 -0
- package/dist/core/tokens/values/index.d.ts +9 -0
- package/dist/core/tokens/values/index.d.ts.map +1 -0
- package/dist/core/tokens/values/shared.d.ts +5 -0
- package/dist/core/tokens/values/shared.d.ts.map +1 -0
- package/dist/core/tokens/values/simple.d.ts +3 -0
- package/dist/core/tokens/values/simple.d.ts.map +1 -0
- package/dist/core/tokens/values/units.d.ts +3 -0
- package/dist/core/tokens/values/units.d.ts.map +1 -0
- package/dist/core/tokens/walk.d.ts +30 -0
- package/dist/core/tokens/walk.d.ts.map +1 -0
- package/dist/core/version.d.ts +3 -0
- package/dist/core/version.d.ts.map +1 -0
- package/dist/index.d.ts +27 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +40 -0
- package/dist/plugins/host/admit.d.ts +35 -0
- package/dist/plugins/host/admit.d.ts.map +1 -0
- package/dist/plugins/host/call.d.ts +59 -0
- package/dist/plugins/host/call.d.ts.map +1 -0
- package/dist/plugins/host/check.d.ts +54 -0
- package/dist/plugins/host/check.d.ts.map +1 -0
- package/dist/plugins/host/scrub.d.ts +17 -0
- package/dist/plugins/host/scrub.d.ts.map +1 -0
- package/dist/plugins/index.d.ts +14 -0
- package/dist/plugins/index.d.ts.map +1 -0
- package/dist/plugins/pins/interpreter.d.ts +49 -0
- package/dist/plugins/pins/interpreter.d.ts.map +1 -0
- package/dist/plugins/pins/lock.d.ts +47 -0
- package/dist/plugins/pins/lock.d.ts.map +1 -0
- package/dist/plugins/pins/pin.d.ts +65 -0
- package/dist/plugins/pins/pin.d.ts.map +1 -0
- package/dist/plugins/pins/shipped.d.ts +40 -0
- package/dist/plugins/pins/shipped.d.ts.map +1 -0
- package/dist/plugins/roles/breaker.d.ts +18 -0
- package/dist/plugins/roles/breaker.d.ts.map +1 -0
- package/dist/plugins/roles/check-cases.d.ts +4 -0
- package/dist/plugins/roles/check-cases.d.ts.map +1 -0
- package/dist/plugins/roles/dev.d.ts +35 -0
- package/dist/plugins/roles/dev.d.ts.map +1 -0
- package/dist/plugins/roles/fixes.d.ts +24 -0
- package/dist/plugins/roles/fixes.d.ts.map +1 -0
- package/dist/plugins/roles/gate.d.ts +26 -0
- package/dist/plugins/roles/gate.d.ts.map +1 -0
- package/dist/plugins/roles/integrate.d.ts +12 -0
- package/dist/plugins/roles/integrate.d.ts.map +1 -0
- package/dist/plugins/roles/roles.d.ts +69 -0
- package/dist/plugins/roles/roles.d.ts.map +1 -0
- package/dist/plugins/wire/environment.d.ts +9 -0
- package/dist/plugins/wire/environment.d.ts.map +1 -0
- package/dist/plugins/wire/forms.d.ts +13 -0
- package/dist/plugins/wire/forms.d.ts.map +1 -0
- package/dist/plugins/wire/limits.d.ts +11 -0
- package/dist/plugins/wire/limits.d.ts.map +1 -0
- package/dist/plugins/wire/manifest.d.ts +31 -0
- package/dist/plugins/wire/manifest.d.ts.map +1 -0
- package/dist/plugins/wire/profile.d.ts +36 -0
- package/dist/plugins/wire/profile.d.ts.map +1 -0
- package/dist/plugins/wire/text.d.ts +14 -0
- package/dist/plugins/wire/text.d.ts.map +1 -0
- package/dist/server/assets.d.ts +13 -0
- package/dist/server/assets.d.ts.map +1 -0
- package/dist/server/coalesce.d.ts +12 -0
- package/dist/server/coalesce.d.ts.map +1 -0
- package/dist/server/data-script.d.ts +8 -0
- package/dist/server/data-script.d.ts.map +1 -0
- package/dist/server/dev-server.d.ts +34 -0
- package/dist/server/dev-server.d.ts.map +1 -0
- package/dist/server/editor-guard.d.ts +13 -0
- package/dist/server/editor-guard.d.ts.map +1 -0
- package/dist/server/error-reporter.d.ts +11 -0
- package/dist/server/error-reporter.d.ts.map +1 -0
- package/dist/server/icon-sets.d.ts +9 -0
- package/dist/server/icon-sets.d.ts.map +1 -0
- package/dist/server/plugin.d.ts +4 -0
- package/dist/server/plugin.d.ts.map +1 -0
- package/dist/server/preview-guard.d.ts +11 -0
- package/dist/server/preview-guard.d.ts.map +1 -0
- package/dist/types/assets.d.ts +130 -0
- package/dist/types/assets.d.ts.map +1 -0
- package/dist/types/catalog.d.ts +95 -0
- package/dist/types/catalog.d.ts.map +1 -0
- package/dist/types/config.d.ts +97 -0
- package/dist/types/config.d.ts.map +1 -0
- package/dist/types/data.d.ts +38 -0
- package/dist/types/data.d.ts.map +1 -0
- package/dist/types/docs.d.ts +47 -0
- package/dist/types/docs.d.ts.map +1 -0
- package/dist/types/findings.d.ts +18 -0
- package/dist/types/findings.d.ts.map +1 -0
- package/dist/types/index.d.ts +13 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/parsed.d.ts +86 -0
- package/dist/types/parsed.d.ts.map +1 -0
- package/dist/types/theme.d.ts +19 -0
- package/dist/types/theme.d.ts.map +1 -0
- package/dist/types/tokens.d.ts +101 -0
- package/dist/types/tokens.d.ts.map +1 -0
- package/dist/ui/assets/geist-OFL.txt +93 -0
- package/dist/ui/assets/geist-cyrillic-ext-wght-normal-DjL33-gN.woff2 +0 -0
- package/dist/ui/assets/geist-cyrillic-wght-normal-BEAKL7Jp.woff2 +0 -0
- package/dist/ui/assets/geist-latin-ext-wght-normal-DC-KSUi6.woff2 +0 -0
- package/dist/ui/assets/geist-latin-wght-normal-BgDaEnEv.woff2 +0 -0
- package/dist/ui/assets/geist-vietnamese-wght-normal-6IgcOCM7.woff2 +0 -0
- package/dist/ui/assets/index-BdbihVvH.js +77 -0
- package/dist/ui/assets/index-DluSqfla.css +2 -0
- package/dist/ui/index.html +14 -0
- package/package.json +151 -4
- package/plugins/blazon.brand-deck/README.md +38 -0
- package/plugins/blazon.brand-deck/bin/blazon-blazon.brand-deck./360/237/224/214 +2695 -0
- package/plugins/blazon.brand-deck/package.json +3 -0
- package/plugins/blazon.copy/README.md +29 -0
- package/plugins/blazon.copy/bin/blazon-blazon.copy./360/237/224/214 +438 -0
- package/plugins/blazon.copy/package.json +3 -0
- package/plugins/blazon.favicons/README.md +13 -0
- package/plugins/blazon.favicons/bin/blazon-blazon.favicons./360/237/224/214 +8816 -0
- package/plugins/blazon.favicons/package.json +3 -0
- package/plugins/blazon.logo-geometry/README.md +5 -0
- package/plugins/blazon.logo-geometry/bin/blazon-blazon.logo-geometry./360/237/224/214 +1522 -0
- package/plugins/blazon.logo-geometry/package.json +3 -0
- package/plugins/blazon.logo-kit/README.md +5 -0
- package/plugins/blazon.logo-kit/bin/blazon-blazon.logo-kit./360/237/224/214 +617 -0
- package/plugins/blazon.logo-kit/package.json +3 -0
- package/plugins/blazon.office-template/README.md +29 -0
- package/plugins/blazon.office-template/bin/blazon-blazon.office-template./360/237/224/214 +1788 -0
- package/plugins/blazon.office-template/package.json +3 -0
- package/plugins/blazon.platform-tokens/README.md +22 -0
- package/plugins/blazon.platform-tokens/bin/blazon-blazon.platform-tokens./360/237/224/214 +8418 -0
- package/plugins/blazon.platform-tokens/package.json +3 -0
- package/plugins/blazon.press-kit/README.md +17 -0
- package/plugins/blazon.press-kit/bin/blazon-blazon.press-kit./360/237/224/214 +897 -0
- package/plugins/blazon.press-kit/package.json +3 -0
- package/plugins/blazon.print-book/README.md +38 -0
- package/plugins/blazon.print-book/bin/blazon-blazon.print-book./360/237/224/214 +9262 -0
- package/plugins/blazon.print-book/package.json +3 -0
- package/plugins/blazon.social-cards/README.md +5 -0
- package/plugins/blazon.social-cards/bin/blazon-blazon.social-cards./360/237/224/214 +1165 -0
- package/plugins/blazon.social-cards/package.json +3 -0
- package/plugins/shipped.lock +75 -0
- package/template/AGENTS.md +55 -0
- package/template/CLAUDE.md +1 -0
- package/template/assets/backgrounds/aurora.json +5 -0
- package/template/assets/backgrounds/aurora.svg +39 -0
- package/template/assets/construction/blazon-mark.json +9 -0
- package/template/assets/construction/blazon-mark.svg +54 -0
- package/template/assets/icons/arrow-right.json +5 -0
- package/template/assets/icons/arrow-right.svg +1 -0
- package/template/assets/icons/check.json +5 -0
- package/template/assets/icons/check.svg +1 -0
- package/template/assets/icons/download.json +5 -0
- package/template/assets/icons/download.svg +1 -0
- package/template/assets/icons/file.json +5 -0
- package/template/assets/icons/file.svg +1 -0
- package/template/assets/icons/token.json +5 -0
- package/template/assets/icons/token.svg +1 -0
- package/template/assets/icons/warning.json +5 -0
- package/template/assets/icons/warning.svg +1 -0
- package/template/assets/logos/blazon-bone.json +6 -0
- package/template/assets/logos/blazon-bone.svg +1 -0
- package/template/assets/logos/blazon-graphite.json +6 -0
- package/template/assets/logos/blazon-graphite.svg +1 -0
- package/template/assets/logos/blazon-mark.json +6 -0
- package/template/assets/logos/blazon-mark.svg +1 -0
- package/template/blazon.json +104 -0
- package/template/blazon.resolver.json +46 -0
- package/template/docs/01-principles.md +47 -0
- package/template/docs/02-logo.md +43 -0
- package/template/docs/03-color.md +79 -0
- package/template/docs/04-type.md +36 -0
- package/template/docs/05-form.md +80 -0
- package/template/docs/06-layout.md +28 -0
- package/template/docs/07-icons.md +22 -0
- package/template/docs/08-diagrams.md +20 -0
- package/template/docs/09-social.md +21 -0
- package/template/docs/10-applications.md +20 -0
- package/template/docs/11-voice.md +74 -0
- package/template/docs/12-web.md +167 -0
- package/template/fonts/IBMPlexMono-Regular-latin.woff2 +0 -0
- package/template/fonts/IBMPlexMono-SemiBold-latin.woff2 +0 -0
- package/template/fonts/OFL.txt +93 -0
- package/template/tokens/colors.json +257 -0
- package/template/tokens/form.json +199 -0
- package/template/tokens/social.json +26 -0
- package/template/tokens/spacing.json +65 -0
- package/template/tokens/theme/dark.json +121 -0
- package/template/tokens/typography.json +233 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { default as Color } from 'colorjs.io';
|
|
2
|
+
import { ContrastLevel, ContrastPair, Finding, TokenItem } from '../../types/index.js';
|
|
3
|
+
/** WCAG 2.2 SC 1.4.3 / 1.4.6 minimum ratios. */
|
|
4
|
+
export declare const CONTRAST_MINIMUM: Record<ContrastLevel, number>;
|
|
5
|
+
/** Any CSS color (hex, rgb(), hsl(), lab(), oklch(), color(), a name), or undefined for anything else. The color keeps its alpha; `contrastBetween` blends it. */
|
|
6
|
+
export declare function parseColor(css: string): Color | undefined;
|
|
7
|
+
/** The WCAG 2.x contrast ratio of two colors, from their relative luminance. */
|
|
8
|
+
export declare function contrastRatio(a: Color, b: Color): number;
|
|
9
|
+
/**
|
|
10
|
+
* The ratio of a foreground over a background, or undefined when the backdrop is not known. WCAG measures what is seen, so a
|
|
11
|
+
* translucent foreground is blended over the background first. A translucent background shows whatever is behind it, which a
|
|
12
|
+
* pair does not name, so it has no ratio.
|
|
13
|
+
*/
|
|
14
|
+
export declare function contrastBetween(fg: Color, bg: Color): number | undefined;
|
|
15
|
+
/** A ratio as the message prints it: floored to two decimals, so a failing 4.496 never reads as the 4.50 it misses. */
|
|
16
|
+
export declare const ratioMessage: (ratio: number) => string;
|
|
17
|
+
/** Expands "{a.b}" to that token and "{a.*}" to every color token under a. */
|
|
18
|
+
export declare function expand(ref: string, items: TokenItem[]): TokenItem[];
|
|
19
|
+
/** The token's path, then the path of each token it aliases in turn. */
|
|
20
|
+
export declare function aliasChain(items: TokenItem[], path: string): string[];
|
|
21
|
+
/**
|
|
22
|
+
* The listed pairs that name this foreground on this background. A pair written on a token that the foreground or the
|
|
23
|
+
* background aliases counts, because the alias is the same color: `blazon check`, `blazon can` and the shadcn notes all use this one rule.
|
|
24
|
+
*/
|
|
25
|
+
export declare function matchingPairs<T extends {
|
|
26
|
+
fg: string;
|
|
27
|
+
bg: string;
|
|
28
|
+
}>(items: TokenItem[], listed: T[], fgPath: string, bgPath: string): T[];
|
|
29
|
+
export declare function contrastFindings(pair: ContrastPair, rulePath: string, items: TokenItem[]): Finding[];
|
|
30
|
+
//# sourceMappingURL=contrast.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contrast.d.ts","sourceRoot":"","sources":["../../../src/core/checker/contrast.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAI5F,gDAAgD;AAChD,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,CAAsC,CAAC;AAElG,kKAAkK;AAClK,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAMzD;AAED,gFAAgF;AAChF,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,MAAM,CAExD;AAQD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAOxE;AAED,uHAAuH;AACvH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,MAA2D,CAAC;AAEzG,8EAA8E;AAC9E,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAQnE;AAED,wEAAwE;AACxE,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAKrE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,CAIxI;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CA2BpG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"duplicates.d.ts","sourceRoot":"","sources":["../../../src/core/checker/duplicates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAG/D,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,CAiB/D"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { Finding } from '../../types/index.js';
|
|
2
|
+
/** The fix for a finding's code, or undefined when there is none to give (a note, or a warning that is a question). */
|
|
3
|
+
export declare function fixFor(code: string): string | undefined;
|
|
4
|
+
/** The fix for one finding: its own, when its cause has one (a plugin-failed finding), or its code's. What every output prints. */
|
|
5
|
+
export declare function fixOf(finding: Pick<Finding, 'code' | 'fix'>): string | undefined;
|
|
6
|
+
//# sourceMappingURL=fixes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fixes.d.ts","sourceRoot":"","sources":["../../../src/core/checker/fixes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAGpD,uHAAuH;AACvH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAGvD;AAED,mIAAmI;AACnI,wBAAgB,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,GAAG,MAAM,GAAG,SAAS,CAEhF"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { Finding, GroupMeta, TokenItem } from '../../types/index.js';
|
|
2
|
+
/**
|
|
3
|
+
* The `font` extension on tokens and groups: a source or license that is not text, an address that is not http(s), a field blazon does not know,
|
|
4
|
+
* or a `font` on a token that is not a typeface. Printed into a press kit as the brand's word, so a malformed one is an error, not skipped.
|
|
5
|
+
* Read from the token's own extension, as `logo` is: a group reports once, not each token under it.
|
|
6
|
+
*/
|
|
7
|
+
export declare function fontMetaFindings(items: readonly TokenItem[], groups: readonly GroupMeta[]): Finding[];
|
|
8
|
+
//# sourceMappingURL=font-meta.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"font-meta.d.ts","sourceRoot":"","sources":["../../../src/core/checker/font-meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AA6B1E;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,EAAE,CAerG"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { BlazonData, Finding, Vocabulary } from '../../types/index.js';
|
|
2
|
+
export type CheckFinding = Finding;
|
|
3
|
+
export interface CheckResult {
|
|
4
|
+
passed: boolean;
|
|
5
|
+
errors: Finding[];
|
|
6
|
+
warnings: Finding[];
|
|
7
|
+
infos: Finding[];
|
|
8
|
+
all: Finding[];
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Runs the RFC 0001 §4 checks over compiled data: load problems plus usage, contrast,
|
|
12
|
+
* duplicate, review and tier rules. `strict` makes warnings fail the check.
|
|
13
|
+
*/
|
|
14
|
+
export declare function checkTokens(data: Pick<BlazonData, 'tokens'> & {
|
|
15
|
+
vocabulary?: Pick<Vocabulary, 'usageRoles'>;
|
|
16
|
+
}, options?: {
|
|
17
|
+
strict?: boolean;
|
|
18
|
+
}): CheckResult;
|
|
19
|
+
/** Puts findings in the defined total order (`compareFindings`) and splits them by severity; `strict` makes warnings fail too. */
|
|
20
|
+
export declare function summarizeFindings(found: Finding[], options?: {
|
|
21
|
+
strict?: boolean;
|
|
22
|
+
}): CheckResult;
|
|
23
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/checker/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,UAAU,EAAE,KAAK,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAY5G,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC;AAEnC,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,GAAG,EAAE,OAAO,EAAE,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG;IAAE,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA;CAAE,EAAE,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,WAAW,CAiB3J;AAED,kIAAkI;AAClI,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,WAAW,CAO/F"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Finding } from '../../types/index.js';
|
|
2
|
+
/**
|
|
3
|
+
* Where a finding is, as compilers print it: `tokens/colors.json:17`, which terminals and editors open at the line. `dir` goes in
|
|
4
|
+
* front of the file, so a person who ran blazon from another folder can open it from there. Undefined when the finding names no file.
|
|
5
|
+
*/
|
|
6
|
+
export declare function findingLocation(finding: Pick<Finding, 'file' | 'line'>, dir?: string): string | undefined;
|
|
7
|
+
//# sourceMappingURL=location.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"location.d.ts","sourceRoot":"","sources":["../../../src/core/checker/location.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEpD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,GAAE,MAAW,GAAG,MAAM,GAAG,SAAS,CAI7G"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Finding, GroupMeta, TokenItem } from '../../types/index.js';
|
|
2
|
+
/** The two configured logo variants; a logo asset is named by its id (`logos/white`). */
|
|
3
|
+
export declare const CONFIGURED_LOGO_VARIANTS: readonly ["onLight", "onDark"];
|
|
4
|
+
export interface LogoDenial {
|
|
5
|
+
/** The token that states the rule: the background itself, or one it aliases */
|
|
6
|
+
path: string;
|
|
7
|
+
reason?: string;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Whether the brand forbids this logo variant on a background token, whatever its contrast. A token's
|
|
11
|
+
* own rule (or its group's) wins; failing that, the first rule on the tokens it aliases, as for usage.
|
|
12
|
+
*/
|
|
13
|
+
export declare function logoDenial(item: TokenItem, items: readonly TokenItem[], variant: string): LogoDenial | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* The `logo` rules on tokens and groups: a rule that names a variant no logo has would forbid nothing and
|
|
16
|
+
* say nothing, so it is an error, as a pair that matches no tokens is. A group reports once, not each token under it.
|
|
17
|
+
*/
|
|
18
|
+
export declare function logoRuleFindings(items: readonly TokenItem[], groups: readonly GroupMeta[], variants: readonly string[]): Finding[];
|
|
19
|
+
//# sourceMappingURL=logo-rules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logo-rules.d.ts","sourceRoot":"","sources":["../../../src/core/checker/logo-rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAG1E,yFAAyF;AACzF,eAAO,MAAM,wBAAwB,gCAAiC,CAAC;AAEvE,MAAM,WAAW,UAAU;IACzB,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAQhH;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,SAAS,EAAE,EAAE,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,EAAE,CAelI"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Finding, LogoSet, ThemeRole, TokenItem } from '../../types/index.js';
|
|
2
|
+
/** Below this ratio a color is taken to be the surface it is drawn on: WCAG's 3:1 for graphics is a requirement on a component, this is "not there at all". */
|
|
3
|
+
export declare const INVISIBLE_BELOW = 1.5;
|
|
4
|
+
/** The colors an SVG data URI paints, as written, without repeats. A raster, or anything that is not an SVG, paints none that can be read. */
|
|
5
|
+
export declare function paintedColors(src: string): string[];
|
|
6
|
+
export declare function logoSurfaceFindings(logo: LogoSet | undefined, theme: Partial<Record<ThemeRole, string>>, themeTokens: Partial<Record<ThemeRole, string>> | undefined, items: readonly TokenItem[]): Finding[];
|
|
7
|
+
//# sourceMappingURL=logo-surfaces.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logo-surfaces.d.ts","sourceRoot":"","sources":["../../../src/core/checker/logo-surfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAUnF,+JAA+J;AAC/J,eAAO,MAAM,eAAe,MAAM,CAAC;AAUnC,8IAA8I;AAC9I,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAUnD;AAaD,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,OAAO,GAAG,SAAS,EACzB,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,EACzC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,EAC3D,KAAK,EAAE,SAAS,SAAS,EAAE,GAC1B,OAAO,EAAE,CA6BX"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { DocItem, Finding, TokenItem } from '../../types/index.js';
|
|
2
|
+
/** How many named tokens a page may leave unshown before it is noted. */
|
|
3
|
+
export declare const NAMED_LIMIT = 5;
|
|
4
|
+
export declare function pageTokenFindings(docs: readonly DocItem[], items: readonly TokenItem[]): Finding[];
|
|
5
|
+
//# sourceMappingURL=page-tokens.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"page-tokens.d.ts","sourceRoot":"","sources":["../../../src/core/checker/page-tokens.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAQxE,yEAAyE;AACzE,eAAO,MAAM,WAAW,IAAI,CAAC;AAY7B,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,EAAE,CA2BlG"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Finding, TokenItem } from '../../types/index.js';
|
|
2
|
+
/**
|
|
3
|
+
* The `print` values of a token, each checked on its own:
|
|
4
|
+
* - `ral` is a RAL number such as "5012": one non-empty line, without the "RAL" the book writes before it.
|
|
5
|
+
* - `cmyk` is four numbers from 0 to 100, percent of each ink.
|
|
6
|
+
* - `pms` is a Pantone name such as "2945 C": one non-empty line.
|
|
7
|
+
*/
|
|
8
|
+
export declare function printFindings(item: TokenItem): Finding[];
|
|
9
|
+
//# sourceMappingURL=print.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"print.d.ts","sourceRoot":"","sources":["../../../src/core/checker/print.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAK/D;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,EAAE,CA2BxD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proportion.d.ts","sourceRoot":"","sources":["../../../src/core/checker/proportion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAOhF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,OAAO,EAAE,CAwBrI"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Finding, GroupMeta, Review, TokenItem } from '../../types/index.js';
|
|
2
|
+
/** Whether a text is a real calendar day written YYYY-MM-DD (2026-02-30 is not). */
|
|
3
|
+
export declare function isIsoDate(text: unknown): text is string;
|
|
4
|
+
/** Why a `review` is not valid, or undefined when it is. `fingerprint: false` for a group, which has no value of its own to fingerprint. */
|
|
5
|
+
export declare function reviewProblem(raw: unknown, options?: {
|
|
6
|
+
fingerprint?: boolean;
|
|
7
|
+
}): string | undefined;
|
|
8
|
+
/** The review as it is carried on: the known fields only, in a fixed order. Call it on a review `reviewProblem` accepted. */
|
|
9
|
+
export declare function cleanReview(raw: Review): Review;
|
|
10
|
+
/**
|
|
11
|
+
* `review-pending` on groups and tokens. A flagged group reports once, and its tokens do not repeat it
|
|
12
|
+
* (a group's `review` is not inherited, see walk.ts). A token's own `review-pending` reports on its own;
|
|
13
|
+
* its `ok` reports nothing. A `review` of the wrong shape is a `review-invalid` error.
|
|
14
|
+
*/
|
|
15
|
+
export declare function reviewFindings(items: readonly TokenItem[], groups: readonly GroupMeta[]): Finding[];
|
|
16
|
+
/**
|
|
17
|
+
* The text that is hashed for a token (fingerprint v1, RFC 0001 section 2): the JSON array [`$type` or null, resolved value]
|
|
18
|
+
* with the keys of every object sorted by UTF-16 code unit and no whitespace. A member whose value is undefined is left out.
|
|
19
|
+
*/
|
|
20
|
+
export declare const fingerprintInput: (item: Pick<TokenItem, "type" | "resolvedValue">) => string;
|
|
21
|
+
/**
|
|
22
|
+
* The fingerprint of what a person confirms on a token: its `$type` and its resolved value, with every alias replaced, in
|
|
23
|
+
* the default context. An approval therefore goes stale when the value changes, including through the token it aliases.
|
|
24
|
+
*/
|
|
25
|
+
export declare function tokenFingerprint(item: Pick<TokenItem, 'type' | 'resolvedValue'>): string;
|
|
26
|
+
/** The fingerprint of an asset: its file's bytes. The sidecar is where the approval is written, so editing it does not void it. */
|
|
27
|
+
export declare const assetFingerprint: (bytes: Uint8Array) => string;
|
|
28
|
+
/** One approval to compare: a recorded fingerprint against the current one. */
|
|
29
|
+
export interface Approval {
|
|
30
|
+
path: string;
|
|
31
|
+
review: Review;
|
|
32
|
+
/** Undefined when the value cannot be read (an unresolved alias, a missing file): nothing to compare */
|
|
33
|
+
current: string | undefined;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* `approval-stale`: a `review.status: ok` that recorded a `value` fingerprint, and the value is no longer that one. An
|
|
37
|
+
* approval with no fingerprint is never stale.
|
|
38
|
+
*/
|
|
39
|
+
export declare function staleFindings(approvals: readonly Approval[]): Finding[];
|
|
40
|
+
//# sourceMappingURL=review.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../../src/core/checker/review.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AASlF,oFAAoF;AACpF,wBAAgB,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,MAAM,CAIvD;AAED,4IAA4I;AAC5I,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,GAAE;IAAE,WAAW,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,MAAM,GAAG,SAAS,CAavG;AAED,6HAA6H;AAC7H,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAID;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,EAAE,CAWnG;AAcD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,CAAC,KAAG,MAA4D,CAAC;AAIhJ;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,CAAC,GAAG,MAAM,CAExF;AAED,mIAAmI;AACnI,eAAO,MAAM,gBAAgB,GAAI,OAAO,UAAU,KAAG,MAAuB,CAAC;AAE7E,+EAA+E;AAC/E,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,wGAAwG;IACxG,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,GAAG,OAAO,EAAE,CASvE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../src/core/checker/source.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAG/D,kFAAkF;AAClF,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,EAAE,CAIzD"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Why a font's `license` looks like an SPDX identifier but is not one, or undefined when it is one, or is a name.
|
|
3
|
+
* The field takes either (RFC 0001 section 2), so only a value that is trying to be an identifier is judged: a single
|
|
4
|
+
* word with a digit, a hyphen or a plus (`OFL-1.2`, `Apache2`), a known id in the wrong case (`mit`), or an
|
|
5
|
+
* expression joined by AND, OR or WITH. `SIL Open Font License 1.1` and `Proprietary` are names and are left alone.
|
|
6
|
+
*/
|
|
7
|
+
export declare function spdxNote(license: string): string | undefined;
|
|
8
|
+
//# sourceMappingURL=spdx.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spdx.d.ts","sourceRoot":"","sources":["../../../src/core/checker/spdx.ts"],"names":[],"mappings":"AAsBA;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAoB5D"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tier.d.ts","sourceRoot":"","sources":["../../../src/core/checker/tier.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAY/D,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,EAAE,CAMvD"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Finding, TokenItem, UsageRole } from '../../types/index.js';
|
|
2
|
+
export declare function allows(item: TokenItem, role: UsageRole): boolean;
|
|
3
|
+
export declare function usageFindings(item: TokenItem, byPath: Map<string, TokenItem>, roles: readonly string[]): Finding[];
|
|
4
|
+
//# sourceMappingURL=usage.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../../src/core/checker/usage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAQ1E,wBAAgB,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAMhE;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,EAAE,CA+BlH"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { Finding, ParsedTokens } from '../../types/index.js';
|
|
2
|
+
/**
|
|
3
|
+
* Two tokens whose names reduce to one CSS custom property (`foo-bar` and `foo.bar`) overwrite each other, and the
|
|
4
|
+
* stylesheet keeps the last. Checks theme.css (the tokens and the parts of composites), each resolver context's block
|
|
5
|
+
* and tailwind.css; the same name in two blocks is by design. typography.css writes no variables of its own.
|
|
6
|
+
*/
|
|
7
|
+
export declare function variableFindings(tokens: Pick<ParsedTokens, 'items' | 'contexts'>): Finding[];
|
|
8
|
+
//# sourceMappingURL=variables.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/core/checker/variables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAa,MAAM,sBAAsB,CAAC;AA0C7E;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,UAAU,CAAC,GAAG,OAAO,EAAE,CAe5F"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Whether output may use ANSI color: for a terminal, unless NO_COLOR is set, TERM is dumb or `--no-color` was given; FORCE_COLOR turns it on
|
|
3
|
+
* for a pipe (NO_COLOR still wins). The color library decides this on its own and reads any `--color` argument as "force color", which is
|
|
4
|
+
* what `blazon init --color <hex>` is not, so blazon decides and hands the library the answer.
|
|
5
|
+
*/
|
|
6
|
+
export declare function colorWanted(env: NodeJS.ProcessEnv, tty: boolean, argv: readonly string[]): boolean;
|
|
7
|
+
/** The color functions every command writes with. */
|
|
8
|
+
declare const pc: import('picocolors/types').Colors;
|
|
9
|
+
export default pc;
|
|
10
|
+
//# sourceMappingURL=colors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../src/core/colors.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAIlG;AAED,qDAAqD;AACrD,QAAA,MAAM,EAAE,mCAAiG,CAAC;AAC1G,eAAe,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../src/core/config/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEzD,eAAO,MAAM,cAAc,EAAE,YAW5B,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { BlazonConfig, UserBlazonConfig } from '../../types/index.js';
|
|
2
|
+
import { DEFAULT_CONFIG } from './defaults.js';
|
|
3
|
+
export { DEFAULT_CONFIG };
|
|
4
|
+
export { ConfigError, CONFIG_KEYS, resolveConfig } from './validate.js';
|
|
5
|
+
/** The one config file: plain JSON, read as data. It is never run. */
|
|
6
|
+
export declare const CONFIG_FILE = "blazon.json";
|
|
7
|
+
/** Spellings older blazons read as code. None is read any more: each is refused, by name, with the file to use. */
|
|
8
|
+
export declare const OLD_CONFIG_FILE_NAMES: string[];
|
|
9
|
+
/** The files in `cwd` that were once a config, so that the one blazon reads is not shadowed by one it ignores. */
|
|
10
|
+
export declare function oldConfigFiles(cwd: string): string[];
|
|
11
|
+
/**
|
|
12
|
+
* Loads blazon.json from the given root directory or defaults
|
|
13
|
+
*/
|
|
14
|
+
export declare function loadConfig(cwd?: string, overrides?: UserBlazonConfig): Promise<BlazonConfig>;
|
|
15
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/config/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE3E,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAI/C,OAAO,EAAE,cAAc,EAAE,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAExE,sEAAsE;AACtE,eAAO,MAAM,WAAW,gBAAgB,CAAC;AAEzC,mHAAmH;AACnH,eAAO,MAAM,qBAAqB,UAA8G,CAAC;AAEjJ,kHAAkH;AAClH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAEpD;AAeD;;GAEG;AACH,wBAAsB,UAAU,CAAC,GAAG,GAAE,MAAsB,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAkDjH"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { Finding, BlazonConfig } from '../../types/index.js';
|
|
2
|
+
/** Every key of `BlazonConfig`. A test holds this list to the interface. */
|
|
3
|
+
export declare const CONFIG_KEYS: readonly ["title", "description", "tokensDir", "docsDir", "assetsDir", "outDir", "tokensOutDir", "cssPrefix", "cssSelector", "port", "logo", "theme", "shadcn", "iconSets", "assets", "sections", "customSections", "vocabulary", "plugins", "fonts", "resolver", "contextSelectors", "emailSignature"];
|
|
4
|
+
export interface ResolvedConfig {
|
|
5
|
+
/** The config with every key that is wrong left out, so a default or nothing is used in its place */
|
|
6
|
+
config: BlazonConfig;
|
|
7
|
+
problems: Finding[];
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Checks a config's keys and the type of each value. A key set to `undefined` counts as absent. Each mistake is an
|
|
11
|
+
* error finding named `config-invalid`, on the key; the wrong value is left out of the returned config.
|
|
12
|
+
*/
|
|
13
|
+
export declare function resolveConfig(input: Record<string, unknown>): ResolvedConfig;
|
|
14
|
+
/** A config that stopped the run: the file's name, and every mistake in it. */
|
|
15
|
+
export declare class ConfigError extends Error {
|
|
16
|
+
readonly findings: Finding[];
|
|
17
|
+
constructor(file: string, findings: Finding[]);
|
|
18
|
+
}
|
|
19
|
+
/** The name of the config file in messages: its base name. */
|
|
20
|
+
export declare const configName: (file: string) => string;
|
|
21
|
+
//# sourceMappingURL=validate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/core/config/validate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAuF,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAS5J,4EAA4E;AAC5E,eAAO,MAAM,WAAW,ySAwB4B,CAAC;AAwRrD,MAAM,WAAW,cAAc;IAC7B,qGAAqG;IACrG,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,cAAc,CAqC5E;AAED,+EAA+E;AAC/E,qBAAa,WAAY,SAAQ,KAAK;IAGlC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE;gBAD5B,IAAI,EAAE,MAAM,EACH,QAAQ,EAAE,OAAO,EAAE;CAK/B;AAED,8DAA8D;AAC9D,eAAO,MAAM,UAAU,GAAI,MAAM,MAAM,KAAG,MAA6B,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { BlazonConfig, SectionInfo, Vocabulary } from '../../types/index.js';
|
|
2
|
+
/**
|
|
3
|
+
* What a value may name: the standard lockups, usage roles and sections, then the brand's additions (RFC 0002 §1).
|
|
4
|
+
* The config must already have been checked, so every addition is a valid, unrepeated name.
|
|
5
|
+
*/
|
|
6
|
+
export declare function resolveVocabulary(config: Pick<BlazonConfig, 'customSections' | 'vocabulary'>): {
|
|
7
|
+
vocabulary: Vocabulary;
|
|
8
|
+
sections: SectionInfo[];
|
|
9
|
+
};
|
|
10
|
+
//# sourceMappingURL=vocabulary.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vocabulary.d.ts","sourceRoot":"","sources":["../../../src/core/config/vocabulary.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,UAAU,EAChB,MAAM,sBAAsB,CAAC;AAE9B;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,gBAAgB,GAAG,YAAY,CAAC,GAAG;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,WAAW,EAAE,CAAA;CAAE,CAWlJ"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/** Whether `child` is `parent` or inside it, by path and not by spelling: `docs/` and `./docs` are one folder, `docs-site` is not inside `docs`. */
|
|
2
|
+
export declare function isWithin(parent: string, child: string): boolean;
|
|
3
|
+
/**
|
|
4
|
+
* The folder or file a path really is: the existing part of it with its links followed, and the rest as written. A link to an input, or a
|
|
5
|
+
* folder reached through one, is that input, whatever it is called. A path that does not exist yet is compared by the deepest part that does.
|
|
6
|
+
*/
|
|
7
|
+
export declare function canonical(target: string): string;
|
|
8
|
+
/** Whether `target` is the project folder or inside it, by where it really is: a link that leaves the folder is outside, whatever it is called. */
|
|
9
|
+
export declare const inProject: (cwd: string, target: string) => boolean;
|
|
10
|
+
/** The environment variable that names approved folders, separated by the platform's path delimiter. */
|
|
11
|
+
export declare const ALLOW_DIRS_ENV = "BLAZON_ALLOW_DIRS";
|
|
12
|
+
/**
|
|
13
|
+
* What the operator typed and set, as absolute folders with links followed: the `--allow-dir` values and the entries of BLAZON_ALLOW_DIRS,
|
|
14
|
+
* relative ones from `base` (the folder blazon was started in). An empty entry is left out.
|
|
15
|
+
*/
|
|
16
|
+
export declare function operatorDirs(typed: readonly string[], env: NodeJS.ProcessEnv, base: string): string[];
|
|
17
|
+
/** Sets the folders approved for this run, replacing the last list. The command line calls it once, before a command starts. */
|
|
18
|
+
export declare function setApprovedDirs(dirs: readonly string[]): void;
|
|
19
|
+
/** Whether `target` is the project folder or inside it, or inside a folder the operator approved: by where it really is, links followed. */
|
|
20
|
+
export declare function inProjectOrApproved(cwd: string, target: string): boolean;
|
|
21
|
+
/** The refusal for a folder that is outside and not approved: the same words whether or not it exists, and never the real path. */
|
|
22
|
+
export declare const notApprovedMessage: (what: string, as: string) => string;
|
|
23
|
+
/** What a path outside the project folder is called in a message: never the real path, which differs by machine and would name it. */
|
|
24
|
+
export declare const outsideMessage: (what: string, as: string) => string;
|
|
25
|
+
//# sourceMappingURL=confine.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"confine.d.ts","sourceRoot":"","sources":["../../src/core/confine.ts"],"names":[],"mappings":"AAMA,oJAAoJ;AACpJ,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAG/D;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAahD;AAED,mJAAmJ;AACnJ,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,EAAE,QAAQ,MAAM,KAAG,OAAsD,CAAC;AAM/G,wGAAwG;AACxG,eAAO,MAAM,cAAc,sBAAsB,CAAC;AAIlD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAGrG;AAED,gIAAgI;AAChI,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAE7D;AAED,4IAA4I;AAC5I,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAGxE;AAED,mIAAmI;AACnI,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,EAAE,IAAI,MAAM,KAAG,MAC0M,CAAC;AAEzQ,sIAAsI;AACtI,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,IAAI,MAAM,KAAG,MAC+G,CAAC"}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import { AssetCatalog, AssetMeta, Finding, DocItem, IconSet, ParsedTokens, TokenItem } from '../../types/index.js';
|
|
2
|
+
/** Which tokens a directive argument may name. */
|
|
3
|
+
export type TokenKind = 'any' | 'paint' | 'border' | 'paint-or-border';
|
|
4
|
+
export interface DirectiveSpec {
|
|
5
|
+
/** The first argument names an asset folder (`icons`, `logo-usage`, a custom folder) */
|
|
6
|
+
folder?: boolean;
|
|
7
|
+
/** Arguments after the folder name assets in it; with none, the whole folder */
|
|
8
|
+
assetNames?: boolean;
|
|
9
|
+
/** The token paths the directive takes, by what each must resolve to */
|
|
10
|
+
tokens?: TokenKind;
|
|
11
|
+
/** The paths name groups that are social formats or patterns (RFC 0001 §8) */
|
|
12
|
+
groups?: 'format' | 'pattern';
|
|
13
|
+
/** Takes no arguments at all */
|
|
14
|
+
bare?: boolean;
|
|
15
|
+
/** The first argument names an icon set from `iconSets`; the rest name its categories */
|
|
16
|
+
iconSet?: boolean;
|
|
17
|
+
/** Draws the configured logo, so it is an error to use without one */
|
|
18
|
+
needsLogo?: boolean;
|
|
19
|
+
/** The arguments are this many asset ids, each written `category/name`, then (with `text`) an optional free text */
|
|
20
|
+
assetRefs?: number;
|
|
21
|
+
/** After the asset ids, one optional free-text argument: a URL, a name */
|
|
22
|
+
text?: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* Draws what an asset's sidecar states: at least one of these fields must be stated. For a folder
|
|
25
|
+
* directive, by at least one asset it names; for asset ids, by the first.
|
|
26
|
+
*/
|
|
27
|
+
needsMeta?: readonly (keyof AssetMeta)[];
|
|
28
|
+
/** Generates from the config's `emailSignature` block, so it is an error to use without one */
|
|
29
|
+
needsEmailSignature?: boolean;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Every `<!-- blazon:name args -->` a guideline page may place. The viewer renders each from this table
|
|
33
|
+
* and `blazon check` validates each page against it, so a new directive is one entry here and one
|
|
34
|
+
* component in the viewer.
|
|
35
|
+
*/
|
|
36
|
+
export declare const DIRECTIVES: {
|
|
37
|
+
readonly tokens: {
|
|
38
|
+
readonly tokens: "any";
|
|
39
|
+
};
|
|
40
|
+
readonly assets: {
|
|
41
|
+
readonly folder: true;
|
|
42
|
+
readonly assetNames: true;
|
|
43
|
+
};
|
|
44
|
+
readonly section: {
|
|
45
|
+
readonly folder: true;
|
|
46
|
+
readonly assetNames: true;
|
|
47
|
+
};
|
|
48
|
+
readonly icons: {
|
|
49
|
+
readonly folder: true;
|
|
50
|
+
readonly tokens: "paint";
|
|
51
|
+
};
|
|
52
|
+
readonly 'logo-usage': {
|
|
53
|
+
readonly bare: true;
|
|
54
|
+
readonly needsLogo: true;
|
|
55
|
+
};
|
|
56
|
+
readonly 'logo-on': {
|
|
57
|
+
readonly tokens: "paint";
|
|
58
|
+
readonly needsLogo: true;
|
|
59
|
+
};
|
|
60
|
+
readonly 'logo-contrast': {
|
|
61
|
+
readonly tokens: "paint";
|
|
62
|
+
readonly needsLogo: true;
|
|
63
|
+
};
|
|
64
|
+
readonly 'logo-space': {
|
|
65
|
+
readonly folder: true;
|
|
66
|
+
readonly assetNames: true;
|
|
67
|
+
readonly needsMeta: readonly ["clearSpace", "minSize"];
|
|
68
|
+
};
|
|
69
|
+
readonly 'logo-lockups': {
|
|
70
|
+
readonly folder: true;
|
|
71
|
+
readonly assetNames: true;
|
|
72
|
+
readonly needsMeta: readonly ["lockup"];
|
|
73
|
+
};
|
|
74
|
+
readonly 'logo-partner': {
|
|
75
|
+
readonly assetRefs: 2;
|
|
76
|
+
readonly needsMeta: readonly ["partnership"];
|
|
77
|
+
};
|
|
78
|
+
readonly 'logo-initiative': {
|
|
79
|
+
readonly assetRefs: 1;
|
|
80
|
+
readonly needsMeta: readonly ["initiative"];
|
|
81
|
+
};
|
|
82
|
+
readonly 'logo-placement': {
|
|
83
|
+
readonly assetRefs: 1;
|
|
84
|
+
readonly text: true;
|
|
85
|
+
readonly needsMeta: readonly ["placement"];
|
|
86
|
+
};
|
|
87
|
+
readonly cards: {
|
|
88
|
+
readonly tokens: "paint";
|
|
89
|
+
};
|
|
90
|
+
readonly strokes: {
|
|
91
|
+
readonly tokens: "border";
|
|
92
|
+
};
|
|
93
|
+
readonly spots: {
|
|
94
|
+
readonly tokens: "paint-or-border";
|
|
95
|
+
};
|
|
96
|
+
readonly 'icon-set': {
|
|
97
|
+
readonly iconSet: true;
|
|
98
|
+
};
|
|
99
|
+
readonly formats: {
|
|
100
|
+
readonly groups: "format";
|
|
101
|
+
};
|
|
102
|
+
readonly patterns: {
|
|
103
|
+
readonly groups: "pattern";
|
|
104
|
+
};
|
|
105
|
+
readonly 'email-signature': {
|
|
106
|
+
readonly bare: true;
|
|
107
|
+
readonly needsEmailSignature: true;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
export type DirectiveName = keyof typeof DIRECTIVES;
|
|
111
|
+
export declare function isDirective(name: string): name is DirectiveName;
|
|
112
|
+
export declare function isPaint(token: TokenItem): boolean;
|
|
113
|
+
export declare function isBorder(token: TokenItem): boolean;
|
|
114
|
+
/** The tokens a path names: the token itself, or every token under it when it is a group ("icon.marketing", "icon.marketing.*"). */
|
|
115
|
+
export declare function tokensAt(items: readonly TokenItem[], path: string): TokenItem[];
|
|
116
|
+
/** The tokens a path names that a directive argument of this kind accepts. */
|
|
117
|
+
export declare function tokensOfKind(items: readonly TokenItem[], path: string, kind: TokenKind): TokenItem[];
|
|
118
|
+
export interface PlacedDirective {
|
|
119
|
+
name: string;
|
|
120
|
+
args: string[];
|
|
121
|
+
/** The comment as written, for messages */
|
|
122
|
+
text: string;
|
|
123
|
+
}
|
|
124
|
+
/** The Markdown with its fenced code blocks (``` and ~~~) cut out, so what a page shows as an example is not read as the page. */
|
|
125
|
+
export declare const withoutFences: (markdown: string) => string;
|
|
126
|
+
/**
|
|
127
|
+
* The directives a page's Markdown places. Code fences and inline code are skipped: a page that shows
|
|
128
|
+
* the syntax as an example must not be taken to use it.
|
|
129
|
+
*/
|
|
130
|
+
export declare function directivesIn(markdown: string): PlacedDirective[];
|
|
131
|
+
export interface DirectiveContext {
|
|
132
|
+
tokens: Pick<ParsedTokens, 'items' | 'groupMeta'>;
|
|
133
|
+
assets: AssetCatalog;
|
|
134
|
+
hasLogo: boolean;
|
|
135
|
+
/** Icon sets read from packages; absent means none */
|
|
136
|
+
iconSets?: IconSet[];
|
|
137
|
+
/** Local categories whose images are not in this checkout: a directive that needs them is not checked */
|
|
138
|
+
absentLocal?: ReadonlySet<string>;
|
|
139
|
+
/** The logo files are in such a category */
|
|
140
|
+
logoIsAbsentLocal?: boolean;
|
|
141
|
+
/** Ids of assets in experimental or reference categories: drawing one is not `page-review-pending` */
|
|
142
|
+
ungated?: ReadonlySet<string>;
|
|
143
|
+
/** The config has an `emailSignature` block */
|
|
144
|
+
hasEmailSignature?: boolean;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Checks every directive on every page: a known name, the right number of arguments, and arguments that
|
|
148
|
+
* resolve to what the directive draws. The viewer shows a red line for the same mistakes; this makes
|
|
149
|
+
* them a build error.
|
|
150
|
+
*/
|
|
151
|
+
export declare function directiveFindings(docs: readonly DocItem[], context: DirectiveContext): Finding[];
|
|
152
|
+
//# sourceMappingURL=directives.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"directives.d.ts","sourceRoot":"","sources":["../../../src/core/docs/directives.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAIxH,kDAAkD;AAClD,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC5B,wFAAwF;IACxF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gFAAgF;IAChF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,wEAAwE;IACxE,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,8EAA8E;IAC9E,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC9B,gCAAgC;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,yFAAyF;IACzF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,oHAAoH;IACpH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,SAAS,CAAC,EAAE,CAAC;IACzC,+FAA+F;IAC/F,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoB2B,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,UAAU,CAAC;AAEpD,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,aAAa,CAE/D;AAID,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAEjD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAElD;AASD,oIAAoI;AACpI,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,CAK/E;AAED,8EAA8E;AAC9E,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,CAEpG;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,kIAAkI;AAClI,eAAO,MAAM,aAAa,GAAI,UAAU,MAAM,KAAG,MAAwE,CAAC;AAE1H;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,EAAE,CAOhE;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,WAAW,CAAC,CAAC;IAClD,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,yGAAyG;IACzG,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,4CAA4C;IAC5C,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,sGAAsG;IACtG,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9B,+CAA+C;IAC/C,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAwID;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,EAAE,CAEhG"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DocItem, Finding, SectionId } from '../../types/index.js';
|
|
2
|
+
/**
|
|
3
|
+
* Reads every Markdown page in `docsDir`. A page whose front matter is not valid YAML is left out
|
|
4
|
+
* and reported in `problems`, so `blazon check` fails instead of the page silently losing its metadata.
|
|
5
|
+
*/
|
|
6
|
+
export declare function parseDocs(docsDir: string, problems?: Finding[], validSections?: readonly SectionId[], root?: string): DocItem[];
|
|
7
|
+
//# sourceMappingURL=parser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../../src/core/docs/parser.ts"],"names":[],"mappings":"AAIA,OAAO,EAAwB,KAAK,OAAO,EAAuB,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAO7H;;;GAGG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAO,EAAO,EAAE,aAAa,GAAE,SAAS,SAAS,EAAyB,EAAE,IAAI,GAAE,MAA8B,GAAG,OAAO,EAAE,CA2GhL"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { DocItem, Finding, SectionId } from '../../types/index.js';
|
|
2
|
+
/** The sections a page's `section:` names: one id or a list. Absent means none. */
|
|
3
|
+
export declare function pageSections(value: unknown, file: string, valid: readonly SectionId[], problems: Finding[]): SectionId[];
|
|
4
|
+
/** The `sections` config: the sections this brand expects, or undefined for all of them. */
|
|
5
|
+
export declare function configuredSections(value: unknown, valid: readonly SectionId[], problems: Finding[]): SectionId[] | undefined;
|
|
6
|
+
/**
|
|
7
|
+
* One info finding for each expected section no page holds. A project that has not started to use sections (no
|
|
8
|
+
* page declares one and the config lists none) is not told about all of them.
|
|
9
|
+
*/
|
|
10
|
+
export declare function missingSections(docs: readonly DocItem[], configured: SectionId[] | undefined, valid: readonly SectionId[]): Finding[];
|
|
11
|
+
//# sourceMappingURL=sections.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sections.d.ts","sourceRoot":"","sources":["../../../src/core/docs/sections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAkBxE,mFAAmF;AACnF,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE,CAExH;AAED,4FAA4F;AAC5F,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,SAAS,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE,GAAG,SAAS,CAO5H;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,EAAE,CAWrI"}
|