@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
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 iksnerd
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,265 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Blazon
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Design tokens, guidelines and brand assets in one repo, compiled into CSS, TypeScript and a brand book that looks like your brand.
|
|
4
|
+
|
|
5
|
+
[Manual](docs/manual/index.md) · [Blazon's own brand book, as source](examples/blazon/) · [Plugins](#plugins) · [Architecture](ARCHITECTURE.md) · [RFCs](docs/rfc)
|
|
6
|
+
|
|
7
|
+
[](LICENSE) 
|
|
8
|
+
|
|
9
|
+

|
|
10
|
+
|
|
11
|
+
Brand guidelines usually live in a PDF or a slide deck, and the values developers need are copied out of it by hand. Blazon keeps them in the repo as [DTCG](https://www.designtokens.org/TR/2025.10/format/) (Design Tokens Community Group) token files and Markdown. One build writes the CSS variables, a typed TypeScript module and a static brand book, and `blazon check` fails the build when a token breaks the brand's own rules. It reads the same DTCG files as Style Dictionary and Tokens Studio, and adds the rules, the checks and the book.
|
|
12
|
+
|
|
13
|
+
> **Status: pre-release (0.1.0).** Not published to npm yet. The package is named `@iksnerd/blazon`. The npm package named `blazon` is an unrelated project (a type checker), so `npx blazon` does not run this tool and must not be used to try it.
|
|
14
|
+
>
|
|
15
|
+
> Once published, run it with `npx @iksnerd/blazon`, or install it in a project and run `npx --no-install blazon` or `./node_modules/.bin/blazon`. The name can still change before the first publish.
|
|
16
|
+
|
|
17
|
+
Jump to: [Quick start](#quick-start), [Set up with your agent](#set-up-with-your-agent), [Use blazon from your agent (MCP)](#use-blazon-from-your-agent-mcp), [When not to use blazon](#when-not-to-use-blazon), [How it works](#how-it-works), [Plugins](#plugins), [Commands](#commands), [Configuration](#configuration), [Versioning and stability](#versioning-and-stability), [Security](#security), [Documentation](#documentation), [Contributing](#contributing).
|
|
18
|
+
|
|
19
|
+
## Quick start
|
|
20
|
+
|
|
21
|
+
Node 24 or later; macOS and Linux, and WSL on Windows is untried. Blazon is not published, so clone it, build it once and run it from the clone:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
git clone https://github.com/iksnerd/blazon.git
|
|
25
|
+
cd blazon
|
|
26
|
+
npm ci
|
|
27
|
+
npm run build # builds dist/, which bin/blazon.js runs
|
|
28
|
+
node bin/blazon.js init my-brand
|
|
29
|
+
node bin/blazon.js dev my-brand # the book, with live reload, at http://localhost:3000
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
There is no `blazon` on your PATH until you run `npm link` in the clone. The rest of this README writes `blazon`; without the link, write `node bin/blazon.js` in its place.
|
|
33
|
+
|
|
34
|
+
`blazon init` copies blazon's own brand book, [`examples/blazon/`](examples/blazon/), into the folder:
|
|
35
|
+
|
|
36
|
+
```text
|
|
37
|
+
my-brand/
|
|
38
|
+
├── tokens/ colors.json, typography.json, spacing.json, form.json, social.json (DTCG), and theme/dark.json
|
|
39
|
+
├── docs/ twelve pages, from principles, logo and color to diagrams, social, applications, voice and the web
|
|
40
|
+
├── assets/ logos/, construction/, backgrounds/ and icons/, each file with a <name>.json sidecar
|
|
41
|
+
├── fonts/ the mono typeface as two font files, with its licence
|
|
42
|
+
├── AGENTS.md notes for a coding agent that edits the brand (CLAUDE.md points to it)
|
|
43
|
+
├── blazon.resolver.json loads the token files and the dark theme
|
|
44
|
+
└── blazon.json
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The book starts as blazon's brand and becomes yours as you replace it. `blazon check` notes every file that is still the starter's text, which is the list of what is left to do, and warns about each logo that is still blazon's own. To start from a company's site instead, run `blazon init acme-brand --from https://acme.com`: blazon reads the page and its stylesheets for colors, fonts and the logo, and flags each value `needs-review` until the brand owner confirms it ([how](docs/manual/01-getting-started.md#starting-from-a-live-site)).
|
|
48
|
+
|
|
49
|
+
To look at a finished book first, run blazon's own brand book from the clone with no build: `npm run dev:blazon`.
|
|
50
|
+
|
|
51
|
+
## Set up with your agent
|
|
52
|
+
|
|
53
|
+
Paste this into a coding agent (Claude Code, Codex, Cursor) in the folder where the brand should live. Replace `<path to your blazon clone>`, and give the agent your colors, fonts and logo, or a site address. Blazon is not published; once it is, the first line becomes the package install.
|
|
54
|
+
|
|
55
|
+
```text
|
|
56
|
+
Set up a blazon brand book here. Blazon is not on npm: build it from my clone at <path to your blazon clone>
|
|
57
|
+
with `npm install && npm run build` there, then run it as `node <that path>/bin/blazon.js`.
|
|
58
|
+
Run `blazon init brand` (add `--from <site url>` to read a site's colors, fonts and logo).
|
|
59
|
+
Read brand/AGENTS.md and follow it. Replace the starter's tokens, docs and assets with my brand:
|
|
60
|
+
<my colors, fonts and logo, or the site address>. Ask me for any color, font or license you
|
|
61
|
+
do not have; do not guess one. Run `blazon check brand` and fix each finding until it reports no
|
|
62
|
+
errors, then run `blazon build brand` and tell me what is still marked needs-review.
|
|
63
|
+
Then run `blazon mcp --check --brand brand`; if it reports a failed check or `registered: false`,
|
|
64
|
+
run the `fix` it names, and register the server with `blazon mcp --print-config --brand brand`.
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Use blazon from your agent (MCP)
|
|
68
|
+
|
|
69
|
+
A coding agent can ask blazon about the brand as tool calls (`check_brand`, `get_token`, `can_use` and five more, all read-only) instead of reading token files. The server is a separate program in `mcp/`, not published to npm, so build it, print the config for your client and check that it works:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npm run build -w mcp # in the blazon clone, once
|
|
73
|
+
blazon mcp --print-config --client claude-code --brand my-brand
|
|
74
|
+
blazon mcp --check --brand my-brand # built? finds blazon? answers a real handshake? registered?
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
`blazon mcp --check` writes no file, prints a `fix` command for each check that fails, and exits 1 when the server is not ready. It starts the server on the brand folder, which compiles it with no plugin; what a brand says reaches your agent as tool results, so use a brand you trust. [Blazon for agents](docs/manual/20-blazon-for-agents.md) has the tools and the clients. For an agent that reads skills, [`skills/blazon/SKILL.md`](skills/blazon/SKILL.md) teaches the loop (check, contrast, MCP tools, what never to edit).
|
|
78
|
+
|
|
79
|
+
## A rule that fails the build
|
|
80
|
+
|
|
81
|
+
The rules of a brand sit next to its values. In blazon's own tokens, the signal colors are never body text:
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
"signal": {
|
|
85
|
+
"$extensions": { "dev.blazon": { "usage": { "deny": ["text"] } } },
|
|
86
|
+
"orange": { "$value": "#FF5A1F" }
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
A token that sets text in Signal Orange breaks that rule, and `blazon check` says so:
|
|
91
|
+
|
|
92
|
+
```text
|
|
93
|
+
ERROR tokens/colors.json:155 text.warning: Used as text, but {color.signal.orange} is not allowed as text [usage-violated]
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
The same token is written as `--color-signal-orange: #FF5A1F;` in `theme.css` and as the flat key `"color.signal.orange"` in `tokens.ts`. `tokens.json` nests the same value under `color` > `signal` > `orange`.
|
|
97
|
+
|
|
98
|
+
`blazon tokens` and `blazon build` run the check first and stop on an error, so the brand's rules hold in CI as well as in review.
|
|
99
|
+
|
|
100
|
+
## When not to use blazon
|
|
101
|
+
|
|
102
|
+
- **You need a release you can install.** Blazon is pre-release and not on npm; you build it from a clone.
|
|
103
|
+
- **You need many output formats.** Blazon writes CSS, Tailwind v4, TypeScript and JSON, and the platform plugin writes Android, Swift and Kotlin for colors and dimensions only. [Style Dictionary](https://styledictionary.com) has a general system of custom transforms and formats.
|
|
104
|
+
- **You want rules enforced in a design tool.** Blazon reads token files in the repo and does not sync with Figma or Tokens Studio. A file exported from them works if it is DTCG 2025.10, but the `usage` roles and `tier` names are blazon's, so the editor will not enforce them.
|
|
105
|
+
- **You are on Windows.** It is tested on macOS and Linux with Node 24; WSL is untried.
|
|
106
|
+
|
|
107
|
+
## How it works
|
|
108
|
+
|
|
109
|
+
```mermaid
|
|
110
|
+
flowchart LR
|
|
111
|
+
T["tokens/<br>DTCG JSON"] --> C[compile]
|
|
112
|
+
D["docs/<br>Markdown"] --> C
|
|
113
|
+
A["assets/<br>files and sidecars"] --> C
|
|
114
|
+
C --> K{"blazon check"}
|
|
115
|
+
K -->|errors| X[build stops]
|
|
116
|
+
K -->|passes| O1["theme.css, tokens.ts,<br>tokens.json"]
|
|
117
|
+
K -->|passes| O2[static brand book]
|
|
118
|
+
K -->|passes| O3[brand.json]
|
|
119
|
+
O2 --> P["build plugins<br>deck, press kit, favicons ..."]
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
The same compile feeds the dev server, so a change to a token, a page or the config reloads in the browser.
|
|
123
|
+
|
|
124
|
+
## What it does
|
|
125
|
+
|
|
126
|
+
- **Reads DTCG 2025.10 tokens.** Every `.json` file in `tokens/` merges into one tree, aliases are full paths (`{color.brand.indigo}`), and composite types (typography, gradient, shadow, border, transition) are supported. [Tokens](docs/manual/02-tokens.md)
|
|
127
|
+
- **Holds the brand's rules, not only its values.** `$extensions["dev.blazon"]` carries where a token may be used, its role and tier, print specs (CMYK, PMS, RAL), contrast pairs, forbidden logo backgrounds and proportions.
|
|
128
|
+
- **Varies them by context.** A [DTCG resolver document](https://www.designtokens.org/TR/2025.10/resolver/) declares modifiers such as `locale` or `theme`. Each context compiles to its own CSS block holding only what it changes, and the book gets a switcher. [Contexts](docs/manual/04-contexts.md)
|
|
129
|
+
- **Checks them.** Bad aliases and types, a token used where its source denies it, contrast below its level, duplicate values, values still marked for review, malformed asset sidecars, page directives that name nothing, and more. [Every finding](docs/manual/03-checks.md)
|
|
130
|
+
- **Writes code.** `theme.css`, `typography.css`, a Tailwind v4 `tailwind.css` with an optional `tailwind-reset.css` that closes Tailwind's defaults, a typed `tokens.ts` and a `tokens.json` with aliases resolved. [Using the outputs](docs/manual/08-using-the-outputs.md)
|
|
131
|
+
- **Exports the whole brand.** `blazon build` also writes `brand.json`: the tokens with their rules, the pages, the assets and the findings, in one versioned file with a JSON Schema, readable from any language. [`brand.json`](docs/manual/11-brand-json.md)
|
|
132
|
+
- **Builds a brand book that wears the brand.** The viewer takes its colors, typefaces and logo from your tokens. Pages place live content from them: swatches, the type scale, the logo on each background with its clear space, icons, patterns and social formats. It has search, a dark mode, and a Review page listing what `blazon check` found. [Pages](docs/manual/05-pages.md), [assets and icons](docs/manual/06-assets-and-icons.md)
|
|
133
|
+
- **Compares them with a live site.** `blazon drift <url-or-css-file>` reports which tokens that name a `source.cssVar` have changed since.
|
|
134
|
+
- **Answers a coding agent.** The read commands (`blazon get`, `blazon rules`, `blazon can` and the rest) print JSON, and a separate read-only server in `mcp/` offers them as tool calls over the Model Context Protocol. It is not published: build it from the repository. [Building a website from a brand](docs/manual/19-building-a-website.md), [Blazon for agents](docs/manual/20-blazon-for-agents.md)
|
|
135
|
+
- **Extends with plugins.** See below.
|
|
136
|
+
|
|
137
|
+
## Plugins
|
|
138
|
+
|
|
139
|
+
A plugin is a program, in any language, that blazon runs for a check or a build step. Blazon ships ten, so there is nothing to install: name one in `blazon.json` and run `blazon build`. A plugin starts with an empty environment and gets only the variables its manifest lists and you approve in its entry's `env`. The ones that draw in Chrome list `BLAZON_CHROME`, `HOME` and `TMPDIR`:
|
|
140
|
+
|
|
141
|
+
```json
|
|
142
|
+
{
|
|
143
|
+
"plugins": [
|
|
144
|
+
{ "name": "blazon.brand-deck", "env": ["BLAZON_CHROME", "BLAZON_DECK_FONTS", "HOME", "TMPDIR"] },
|
|
145
|
+
{ "name": "blazon.print-book", "env": ["BLAZON_CHROME", "HOME", "TMPDIR"] }
|
|
146
|
+
]
|
|
147
|
+
}
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
A plugin whose manifest lists a variable that is set, and that the entry does not approve, is not started, and the error names the variable and the key to add.
|
|
151
|
+
|
|
152
|
+
| Plugin | Writes |
|
|
153
|
+
|---|---|
|
|
154
|
+
| [`blazon.brand-deck`](docs/manual/14-shipped-plugins.md#blazonbrand-deck) | A PDF deck of 16:9 slides |
|
|
155
|
+
| [`blazon.print-book`](docs/manual/14-shipped-plugins.md#blazonprint-book) | The brand book as a PDF and a PowerPoint of pictures |
|
|
156
|
+
| [`blazon.copy`](docs/manual/14-shipped-plugins.md#blazoncopy) | Findings for text that breaks the brand's word rules: avoided terms, title-case headings, long sentences |
|
|
157
|
+
| [`blazon.favicons`](docs/manual/14-shipped-plugins.md#blazonfavicons) | The favicon and app-icon set, and warnings for a symbol too small or too faint |
|
|
158
|
+
| [`blazon.logo-geometry`](docs/manual/14-shipped-plugins.md#blazonlogo-geometry) | Each logo's symmetry, balance and grid, and a construction figure |
|
|
159
|
+
| [`blazon.logo-kit`](docs/manual/14-shipped-plugins.md#blazonlogo-kit) | Lockups beside each partner's logo and a clear-space sheet |
|
|
160
|
+
| [`blazon.office-template`](docs/manual/14-shipped-plugins.md#blazonoffice-template) | An editable PowerPoint template with the brand's theme |
|
|
161
|
+
| [`blazon.platform-tokens`](docs/manual/14-shipped-plugins.md#blazonplatform-tokens) | Android XML, Swift and Kotlin from the color and dimension tokens |
|
|
162
|
+
| [`blazon.press-kit`](docs/manual/14-shipped-plugins.md#blazonpress-kit) | A folder and zip for people outside the brand: logos, colors, fonts, a one-page PDF |
|
|
163
|
+
| [`blazon.social-cards`](docs/manual/14-shipped-plugins.md#blazonsocial-cards) | Marketing images from the tokens and logo, checked for contrast |
|
|
164
|
+
|
|
165
|
+
Several need Chrome for their PDF or PNG output; the manual says which. The starter's config enables `blazon.copy` with blazon's own rules, and leaves out the other plugins of blazon's own book (the deck, the social cards, the favicons, the logo kit, the press kit and the platform and Office files), because most need Chrome and a new book has no use for the kits yet; add one by name when you want it. To write your own, see [Writing a plugin](docs/manual/13-writing-a-plugin.md). A plugin can be pinned, so one that changed on disk does not run.
|
|
166
|
+
|
|
167
|
+
## Using the tokens
|
|
168
|
+
|
|
169
|
+
A token's CSS variable is its path, kebab-cased: `interactive.primary` is `--interactive-primary`.
|
|
170
|
+
|
|
171
|
+
```css
|
|
172
|
+
@import './dist/tokens/theme.css';
|
|
173
|
+
|
|
174
|
+
.button { background: var(--interactive-primary); }
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
```ts
|
|
178
|
+
import { getToken, getVar } from './dist/tokens/tokens';
|
|
179
|
+
|
|
180
|
+
getToken('space.4'); // "16px"
|
|
181
|
+
getVar('interactive.primary'); // "var(--interactive-primary)"
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
## Commands
|
|
185
|
+
|
|
186
|
+
| Command | Does |
|
|
187
|
+
|---|---|
|
|
188
|
+
| `blazon init [dir]` | Copy the starter into `dir`, asking for a name, color, font and logo in a terminal. `--from <url>` starts from a live site |
|
|
189
|
+
| `blazon dev [dir]` | Start the dev server with live reload |
|
|
190
|
+
| `blazon check [dir]` | Report findings; exits 1 on errors (`--strict` also fails on warnings, `--json` prints them as JSON) |
|
|
191
|
+
| `blazon tokens [dir]` | Check, then write `dist/tokens/` |
|
|
192
|
+
| `blazon build [dir]` | Check, then write the tokens and the site to `dist/site/` |
|
|
193
|
+
| `blazon preview [dir]` | Serve the built site |
|
|
194
|
+
| `blazon drift <url-or-css-file>` | Compare tokens with a live site |
|
|
195
|
+
| `blazon list [group]`, `blazon get <path>`, `blazon rules [path]`, `blazon can <fg> <bg>`, `blazon fonts`, `blazon logo`, `blazon brand` | List the tokens, read one, its rules, a text-on-background answer, the fonts, the logo or the whole compiled brand (`blazon brand`, always JSON); `--json` prints JSON |
|
|
196
|
+
| `blazon explain [code]` | Say what a finding code means, its severity, the fix and where to read more; with no code, list every code |
|
|
197
|
+
| `blazon doctor` | Check this machine and folder: Node version, brand folder, plugin folder safety, Chrome (if a plugin needs it) and `blazon.lock`. Writes nothing |
|
|
198
|
+
| `blazon pin [dir]` | Write `blazon.lock`, so only the pinned blazon runs `check`, `tokens` and `build` |
|
|
199
|
+
|
|
200
|
+
`blazon approvals`, `blazon mcp` (`--print-config`, `--check`) and `blazon plugin check`, `pin` and `profile` are in the [manual](docs/manual/01-getting-started.md#commands) with every flag.
|
|
201
|
+
|
|
202
|
+
## Configuration
|
|
203
|
+
|
|
204
|
+
`blazon.json` is optional. The common options:
|
|
205
|
+
|
|
206
|
+
```json
|
|
207
|
+
{
|
|
208
|
+
"title": "Acme Brand Book",
|
|
209
|
+
"theme": { "accent": "interactive.primary", "text": "text.primary", "fontDisplay": "font.family.display" },
|
|
210
|
+
"logo": { "onLight": "./assets/logos/logo-black.svg", "onDark": "./assets/logos/logo-white.svg" },
|
|
211
|
+
"iconSets": [
|
|
212
|
+
{
|
|
213
|
+
"name": "lucide",
|
|
214
|
+
"package": "lucide-static",
|
|
215
|
+
"categories": { "Navigation": [ "arrow-left", "house" ] }
|
|
216
|
+
}
|
|
217
|
+
],
|
|
218
|
+
"fonts": [ "https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap" ]
|
|
219
|
+
}
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
Every option and the theme roles are in [Theme and configuration](docs/manual/07-theme-and-config.md). The file is plain JSON, read as data and never run: no comments, no code. A config written as `blazon.config.ts` (or `.js`, `.mjs`, or `brandbook.config.*`) is refused with an error that names the file; move its values into `blazon.json`. The functions the CLI uses are exported for scripts (`compileBlazonData`, `checkTokens`, `emitTokenOutputs`, `buildSite`, `startDevServer` and more; see `src/index.ts`).
|
|
223
|
+
|
|
224
|
+
## Examples
|
|
225
|
+
|
|
226
|
+
- [`examples/blazon/`](examples/blazon/): blazon's own brand book, made from scratch: 79 tokens, a light and a dark theme, twelve pages, and `blazon check examples/blazon` reports no findings (a copy made with `blazon init` also notes each starter file and warns about the two logos until you replace them). It is also the starter `blazon init` copies.
|
|
227
|
+
- [`examples/conformance/`](examples/conformance/): a small fictional brand for the parts of the data model the starter does not reach: review approvals, font metadata, a logo initiative and an experimental asset category. It is the conformance fixture for the tests.
|
|
228
|
+
|
|
229
|
+
Brand books made from other companies' guidelines are not shipped in this repository, because their art and text belong to those companies. A maintainer can keep them locally; see [CONTRIBUTING](CONTRIBUTING.md#reference-material-maintainers-only).
|
|
230
|
+
|
|
231
|
+
## Versioning and stability
|
|
232
|
+
|
|
233
|
+
While blazon is 0.x, a breaking change to a stable surface raises the minor version and is listed under "Breaking" in the [CHANGELOG](CHANGELOG.md). [Chapter 18](docs/manual/18-stability.md) says which surfaces are stable, what each kind of release may contain, and what 1.0 will require (a plan, not yet met).
|
|
234
|
+
|
|
235
|
+
## Security
|
|
236
|
+
|
|
237
|
+
To report a vulnerability, read [SECURITY.md](SECURITY.md). Do not open a public issue.
|
|
238
|
+
|
|
239
|
+
## Documentation
|
|
240
|
+
|
|
241
|
+
- [Manual](docs/manual/index.md): how to use blazon, chapter by chapter, from [getting started](docs/manual/01-getting-started.md) to [maintaining a brand book](docs/manual/15-maintaining-a-brand-book.md), with [troubleshooting](docs/manual/10-troubleshooting.md) and [deriving your own brand](docs/manual/09-derive-your-own.md). The [glossary](docs/manual/16-glossary.md) defines every word, [the data model](docs/manual/17-data-model.md) lists every field, and [stability](docs/manual/18-stability.md) says what a brand can rely on when it moves its pin.
|
|
242
|
+
- [Architecture](ARCHITECTURE.md): the layers of `src/`, a code map and the invariants, for someone about to change blazon.
|
|
243
|
+
- RFCs, each with a Status table of what is built:
|
|
244
|
+
[0001 data model](docs/rfc/0001-data-model.md),
|
|
245
|
+
[0002 extension model](docs/rfc/0002-extension-model.md),
|
|
246
|
+
[0003 adopting blazon](docs/rfc/0003-adopting-blazon.md),
|
|
247
|
+
[0004 format rules](docs/rfc/0004-format-rules.md),
|
|
248
|
+
[0005 plugin protocol](docs/rfc/0005-plugin-protocol.md),
|
|
249
|
+
[0006 copy rules](docs/rfc/0006-copy-rules.md),
|
|
250
|
+
[0007 recommended contents](docs/rfc/0007-recommended-contents.md),
|
|
251
|
+
[0008 print units and brand rules](docs/rfc/0008-print-units-and-brand-rules.md).
|
|
252
|
+
|
|
253
|
+
## Contributing
|
|
254
|
+
|
|
255
|
+
```bash
|
|
256
|
+
npm test # vitest, including golden-file conformance for examples/conformance
|
|
257
|
+
npm run check # typecheck, ESLint, Ruff and Prettier
|
|
258
|
+
npm run dev:blazon # blazon's own brand book from source, with live reload
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
[ARCHITECTURE](ARCHITECTURE.md) maps the code. [CONTRIBUTING](CONTRIBUTING.md) lists the test layout and what the commit and push hooks run. After a deliberate output change, regenerate the golden files with `UPDATE_GOLDEN=1 npx vitest run test/core/tokens/conformance.test.ts` and review the diff. `test/docs/manual.test.ts` fails when a command, flag, config key, directive, `dev.blazon` field or finding code is not documented in `docs/manual/`, so document what you add.
|
|
262
|
+
|
|
263
|
+
## License
|
|
264
|
+
|
|
265
|
+
MIT, see [LICENSE](LICENSE). The plugin conformance corpus in `test/spec/` is a copy of a plugin specification's, licensed Apache-2.0 (`test/spec/LICENSE`, `test/spec/NOTICE`); `test/spec/SOURCE.json` names the commit it came from. Another company's brand guidelines are not part of this repository. Blazon's own brand book, `examples/blazon/`, holds hand-drawn SVG and no generated images.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
Blazon is MIT licensed (see [LICENSE](LICENSE)). The published package contains or installs the third-party software below. Each package keeps its own license and copyright notice in its own folder under `node_modules` and in the bundles blazon builds from it.
|
|
4
|
+
|
|
5
|
+
## Font
|
|
6
|
+
|
|
7
|
+
The brand book's viewer ships the **Geist** variable font (`@fontsource-variable/geist`), under the SIL Open Font License 1.1. The build writes the package's own license text beside the font files, as `assets/geist-OFL.txt` in `dist/ui` and in every built site.
|
|
8
|
+
|
|
9
|
+
> Copyright 2024 The Geist Project Authors (<https://github.com/vercel/geist-font>)
|
|
10
|
+
>
|
|
11
|
+
> This Font Software is licensed under the SIL Open Font License, Version 1.1. The license is at <https://openfontlicense.org/open-font-license-official-text/>.
|
|
12
|
+
|
|
13
|
+
The starter brand book (`template/`, copied by `blazon init`) carries two font files, `fonts/IBMPlexMono-Regular-latin.woff2` and `fonts/IBMPlexMono-SemiBold-latin.woff2`: the Latin subsets of **IBM Plex Mono** Regular (from `@fontsource/ibm-plex-mono` 5.3.0) and SemiBold, under the SIL Open Font License 1.1. The license text is `fonts/OFL.txt` beside them. A brand replaces the file with its own.
|
|
14
|
+
|
|
15
|
+
> Copyright 2017 IBM Corp. All rights reserved. This Font Software is licensed under the SIL Open Font License, Version 1.1. The license is at <https://openfontlicense.org/open-font-license-official-text/>.
|
|
16
|
+
|
|
17
|
+
## Packages
|
|
18
|
+
|
|
19
|
+
These are blazon's direct dependencies and the packages bundled into the viewer and the shipped plugins, with the version built against. Packages they depend on in turn are mostly MIT, ISC, BSD-2-Clause, BSD-3-Clause or Apache-2.0, with the exceptions named below; `npm ls --all` lists them and each one's `package.json` names its license.
|
|
20
|
+
|
|
21
|
+
| Package | Version | License |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `@base-ui/react` | 1.9.0 | MIT |
|
|
24
|
+
| `@clack/prompts` | 1.8.1 | MIT |
|
|
25
|
+
| `@shadcn/react` | 0.3.1 | MIT |
|
|
26
|
+
| `cac` | 7.1.0 | MIT |
|
|
27
|
+
| `class-variance-authority` | 0.7.1 | Apache-2.0 |
|
|
28
|
+
| `clsx` | 2.1.1 | MIT |
|
|
29
|
+
| `cmdk` | 1.1.1 | MIT |
|
|
30
|
+
| `colorjs.io` | 0.7.1 | MIT |
|
|
31
|
+
| `dompurify` | 3.4.17 | MPL-2.0 OR Apache-2.0 |
|
|
32
|
+
| `embla-carousel-react` | 8.6.0 | MIT |
|
|
33
|
+
| `gray-matter` | 4.0.3 | MIT |
|
|
34
|
+
| `image-size` | 2.0.4 | MIT |
|
|
35
|
+
| `lucide-react` | 1.69.0 | ISC |
|
|
36
|
+
| `marked` | 18.1.3 | MIT |
|
|
37
|
+
| `pdf-lib` | 1.17.1 | MIT |
|
|
38
|
+
| `picocolors` | 1.1.1 | ISC |
|
|
39
|
+
| `playwright-core` | 1.64.1 | Apache-2.0 |
|
|
40
|
+
| `pptxgenjs` | 4.0.1 | MIT |
|
|
41
|
+
| `react` | 19.3.1 | MIT |
|
|
42
|
+
| `react-dom` | 19.3.1 | MIT |
|
|
43
|
+
| `react-resizable-panels` | 4.18.1 | MIT |
|
|
44
|
+
| `recharts` | 3.10.1 | MIT |
|
|
45
|
+
| `shiki` | 4.6.0 | MIT |
|
|
46
|
+
| `tailwind-merge` | 3.7.0 | MIT |
|
|
47
|
+
| `tw-animate-css` | 1.4.0 | MIT |
|
|
48
|
+
| `vite` | 8.3.6 | MIT |
|
|
49
|
+
|
|
50
|
+
`playwright-core` is a dependency, but blazon never downloads a browser: plugins that need Chrome use the one on the computer (`BLAZON_CHROME`).
|
|
51
|
+
|
|
52
|
+
Packages with a license other than those, and how blazon uses them:
|
|
53
|
+
|
|
54
|
+
| Package | License | Use |
|
|
55
|
+
|---|---|---|
|
|
56
|
+
| `jszip` 3.10.2 | MIT OR GPL-3.0-or-later | Used by `pptxgenjs`, which is bundled into the `blazon.print-book` plugin program. Blazon uses it under the MIT license. |
|
|
57
|
+
| `lightningcss` 1.33.0 | MPL-2.0 | A dependency of `vite`, so it is installed with blazon, and of the viewer's build. Blazon does not modify it or bundle it into its own files. |
|
|
58
|
+
| `pako` 1.0.11 | MIT AND Zlib | A dependency of `pdf-lib`, which is bundled into the plugin programs. |
|
|
59
|
+
|
|
60
|
+
A new direct or bundled dependency needs a row here.
|
package/bin/blazon.js
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { BlazonConfig, BlazonData } from '../types/index.js';
|
|
2
|
+
import { WriteOptions } from '../core/preflight.js';
|
|
3
|
+
export declare function buildSite(config: BlazonConfig, cwd?: string, options?: {
|
|
4
|
+
data?: BlazonData;
|
|
5
|
+
} & WriteOptions): Promise<{
|
|
6
|
+
data: BlazonData;
|
|
7
|
+
siteOutDir: string;
|
|
8
|
+
tokensOutDir: string;
|
|
9
|
+
}>;
|
|
10
|
+
//# sourceMappingURL=site-builder.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"site-builder.d.ts","sourceRoot":"","sources":["../../src/builder/site-builder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAkB,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEvF,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAQzD,wBAAsB,SAAS,CAC7B,MAAM,EAAE,YAAY,EACpB,GAAG,GAAE,MAAsB,EAC3B,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,UAAU,CAAA;CAAE,GAAG,YAAiB,GACjD,OAAO,CAAC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC,CAwCzE"}
|