@iksnerd/blazon 0.1.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/README.md +4 -4
  2. package/dist/chunks/{site-builder-CPfjBOmR.js → site-builder-CsBH_ocA.js} +2335 -2633
  3. package/dist/cli/commands/tokens.d.ts +4 -0
  4. package/dist/cli/commands/tokens.d.ts.map +1 -1
  5. package/dist/cli/handlers/brand.d.ts +1 -1
  6. package/dist/cli/handlers/index.d.ts +2 -2
  7. package/dist/cli/index.js +915 -941
  8. package/dist/core/brand/export.d.ts +2 -9
  9. package/dist/core/brand/export.d.ts.map +1 -1
  10. package/dist/core/brand/schema.d.ts +0 -58
  11. package/dist/core/brand/schema.d.ts.map +1 -1
  12. package/dist/core/brand-theme.d.ts +0 -2
  13. package/dist/core/brand-theme.d.ts.map +1 -1
  14. package/dist/core/checker/catalogue.d.ts +2 -2
  15. package/dist/core/checker/contrast.d.ts +1 -1
  16. package/dist/core/checker/variables.d.ts +2 -2
  17. package/dist/core/checker/variables.d.ts.map +1 -1
  18. package/dist/core/config/removed-keys.d.ts +6 -0
  19. package/dist/core/config/removed-keys.d.ts.map +1 -0
  20. package/dist/core/config/validate.d.ts +1 -1
  21. package/dist/core/config/validate.d.ts.map +1 -1
  22. package/dist/core/emit.d.ts +1 -3
  23. package/dist/core/emit.d.ts.map +1 -1
  24. package/dist/core/index.d.ts.map +1 -1
  25. package/dist/core/operations/list.d.ts.map +1 -1
  26. package/dist/core/plugin-name.d.ts +1 -1
  27. package/dist/core/read/token.d.ts +1 -6
  28. package/dist/core/read/token.d.ts.map +1 -1
  29. package/dist/core/starter.d.ts.map +1 -1
  30. package/dist/index.js +33 -33
  31. package/dist/plugins/roles/integrate.d.ts +5 -2
  32. package/dist/plugins/roles/integrate.d.ts.map +1 -1
  33. package/dist/plugins/roles/roles.d.ts +5 -2
  34. package/dist/plugins/roles/roles.d.ts.map +1 -1
  35. package/dist/plugins/wire/profile.d.ts +5 -0
  36. package/dist/plugins/wire/profile.d.ts.map +1 -1
  37. package/dist/types/config.d.ts +1 -3
  38. package/dist/types/config.d.ts.map +1 -1
  39. package/dist/types/theme.d.ts +0 -3
  40. package/dist/types/theme.d.ts.map +1 -1
  41. package/dist/ui/assets/{index-D0WCUmtA.css → index-DluSqfla.css} +1 -1
  42. package/dist/ui/index.html +2 -2
  43. package/package.json +2 -1
  44. package/plugins/blazon.brand-deck/bin/blazon-blazon.brand-deck./360/237/224/214 +24 -2
  45. package/plugins/blazon.copy/bin/blazon-blazon.copy./360/237/224/214 +25 -3
  46. package/plugins/blazon.favicons/bin/blazon-blazon.favicons./360/237/224/214 +26 -3
  47. package/plugins/blazon.logo-geometry/bin/blazon-blazon.logo-geometry./360/237/224/214 +37 -8
  48. package/plugins/blazon.logo-kit/bin/blazon-blazon.logo-kit./360/237/224/214 +37 -8
  49. package/plugins/blazon.office-template/bin/blazon-blazon.office-template./360/237/224/214 +37 -8
  50. package/plugins/blazon.platform-tokens/bin/blazon-blazon.platform-tokens./360/237/224/214 +37 -9
  51. package/plugins/blazon.press-kit/bin/blazon-blazon.press-kit./360/237/224/214 +37 -8
  52. package/plugins/blazon.print-book/bin/blazon-blazon.print-book./360/237/224/214 +36 -7
  53. package/plugins/blazon.shadcn/README.md +27 -0
  54. package/plugins/blazon.shadcn/bin/blazon-blazon.shadcn./360/237/224/214 +8273 -0
  55. package/plugins/blazon.shadcn/package.json +3 -0
  56. package/plugins/blazon.social-cards/bin/blazon-blazon.social-cards./360/237/224/214 +37 -8
  57. package/plugins/blazon.tailwind/README.md +23 -0
  58. package/plugins/blazon.tailwind/bin/blazon-blazon.tailwind./360/237/224/214 +420 -0
  59. package/plugins/blazon.tailwind/package.json +3 -0
  60. package/plugins/shipped.lock +24 -10
  61. package/template/AGENTS.md +2 -2
  62. package/template/blazon.json +18 -10
  63. package/template/docs/12-web.md +2 -2
  64. package/dist/core/tokens/formatters/tailwind.d.ts +0 -37
  65. package/dist/core/tokens/formatters/tailwind.d.ts.map +0 -1
  66. package/dist/core/tokens/shadcn.d.ts +0 -43
  67. package/dist/core/tokens/shadcn.d.ts.map +0 -1
  68. /package/dist/ui/assets/{index-DhSc0Zxv.js → index-CLKH0m9J.js} +0 -0
