tokens-bruecke 2.14.1 → 2.14.3
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/.github/workflows/release.yml +11 -0
- package/CONTRIBUTING.md +75 -0
- package/README.md +1 -22
- package/package.json +1 -1
|
@@ -13,6 +13,8 @@ jobs:
|
|
|
13
13
|
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
|
|
14
14
|
steps:
|
|
15
15
|
- uses: actions/checkout@v4
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0
|
|
16
18
|
|
|
17
19
|
- name: Install pnpm
|
|
18
20
|
uses: pnpm/action-setup@v4
|
|
@@ -46,3 +48,12 @@ jobs:
|
|
|
46
48
|
run: gh release create ${{ github.ref_name }} ./dist/figma-plugin.zip --title "${{ github.ref_name }}" --generate-notes
|
|
47
49
|
env:
|
|
48
50
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
51
|
+
|
|
52
|
+
- name: Update CHANGELOG.md
|
|
53
|
+
run: |
|
|
54
|
+
git config user.name "github-actions[bot]"
|
|
55
|
+
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
56
|
+
npx --yes conventional-changelog-cli -p conventionalcommits -i CHANGELOG.md -s -r 1
|
|
57
|
+
git add CHANGELOG.md
|
|
58
|
+
git diff --staged --quiet || git commit -m "docs: update CHANGELOG for ${{ github.ref_name }}"
|
|
59
|
+
git push origin HEAD:main
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Contributing to TokensBrücke
|
|
2
|
+
|
|
3
|
+
Thanks for taking the time to contribute! Here's everything you need to get started.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Getting started
|
|
8
|
+
|
|
9
|
+
**Prerequisites:** Node.js, pnpm
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
git clone https://github.com/tokens-bruecke/figma-plugin.git
|
|
13
|
+
cd figma-plugin
|
|
14
|
+
pnpm install
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**Development build (watch mode):**
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm dev
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Load the plugin in Figma: **Plugins → Development → Import plugin from manifest** and point it to `manifest.json`.
|
|
24
|
+
|
|
25
|
+
**Run tests:**
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pnpm test
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Project structure
|
|
34
|
+
|
|
35
|
+
| Path | Purpose |
|
|
36
|
+
| ------------- | ---------------------------------------------------- |
|
|
37
|
+
| `src/app/` | Figma plugin UI (React) |
|
|
38
|
+
| `src/cli/` | CLI entry point |
|
|
39
|
+
| `src/common/` | Shared transform logic (used by both plugin and CLI) |
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Making changes
|
|
44
|
+
|
|
45
|
+
1. Fork the repo and create a branch from `main`.
|
|
46
|
+
2. Write code — keep changes focused and minimal.
|
|
47
|
+
3. Add or update tests for any logic in `src/common/`.
|
|
48
|
+
4. Open a pull request against `main`.
|
|
49
|
+
|
|
50
|
+
### Commit style
|
|
51
|
+
|
|
52
|
+
This project uses [Conventional Commits](https://www.conventionalcommits.org/):
|
|
53
|
+
|
|
54
|
+
| Prefix | Effect |
|
|
55
|
+
| ------------------------------ | ------------------ |
|
|
56
|
+
| `feat:` | Minor version bump |
|
|
57
|
+
| `fix:` | Patch version bump |
|
|
58
|
+
| `feat!:` / `BREAKING CHANGE:` | Major version bump |
|
|
59
|
+
| `chore:`, `docs:`, `refactor:` | No release |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Reporting bugs
|
|
64
|
+
|
|
65
|
+
Open a [GitHub issue](https://github.com/tokens-bruecke/figma-plugin/issues) with:
|
|
66
|
+
|
|
67
|
+
- Steps to reproduce
|
|
68
|
+
- Expected vs. actual behavior
|
|
69
|
+
- Plugin version and Figma version
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## License
|
|
74
|
+
|
|
75
|
+
By contributing, you agree your changes will be licensed under the project's [MIT License](./LICENSE).
|
package/README.md
CHANGED
|
@@ -15,7 +15,6 @@ The plugin converts Figma variables into design-tokens JSON that are compatible
|
|
|
15
15
|
- [TokensBrücke — Figma plugin](#tokensbrücke--figma-plugin)
|
|
16
16
|
- [What is this plugin for?](#what-is-this-plugin-for)
|
|
17
17
|
- [Table of contents](#table-of-contents)
|
|
18
|
-
- [New version 2.0.0](#new-version-200)
|
|
19
18
|
- [How to use](#how-to-use)
|
|
20
19
|
- [Export and Import](#export-and-import)
|
|
21
20
|
- [Export (Variables → JSON)](#export-variables--json)
|
|
@@ -60,19 +59,10 @@ The plugin converts Figma variables into design-tokens JSON that are compatible
|
|
|
60
59
|
- [Variables types conversion](#variables-types-conversion)
|
|
61
60
|
- [Design tokens types](#design-tokens-types)
|
|
62
61
|
- [Scopes lemitations](#scopes-lemitations)
|
|
63
|
-
- [Style Dictionary support](#style-dictionary-support)
|
|
64
|
-
- [Contribution 🚧](#contribution-)
|
|
65
62
|
- [Feedback](#feedback)
|
|
66
63
|
|
|
67
64
|
---
|
|
68
65
|
|
|
69
|
-
## New version 2.0.0
|
|
70
|
-
|
|
71
|
-
In the new version of the plugin all mode variables moved into the `$extensions` / `modes` object.
|
|
72
|
-
This is how Terrazzo (formerly “Cobalt UI”) works with multiple modes. Check it here — [https://terrazzo.app/docs/](https://terrazzo.app/docs/)
|
|
73
|
-
|
|
74
|
-
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)
|
|
75
|
-
|
|
76
66
|
## How to use
|
|
77
67
|
|
|
78
68
|
1. Install the plugin from the [Figma Community](https://www.figma.com/community/plugin/1254538877056388290).
|
|
@@ -90,6 +80,7 @@ The plugin supports both **exporting** and **importing** design tokens:
|
|
|
90
80
|
- Click **"Download JSON"** to export your Figma variables as a design tokens JSON file
|
|
91
81
|
- The exported file is compatible with the [Design Tokens specification](https://design-tokens.github.io/community-group/format/)
|
|
92
82
|
- You can also push directly to supported services (JSONBin, GitHub, GitLab, etc.)
|
|
83
|
+
- The exported tokens can be converted into CSS, JS, and other platform formats using tools like [Terrazzo](https://terrazzo.app/docs/) or [Style Dictionary](https://amzn.github.io/style-dictionary/)
|
|
93
84
|
|
|
94
85
|
#### Import (JSON → Variables)
|
|
95
86
|
|
|
@@ -771,18 +762,6 @@ In order to convert `FONT-WEIGHT` and `OPACITY` types into valid values you shou
|
|
|
771
762
|
|
|
772
763
|
---
|
|
773
764
|
|
|
774
|
-
## Style Dictionary support
|
|
775
|
-
|
|
776
|
-
There is a set of utils for [Style Dictionary](https://github.com/tokens-bruecke/sd-utils).
|
|
777
|
-
|
|
778
|
-
---
|
|
779
|
-
|
|
780
|
-
## Contribution 🚧
|
|
781
|
-
|
|
782
|
-
Comming soon.
|
|
783
|
-
|
|
784
|
-
---
|
|
785
|
-
|
|
786
765
|
## Feedback
|
|
787
766
|
|
|
788
767
|
If you have any questions or suggestions, feel free to [create an issue](https://github.com/tokens-bruecke/figma-plugin/issues)
|