tokens-bruecke 2.8.0

package/README.md

@@ -0,0 +1,655 @@
+# TokensBrücke — Figma plugin
+
+<a href="https://www.figma.com/community/plugin/1254538877056388290" target="_blank">
+<img src="./readme-assets/preview.webp" alt="preview" width="100%">
+</a>
+
+## What is this plugin for?
+
+The plugin converts Figma variables into design-tokens JSON that are compatible with the latest [Design Tokens specification](https://design-tokens.github.io/community-group/format/).
+
+---
+
+## Table of contents
+
+- [TokensBrücke — Figma plugin](#tokensbrücke--figma-plugin)
+  - [What is this plugin for?](#what-is-this-plugin-for)
+  - [Table of contents](#table-of-contents)
+  - [New version 2.0.0](#new-version-200)
+  - [How to use](#how-to-use)
+  - [General settings](#general-settings)
+    - [Color mode](#color-mode)
+    - [Include styles](#include-styles)
+    - [Add styles to](#add-styles-to)
+    - [Include variable scopes](#include-variable-scopes)
+    - [Use DTCG keys format](#use-dtcg-keys-format)
+    - [Include `.value` string for aliases](#include-value-string-for-aliases)
+    - [Include Figma metadata](#include-figma-metadata)
+  - [Use as cli tool](#use-as-cli-tool)
+    - [Installation](#installation)
+    - [Usage](#usage)
+    - [Options](#options)
+    - [CLI Configuration File](#cli-configuration-file)
+  - [Push to server](#push-to-server)
+    - [JSONBin](#jsonbin)
+    - [GitHub](#github)
+    - [GitHub PR](#github-pr)
+    - [GitLab](#gitlab)
+    - [Custom server](#custom-server)
+  - [Show output](#show-output)
+  - [Config autosaving](#config-autosaving)
+  - [Styles support](#styles-support)
+    - [Typography](#typography)
+    - [Colors](#colors)
+    - [Grids](#grids)
+    - [Shadows](#shadows)
+    - [Blur](#blur)
+    - [Multiple `Shadow` and `Blur` styles support](#multiple-shadow-and-blur-styles-support)
+  - [Tokens structure](#tokens-structure)
+  - [Aliases handling](#aliases-handling)
+    - [Include `.value` string for aliases](#include-value-string-for-aliases-1)
+    - [Handle variables from another file](#handle-variables-from-another-file)
+    - [Handle modes](#handle-modes)
+  - [Variables types conversion](#variables-types-conversion)
+  - [Design tokens types](#design-tokens-types)
+  - [Scopes lemitations](#scopes-lemitations)
+  - [Style Dictionary support](#style-dictionary-support)
+  - [Contribution 🚧](#contribution-)
+  - [Feedback](#feedback)
+
+---
+
+## New version 2.0.0
+
+In the new version of the plugin all mode variables moved into the `$extensions` / `modes` object.
+This is how Terrazzo (formerly “Cobalt UI”) works with multiple modes. Check it here — [https://terrazzo.app/docs/](https://terrazzo.app/docs/)
+
+You can download and install previos version `1.6.1` here — [github.com/tokens-bruecke/figma-plugin/files/13536853/build.zip](https://github.com/tokens-bruecke/figma-plugin/files/13536853/build.zip)
+
+## How to use
+
+1. Install the plugin from the [Figma Community](https://www.figma.com/community/plugin/1254538877056388290).
+2. Make sure you have variables in your Figma file.
+3. Run the plugin.
+4. Adjust the settings.
+5. Then you can download the JSON file or push it to on of the [supported services](#link).
+
+---
+
+## General settings
+
+### Color mode
+
+Allows you to choose the color mode for the generated JSON. Default value is `HEX`. The plugin supports the following color modes:
+
+- `HEX` — HEX color format. Could be converted into `HEXA` if the color has an alpha channel.
+- `RGBA CSS` — RGBA color format in CSS syntax, e.g. `rgba(0, 0, 0, 0.5)`.
+- `RGBA Object` — RGBA color format in object syntax, e.g. `{ r: 0, g: 0, b: 0, a: 0.5 }`.
+- `HSLA CSS` — HSLA color format in CSS syntax, e.g. `hsla(0, 0%, 0%, 0.5)`.
+- `HSLA Object` — HSLA color format in object syntax, e.g. `{ h: 0, s: 0, l: 0, a: 0.5 }`.
+
+### Include styles
+
+Allows you to include styles into the generated JSON. See more about styles support in the [Styles support](#styles-support) section.
+
+There is an option to rename each style's group and give it a custom name for better organization.
+
+![rename-styles](readme-assets/rename-styles.gif)
+
+### Add styles to
+
+Allows you to choose where to put styles in the generated JSON. By default, the selected value is `Keep separate`. In this case styles will be added into the root of the JSON and will be treated as collections. There is also an option to add styles into the corresponding collection (fig.4).
+
+![fig.4](readme-assets/fig4.webp)
+
+### Include variable scopes
+
+Each Figma variable has a [scope property](https://www.figma.com/plugin-docs/api/VariableScope). The plugin allows you to include scopes into the generated JSON. It will be included as an array of strings without any transformations.
+
+```json
+{
+  "button": {
+    "background": {
+      "type": "color",
+      "value": "#000000",
+      "scopes": ["ALL_SCOPES"]
+    }
+  }
+}
+```
+
+### Use DTCG keys format
+
+Is `off` by default. Currently many design tokens tools doesn't support [DTCG keys format](https://design-tokens.github.io/community-group/format/#character-restrictions). All DTCG keys are prefixed with `$` symbol.
+
+```json
+// Without DTCG keys format
+{
+  "button": {
+    "background": {
+      "type": "color",
+      "value": "#000000"
+    }
+  }
+}
+
+// With DTCG keys format
+{
+  "button": {
+    "background": {
+      "$type": "color",
+      "$value": "#000000",
+    }
+  }
+}
+```
+
+### Include `.value` string for aliases
+
+Is `off` by default. Allows you to include `.value` string to the end of the path for aliases. It will be added to the alias string.
+
+```json
+{
+  "button": {
+    "background": {
+      "type": "color",
+      "value": "{colors.light.primary.10.value}"
+    }
+  }
+}
+```
+
+If the format is `DTCG`:
+
+```json
+{
+  "button": {
+    "background": {
+      "$type": "color",
+      "$value": "{colors.light.primary.10.$value}"
+    }
+  }
+}
+```
+
+![fig.13](readme-assets/fig13.webp)
+
+### Include Figma metadata
+
+Is `off` by default. Allows you to include Figma metadata like `styleId`, `variableId`, etc. into the generated JSON. It will be added to the `$extensions` object.
+
+```json
+"figma": {
+  "codeSyntax": {},
+  "variableId": "VariableID:1:4",
+  "collection": {
+    "id": "VariableCollectionId:1:3",
+    "name": "Primitives",
+    "defaultModeId": "1:0"
+  }
+}
+```
+
+---
+
+## Use as cli tool
+
+> [!WARNING]  
+> ⚠️ You need a Figma Enterprise plan to use the Figma REST API for variables.
+
+### Installation
+
+To install the CLI globally, run:
+
+```bash
+pnpm add -g tokens-bruecke
+#or npm install -g tokens-bruecke
+```
+
+This will make the `tokens-bruecke` command available globally on your system.
+
+### Usage
+
+After installation, you can run the CLI tool using:
+
+```bash
+tokens-bruecke [options]
+```
+
+For example:
+
+```bash
+tokens-bruecke --api-key $FIGMA_TOKEN --file-key $FIGMA_FILE --config config.json --output out/tokens.json
+```
+
+This will fetch figma variables and export them in `out/tokens.json`
+
+### Options
+
+Same options than the plugin are available throught the usage of a json file.
+
+### CLI Configuration File
+
+You can use a JSON configuration file to specify the export options for the CLI.
+
+```json
+{
+  "includedStyles": {
+    "text": { "isIncluded": true, "customName": "typography" },
+    "effects": { "isIncluded": false, "customName": "effects" },
+    "grids": { "isIncluded": false, "customName": "grids" },
+    "colors": { "isIncluded": false, "customName": "colors" }
+  },
+  "includeScopes": true,
+  "useDTCGKeys": false,
+  "includeValueStringKeyToAlias": true,
+  "includeFigmaMetaData": false, // Include Figma metadata like styleId, variableId, etc.
+  "colorMode": "hex", // "hex"  | "rgba-object"  | "rgba-css"  | "hsla-object"  | "hsla-css";
+  "storeStyleInCollection": "none" // Name of one of your collection or "none" to keep them separated
+}
+```
+
+Save this JSON file and pass it to the CLI using the `--config` option:
+
+---
+
+## Push to server
+
+With this feature you can connect a server and push the generated JSON directly to it. At the moment the plugin supports [JSONBin](https://jsonbin.io), [GitHub](https://github.com) and custom servers.
+
+![fig.5](readme-assets/fig5.webp)
+
+If you connected multiple servers, the plugin will try to push the tokens to all of them one by one.
+In ordere to test if your credentials are valid you can make a test request by clicking the `Push to server` button (fig.6).
+
+![fig.6](readme-assets/fig6.webp)
+
+### [JSONBin](https://jsonbin.io)
+
+1. Open [JSONBin](https://jsonbin.io) and create an account.
+2. Generate a [new API key](https://jsonbin.io/api-reference/access-keys/create).
+3. If you want to use an existing bin, copy its ID. Otherwise just leave the ID field empty in the plugin settings.
+4. Add a name for the bin.
+
+![fig.7](readme-assets/fig7.webp)
+
+### [GitHub](https://github.com)
+
+1. You need to create a [personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with `repo` scope.
+2. In the plugin settings paste the token into the `Personal access token` field.
+3. Add an owner name, repository name and a branch name.
+4. In the file name field you can specify a path to the file. If the file doesn't exist, it will be created. If the file exists, it will be overwritten. File name should include the file extension, e.g. `tokens.json`.
+5. You can also specify a commit message.
+
+![fig.8](readme-assets/fig8.webp)
+
+### [GitHub PR](https://github.com)
+
+All the steps are the same as for the [GitHub](#github) server, except the last two.
+
+- **PR title**. You can specify a title for the PR. If you leave it empty, the plugin will use `chore(tokens): update tokens` as a default title.
+- **PR body**. You can specify a body for the PR. If you leave it empty, the plugin won't add any body to the PR.
+
+![fig.12](readme-assets/fig12.webp)
+
+### [GitLab](https://gitlab.com)
+
+1. You need to create a [project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html) with `api` scope.
+2. In the plugin settings paste the token into the `Project access token` field.
+3. Add an owner name, repository name and a branch name.
+4. In the file name field you can specify a path to the file. If the file doesn't exist, it will be created. If the file exists, it will be overwritten. File name should include the file extension, e.g. `tokens.json`. 5. You can also specify a commit message.
+
+![fig.11](readme-assets/fig11.webp)
+
+### Custom server
+
+There is a possibilty to connect a custom server. In order to do that you need to specify a URL, a method (by default it's `POST`) and headers.
+
+![fig.9](readme-assets/fig9.webp)
+
+---
+
+## Show output
+
+If you want to see the generated JSON, you can enable the `Show output` option. The plugin will show the JSON in the sidebar. The output doesn't update automatically, in order to optimize the performance. So, if you want to see the updated JSON, you need to click the `Update` button.
+
+![fig.10](readme-assets/fig10.webp)
+
+---
+
+## Config autosaving
+
+The plugin saves the config automatically. So, you don't need to set it up every time you run the plugin.
+
+---
+
+## Styles support
+
+The plugin can support some styles and effects too. Until Figma will support all the styles and effects, the plugin will convert them into the corresponding design tokens types. But it's not a backward compatibility, it's a temporary solution until Figma will support all the styles and effects as variables.
+
+Supported styles:
+
+- Typography
+- Colors
+- Grids
+- Shadows (including `inset` shadows)
+- Blur (including `background` and `layer` blur)
+
+### Typography
+
+```json
+"extralight": {
+  "type": "typography",
+  "value": {
+    "fontFamily": "Inter",
+    "fontWeight": 400,
+    "fontSize": "18px",
+    "lineHeight": "28px",
+    "letterSpacing": "0%"
+  },
+  "description": "",
+  "extensions": {
+    "styleId": "S:0ffe98ad785a13839980113831d5fbaf21724594,"
+  }
+}
+```
+
+### Colors
+
+The plugin supports solid colors and gradients (linear, radial, angular, diamond). Color styles are converted to DTCG format with support for variable aliases.
+
+```json
+// Solid color
+"primary": {
+  "type": "color",
+  "value": "#ff0000"
+}
+
+// Solid color with variable alias
+"secondary": {
+  "type": "color",
+  "value": "{colors.base.primary}"
+}
+
+// Gradient
+"skeleton-ramp": {
+  "type": "gradient",
+  "value": [
+    {
+      "color": "{clr.scale.ntrl.80}",
+      "position": 0
+    },
+    {
+      "color": "{clr.scale.ntrl.95}",
+      "position": 0.5
+    },
+    {
+      "color": "#eae9e8",
+      "position": 1
+    }
+  ]
+}
+```
+
+### Grids
+
+In Figma you can add as many grids in the style as you want. But the plugin will take only first two grids and treat the first one as `column` grid and the second one as `row` grid.
+
+```json
+// Column grid
+"1024": {
+  "type": "grid",
+  "value": {
+    "columnCount": 12,
+    "columnGap": "20px",
+    "columnMargin": "40px"
+  }
+}
+
+// Row grid
+"1024": {
+  "type": "grid",
+  "value": {
+    "rowCount": 12,
+    "rowGap": "20px",
+    "rowMargin": "40px"
+  }
+}
+
+// Both grids
+"1024": {
+  "type": "grid",
+  "value": {
+    "columnCount": 12,
+    "columnGap": "20px",
+    "columnMargin": "40px",
+    "rowCount": 12,
+    "rowGap": "20px",
+    "rowMargin": "40px"
+  }
+}
+```
+
+### Shadows
+
+The plugin supports `drop-shadow` and `inner-shadow` effects. If the effect is `inner-shadow`, the plugin will set the `inset` property to `true`.
+
+```json
+"xl": {
+  "type": "shadow",
+  "value": {
+    "inset": false,
+    "color": "#0000000a",
+    "offsetX": "0px",
+    "offsetY": "10px",
+    "blur": "10px",
+    "spread": "-5px"
+  }
+}
+```
+
+### Blur
+
+The plugin supports `background` and `layer` blur effects. In order to distinguish between them, the plugin adds the `role` property to the generated JSON.
+
+```json
+// Background blur
+"sm": {
+  "type": "blur",
+  "value": {
+    "role": "background",
+    "blur": "4px"
+  }
+}
+
+// Layer blur
+"md": {
+  "type": "blur",
+  "value": {
+    "role": "layer",
+    "blur": "12px"
+  }
+}
+```
+
+### Multiple `Shadow` and `Blur` styles support
+
+If the style has multiple `Shadow` or `Blur` styles, the plugin will add them into the array.
+
+```json
+"new-sh": {
+  "$type": "shadow",
+  "$value": [
+    {
+      "inset": false,
+      "color": "#e4505040",
+      "offsetX": "0px",
+      "offsetY": "4px",
+      "blur": "54px",
+      "spread": "0px"
+    },
+    {
+      "inset": false,
+      "color": "#5b75ff40",
+      "offsetX": "0px",
+      "offsetY": "4px",
+      "blur": "24px",
+      "spread": "0px"
+    },
+    {
+      "inset": false,
+      "color": "#00000040",
+      "offsetX": "0px",
+      "offsetY": "4px",
+      "blur": "4px",
+      "spread": "0px"
+    }
+  ]
+}
+```
+
+---
+
+## Tokens structure
+
+Plugin first takes the `collection` name, then the `group` and then the `variable` name (fig.1).
+Mode variables will be wrapped under the `$extensions` objects
+
+![fig.1](readme-assets/fig1.webp)
+
+For example, if you have a collection named `clr-theme`, mode named `light` and variable named `dark`, the plugin will generate the following JSON:
+
+```json
+"clr-theme": {
+  "container-outline/mid": {
+    "type": "color",
+    "value": "{clr-core.ntrl.40}",
+    "description": "",
+    "$extensions": {
+      "mode": {
+        "light": "{clr-core.ntrl.40}",
+        "dark": "{clr-core.ntrl.55}"
+      }
+    }
+  }
+}
+,
+```
+
+![fig.2](readme-assets/fig2.webp)
+
+Figma automatically merges groups and their names into a single name, e.g. `Base/Primary/10` (fig.2). In this case, the plugin will generate the following JSON:
+
+```json
+{
+  "base": {
+    "primary": {
+      "10": {
+        "type": "color",
+        "value": "#000000"
+      }
+    }
+  }
+}
+```
+
+## Aliases handling
+
+All aliases are converted into the alias string format from the [Design Tokens specification](https://design-tokens.github.io/community-group/format/#aliases-references).
+
+```json
+{
+  "button": {
+    "background": {
+      "type": "color",
+      "value": "{colors.primary.10}"
+    }
+  }
+}
+```
+
+### Include `.value` string for aliases
+
+You can switch on the `Include .value string for aliases` option in [the plugin settings](#include-value-string-for-aliases).
+
+---
+
+### Handle variables from another file
+
+Imagine you have a library from another file with "base" variables. And you use this variables in your current file.
+
+The plugin will generate the alias name anyway, but it will be a path to the variable as if it was in the current file.
+
+```json
+{
+  "button": {
+    "background": {
+      "type": "color",
+      "value": "{colors.primary.10}"
+    }
+  }
+}
+```
+
+The plugin wouldn't include the variable into the generated JSON in order to avoid duplicates or conflicts with JSON files you can generate from another Figma files.
+
+So you will need to merge the file with the base variables from one file with another where you use them. Otherwise tools like Style Dictionary wouldn't be able to resolve the aliases.
+
+---
+
+### Handle modes
+
+If there is only one mode — the plugin wouldn't include it in a generated JSON.
+If there are multiple modes, the plugin will place them under the `$extensions` objects.
+
+It follows the same pattern as used by [Cobalt](https://cobalt-ui.pages.dev/guides/modes#with-modes)
+
+---
+
+## Variables types conversion
+
+Unlike design tokens, Figma variables now [support only 4 types](https://www.figma.com/plugin-docs/api/VariableResolvedDataType) — `COLOR`, `BOOLEAN`, `FLOAT` and `STRING`. So, the plugin converts them into the corresponding types from the [Design Tokens specification](https://design-tokens.github.io/community-group/format/#types).
+
+| Figma type | Design Tokens type                                                                  |
+| ---------- | ----------------------------------------------------------------------------------- |
+| COLOR      | [color](https://design-tokens.github.io/community-group/format/#color)              |
+| BOOLEAN    | _boolean_ \*                                                                        |
+| FLOAT      | [dimension](https://design-tokens.github.io/community-group/format/#dimension) \*\* |
+| STRING     | _string_ \*                                                                         |
+
+\* native JSON types. The specification doesn't restrict the type of the value, so it could be any JSON type. Also see [this issue](https://github.com/design-tokens/community-group/issues/120#issuecomment-1279527414).
+
+\*\* currently figma supports only the `FLOAT` type for dimensions, that could be used only for `px` values. So, the plugin converts `FLOAT` values into `dimension` type with `px` unit.
+
+---
+
+## Design tokens types
+
+In order to validate types, the plugin uses the [Design Tokens types](https://github.com/PavelLaptev/tokens-bruecke/blob/main/token-types.d.ts).
+
+---
+
+## Scopes lemitations
+
+In order to convert `FONT-WEIGHT` and `OPACITY` types into valid values you should specify thme as scopes in the Figma variables. The plugin will read the first scope and convert it into the valid value. If there are multiple scopes, the plugin will take the first one.
+
+- `FONT_WEIGHT` scope will be converted into `string` type.
+- `OPACITY` scope will be converted into `number` type.
+
+---
+
+## Style Dictionary support
+
+There is a set of utils for [Style Dictionary](https://github.com/tokens-bruecke/sd-utils).
+
+---
+
+## Contribution 🚧
+
+Comming soon.
+
+---
+
+## Feedback
+
+If you have any questions or suggestions, feel free to [create an issue](https://github.com/tokens-bruecke/figma-plugin/issues)