package/README.md CHANGED
@@ -95,7 +95,7 @@ The same token is written as `--color-signal-orange: #FF5A1F;` in `theme.css` an
95
95
  ## When not to use blazon
96
96
 
97
97
  - **You need a stable interface.** Blazon is 0.x: a minor version may break a stable surface, and the CHANGELOG lists it under "Breaking". Pin the version you build with ([chapter 15](docs/manual/15-maintaining-a-brand-book.md#pin-the-blazon-you-build-with)).
98
- - **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.
98
+ - **You need many output formats.** Blazon writes CSS, TypeScript and JSON, the Tailwind and shadcn/ui plugins write a Tailwind v4 theme and the shadcn/ui variables, 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.
99
99
  - **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.
100
100
  - **You are on Windows.** It is tested on macOS and Linux with Node 24; WSL is untried.
101
101
 
@@ -122,7 +122,7 @@ The same compile feeds the dev server, so a change to a token, a page or the con
122
122
  - **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.
123
123
  - **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)
124
124
  - **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)
125
- - **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)
125
+ - **Writes code.** `theme.css`, `typography.css`, a typed `tokens.ts` and a `tokens.json` with aliases resolved. [Using the outputs](docs/manual/08-using-the-outputs.md)
126
126
  - **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)
127
127
  - **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)
128
128
  - **Compares them with a live site.** `blazon drift <url-or-css-file>` reports which tokens that name a `source.cssVar` have changed since.
@@ -131,7 +131,7 @@ The same compile feeds the dev server, so a change to a token, a page or the con
131
131
 
132
132
  ## Plugins
133
133
 
134
- 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`:
134
+ A plugin is a program, in any language, that blazon runs for a check or a build step. Blazon ships twelve, 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`:
135
135
 
136
136
  ```json
137
137
  {
@@ -157,7 +157,7 @@ A plugin whose manifest lists a variable that is set, and that the entry does no
157
157
  | [`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 |
158
158
  | [`blazon.social-cards`](docs/manual/14-shipped-plugins.md#blazonsocial-cards) | Marketing images from the tokens and logo, checked for contrast |
159
159
 
160
- 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.
160
+ Several need Chrome for their PDF or PNG output; the manual says which. The starter's config lists `blazon.copy` with blazon's own rules, and `blazon.tailwind` and `blazon.shadcn`, which need only Node and write the Tailwind and shadcn/ui files. It 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.
161
161
 
162
162
  ## Using the tokens
163
163