spec-layer 0.5.0 → 0.7.0

package/README.md

@@ -14,9 +14,12 @@ After publishing a library from the plugin's Library screen, it shows a setup
 command. Run it once in your repository:
 
 ```bash
-npx spec-layer setup --id lib_... --key sl_...
+npx spec-layer setup --id lib_... --key sl_... --platform web
 ```
 
+`--platform` says what you build; without it, `setup` reads the repository
+root and writes a token file only when it finds a web signal.
+
 That records the library id, stores the key in a gitignored
 `speclayer.local.json`, and writes `.speclayer/`. Every later command needs no
 flags at all:
@@ -55,15 +58,19 @@ also keeps `.speclayer/manifest.json` on one format: 0.1.0 wrote no
 versions have no such command, so the setup command the plugin copies fails
 against them. The Foundation landing under `tokens/` as Design Tokens Format
 Module 2025.10 files, rather than `ai/foundation.yaml`, needs 0.4.0 or later.
-`tools` and `skill` need 0.5.0 or later.
+`tools` and `skill` need 0.5.0 or later. `components/` in place of
+`ai/components/`, `path` in place of `aiPath` in the manifest, and the
+`outputs` block need 0.6.0 or later. `component-specs/` beside `tokens/`,
+`componentSpecsDir`, cwd-relative manifest paths, and the `tokens/` directory
+need 0.7.0 or later.
 
 ## Commands
 
 | Command | What it does |
 |---|---|
-| `setup --id lib_... --key sl_... [--out DIR] [selection]` | Writes `speclayer.json`, stores the key in `speclayer.local.json`, then pulls. The command the plugin copies. |
-| `init --id lib_... [--out DIR] [selection]` | Writes `speclayer.json` so later commands need no flags. No key, no network. |
-| `pull [--id lib_...] [--key sl_...] [selection]` | Fetches the library and writes it into `DIR` (default `.speclayer`). |
+| `setup --id lib_... --key sl_... [--out DIR] [--platform P]... [selection]` | Writes `speclayer.json`, stores the key in `speclayer.local.json`, then pulls. The command the plugin copies. |
+| `init --id lib_... [--out DIR] [--platform P]... [selection]` | Writes `speclayer.json` so later commands need no flags. No key, no network. |
+| `pull [--id lib_...] [--key sl_...] [--platform P]... [selection]` | Fetches the library and writes it into `DIR` (default `.speclayer`). |
 | `status [--id lib_...] [--key sl_...]` | Checks freshness without writing. Exits `2` when the local copy is behind. |
 | `list` | Lists every artifact in the last pull, with its file path or `not written`. |
 | `show foundation [--canonical]` | Prints the Foundation's DTCG document to stdout. |
@@ -141,7 +148,7 @@ carry no key and are meant to be committed with the rest of the repository.
 ## Pulling part of a library
 
 By default `pull` writes the Foundation and every documented component. When
-your repo implements only some of them, narrow what lands in `ai/`:
+your repo implements only some of them, narrow what lands in `component-specs/`:
 
 ```bash
 npx spec-layer pull --only foundation            # tokens and styles, no components
@@ -172,7 +179,7 @@ That stores an `include` block in `speclayer.json`:
 Selection flags on `pull` replace the stored selection for that run; they are
 never merged with it.
 
-The selection only decides which `ai/` files are written. `bundle.json`
+The selection only decides which `component-specs/` files are written. `bundle.json`
 always holds the whole library, so `list` and `show` can answer for any
 artifact, written or not, and `status` compares one hash.
 
@@ -239,7 +246,7 @@ matter what the ignore rules say.
 ```text
 .speclayer/
   bundle.json                the published bundle, verbatim
-  manifest.json               every artifact indexed by content hash and path, plus the selection
+  manifest.json              every artifact indexed by content hash and path, plus the selection, outputs, and componentSpecsDir
   tokens/                    the Foundation as Design Tokens Format Module 2025.10 files
     <collection>.<mode>.json one file per collection and mode, rooted at the collection name
     styles.typography.json   text styles as typography composites (when present)
@@ -247,15 +254,24 @@ matter what the ignore rules say.
     resolver.json            Design Tokens Resolver Module 2025.10: sets, modifiers, order
     spec-layer.meta.json     Figma ids, scopes, code syntax, publication, keyed by DTCG path
     report.json              what DTCG could not express, with reasons and stable ids
-  ai/components/<name>.yaml  one file per selected component
+  outputs/
+    web-css.map.json         DTCG path -> CSS custom property, where the name came from, and which file declares it
+    web-css.report.json      what the CSS files could not express
+component-specs/
+  <name>.yaml                one brief per selected component, byte-identical to Copy for AI
+tokens/
+  index.css                  imports every file below, in resolver order
+  <collection>.css           one file per single-mode collection, at :root
+  <collection>.<mode>.css    one file per mode of a multi-mode collection; the default at :root
 ```
 
-Point your agent at `.speclayer/ai/` and `.speclayer/tokens/`. The component
-YAML is the same compact form the plugin's **Copy for AI** puts on your
-clipboard; `bundle.json` additionally holds the full canonical artifacts if
-you need them.
+Point your agent at `component-specs/` and `.speclayer/tokens/`, and import
+`tokens/index.css` from the platform's root stylesheet. The component YAML is
+the same compact form the plugin's **Copy for AI** puts on your clipboard;
+`bundle.json` additionally holds the full canonical artifacts if you need
+them.
 
-In `manifest.json`, an artifact the selection left unwritten has `"aiPath":
+In `manifest.json`, an artifact the selection left unwritten has `"path":
 null`. A manifest from CLI 0.1.0 has no `selection` field and means
 everything was written.
 
