tokens-bruecke 3.5.0 → 3.6.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/README.md CHANGED
@@ -34,6 +34,7 @@ The plugin converts Figma variables into design-tokens JSON that are compatible
34
34
  - [Use as cli tool](#use-as-cli-tool)
35
35
  - [Installation](#installation)
36
36
  - [Usage](#usage)
37
+ - [Quick setup](#quick-setup)
37
38
  - [Options](#options)
38
39
  - [Snapshot input](#snapshot-input)
39
40
  - [CLI Configuration File](#cli-configuration-file)
@@ -399,6 +400,55 @@ tokens-bruecke --input snapshot.json --output out/tokens.json
399
400
 
400
401
  This will fetch figma variables and export them in `out/tokens.json`
401
402
 
403
+ ### Quick setup
404
+
405
+ `tokens-bruecke init` asks a few questions and writes a config file you can commit:
406
+
407
+ ```bash
408
+ tokens-bruecke init
409
+ ```
410
+
411
+ ```
412
+ ? Color mode (↑↓ to move, enter to select)
413
+ ❯ HEX "#3366ff"
414
+ RGBA CSS "rgba(51, 102, 255, 1)"
415
+ RGBA Object { r, g, b, a }
416
+ sRGB DTCG DTCG color object
417
+ HSLA CSS "hsla(225, 100%, 60%, 1)"
418
+ HSLA Object { h, s, l, a }
419
+ HSL DTCG DTCG color object
420
+ OKLCH DTCG DTCG color object
421
+
422
+ ? Styles to include (space to toggle, a for all, enter to confirm)
423
+ ❯ ◉ Color styles
424
+ ◯ Typography styles
425
+ ◉ Effect styles
426
+ ◯ Grid styles
427
+ ```
428
+
429
+ Each answered question collapses to a single line, so you end up with a short summary rather than a wall of text:
430
+
431
+ ```
432
+ ? Color mode › OKLCH DTCG
433
+ ? Styles to include › Color styles, Effect styles
434
+ ? Use DTCG 2025.10 format? › No
435
+ ? Output layout › One file per collection
436
+
437
+ ✨ Created tokens-bruecke.config.json
438
+ ```
439
+
440
+ **Keys:** `↑`/`↓` (or `j`/`k`, or `Tab`) to move, `1`–`9` to jump straight to a row, `Space` to toggle in multi-select, `a` to toggle all, `Enter` to confirm, `Ctrl+C` / `Esc` to cancel without writing anything. Selection wraps at both ends. Set `NO_COLOR=1` to drop the colour codes.
441
+
442
+ The four questions cover the settings people change most often, but the generated file contains **every** option with its default, plus a `$schema` link — so your editor autocompletes and documents the rest as you edit it.
443
+
444
+ | Option | Alias | Description |
445
+ | --------- | ----- | --------------------------------------------------------- |
446
+ | `--yes` | `-y` | Skip the questions and write the default config |
447
+ | `--force` | | Overwrite an existing config file |
448
+ | `--path` | `-p` | Where to write it (default: `tokens-bruecke.config.json`) |
449
+
450
+ When stdin is not a terminal — CI, a pipe, an agent — `init` skips the questions and writes the defaults instead of hanging.
451
+
402
452
  ### Options
403
453
 
404
454
  | Option | Alias | Description | Required |
@@ -480,7 +530,7 @@ Things worth knowing when building a snapshot:
480
530
 
481
531
  ### CLI Configuration File
482
532
 
483
- You can use a JSON configuration file to specify the export options for the CLI.
533
+ You can use a JSON configuration file to specify the export options for the CLI. Run [`tokens-bruecke init`](#quick-setup) to generate one, or write it by hand:
484
534
 
485
535
  ```json
486
536
  {