@@ -264,11 +280,19 @@ interrupted pull never leaves a half-written directory. `pull` refuses an
 output directory that is the current directory, a parent of it, or an existing
 non-empty directory it did not write, since the swap replaces that directory.
 
+`component-specs/` and `tokens/` are written in place, not swapped. `pull`
+owns exactly the files there that begin with its marker (the CSS header, or
+the brief's opening `spec_layer:` lines): it replaces or removes those,
+ignores dotfiles, and refuses to run when anything else is present. A
+repository that already uses a path can set `componentSpecsDir` or
+`outputs[].path`.
+
 When nothing changed since the last pull with the same selection, `pull`
 prints `Already up to date` and writes nothing. Every republish stamps a new
 export id and time into the canonical artifacts, so `bundle.json` and
 `manifest.json` change on each republish even when the content did not. The
-`ai/` YAML files, the `tokens/` files, and the content hashes stay stable.
+`component-specs/` YAML files, the `.speclayer/tokens/` files, and the
+`tokens/` CSS stay stable.
 
 ## Configuring the token output
 
@@ -295,6 +319,103 @@ Point Style Dictionary at `.speclayer/tokens/` and load the files
 `resolver.json` names for the mode you are building. The metadata sidecar and
 the report are not token files; exclude them from token globs.
 
+## Token files for your code
+
+`pull` also writes a `tokens/` directory at `outputs[].path`: one CSS file
+per collection and mode plus `index.css`, one per platform output. The
+directory is written only when that pull writes the Foundation; with
+`--only components` it is left exactly as it was, and `list` shows it as
+`not written`.
+
+```css
+/* Generated by spec-layer from library lib_..., foundation sha256:..., web/css/kebab.
+   Do not edit. Change the design in Figma, republish, and run spec-layer pull. */
+
+:root {
+  /* Foundation */
+  --foundation-colors-blue-500: #2e72d1;
+  --foundation-spacing-200: 8px;
+}
+```
+
+```css
+/* Generated by spec-layer from library lib_..., foundation sha256:..., web/css/kebab.
+   Do not edit. Change the design in Figma, republish, and run spec-layer pull. */
+
+[data-theme="dark"] {
+  /* Mapped Colors, Dark */
+  --mapped-colors-surface-primary-default: var(--foundation-colors-blue-900);
+}
+```
+
+`index.css` holds the header, then one comment and one import per file, in
+resolver order, and no declarations of its own:
+
+```css
+/* Generated by spec-layer from library lib_..., foundation sha256:..., web/css/kebab.
+   Do not edit. Change the design in Figma, republish, and run spec-layer pull. */
+
+/* Foundation */
+@import "./foundation.css";
+/* Mapped Colors, Dark */
+@import "./mapped-colors.dark.css";
+```
+
+A set, which has one mode by construction, writes one file named for the
+collection alone, at `:root`. A collection with modes writes one file per
+mode: the default mode's file sits at `:root`, every other mode's file under
+`[data-theme="<mode>"]`. Aliases stay as `var()`. A number whose Figma scopes
+state no unit stays a bare number. Nothing about a mode's name selects a
+media query. To let the OS choose a theme, set that collection's selector to
+`:root` under `modes` and import the mode's file yourself under `@media
+(prefers-color-scheme: dark)`. The CLI never assumes that.
+
+The directory is written **in place** at the path in `speclayer.json`,
+outside the managed directory, so your bundler keeps watching it and the diff
+shows up in review. Every file begins with a header naming the library and
+the Foundation's content hash; `pull` owns exactly the files there that begin
+with it, replacing or removing those, ignoring dotfiles, and refusing to run
+when anything else is present. A `speclayer.json` written by CLI 0.6.0 names
+a `.css` file at this path, and `pull` refuses it: set `path` to a directory
+and delete the old file.
+
+```json
+{
+  "platforms": ["web"],
+  "outputs": [
+    { "platform": "web", "format": "css", "path": "tokens", "case": "kebab" }
+  ]
+}
+```
+
+`setup` and `init` write this block from `--platform`, or from what they detect
+at the repository root, so the path is always on record. `pull` writes every
+entry; `"outputs": []` writes none. `case` chooses how derived names are
+spelled: `kebab` (default), `camel`, `pascal`, `snake`, or `constant`. A name
+the designer declared as `code_syntax` in Figma is used verbatim and never
+re-cased. `.speclayer/outputs/web-css.map.json` records every emitted name,
+whether it was declared or derived, and which file declares it; two tokens
+that would share a name are both omitted and listed in `web-css.report.json`.
+
+Two collections with modes share one attribute by default, which cannot be
+right for both; the report says so, and `modes` declares a selector per
+collection:
+
+```json
+{ "platform": "web", "format": "css", "path": "tokens",
+  "modes": { "Density": "[data-density=\"{mode}\"]" } }
+```
+
+`root` and `modeSelector` override the defaults `:root` and
+`[data-theme="{mode}"]`; `{mode}` and `{collection}` are replaced by slugs.
+A repository that already builds tokens with Style Dictionary can keep reading
+`.speclayer/tokens/`: the CSS files are a projection of the same record, not a
+second source, so import one or the other.
+
+Commit `.speclayer/`, `speclayer.json`, `component-specs/`, and the output
+paths. A repository that would rather regenerate in CI ignores them and runs
+`pull` there; `status` exits `2` when a pull is due.
+
 ## Exit codes
 
 | Code | Meaning |
@@ -308,5 +429,5 @@ the report are not token files; exclude them from token globs.
 
 ## Requirements
 
-Node 22 or newer. Publishing requires a Spec Layer Pro license; pulling does
-not.
+Node 22 or newer. Publishing one Figma file is free; Pro publishes up to ten.
+Pulling needs only the library id and pull key.