@open-formulieren/design-tokens
Advanced tools
Comparing version 0.21.2 to 0.22.0
/** | ||
* Do not edit directly | ||
* Generated on Mon, 13 Feb 2023 09:52:14 GMT | ||
* Generated on Wed, 15 Feb 2023 09:34:27 GMT | ||
*/ | ||
@@ -94,2 +94,3 @@ | ||
export const ofInputFontWeight = "bold"; | ||
export const ofSelectHighlightedBg = "#E6E6E6"; | ||
export const ofHelptextBg = "#d3e3ec"; | ||
@@ -96,0 +97,0 @@ export const ofHelptextFg = "#000000"; |
{ | ||
"name": "@open-formulieren/design-tokens", | ||
"version": "0.21.2", | ||
"version": "0.22.0", | ||
"description": "Design tokens for Open Forms", | ||
@@ -5,0 +5,0 @@ "scripts": { |
# Design Tokens | ||
Open Forms projects follow the [NL Design System](https://github.com/nl-design-system). | ||
We organize the design tokens in JSON files and use them in downstream projects like the | ||
SDK and the Open Forms backend project. | ||
Open Forms projects follow the [NL Design System](https://github.com/nl-design-system). We organize | ||
the design tokens in JSON files and use them in downstream projects like the SDK and the Open Forms | ||
backend project. | ||
@@ -10,5 +10,5 @@ ## How it works | ||
Specify the design tokens in JSON files, which are picked up and merged using the | ||
[style-dictionary](https://www.npmjs.com/package/style-dictionary) library. The resulting | ||
packages include various build targets, such as ES6 modules, CSS variables files, SASS | ||
vars... to be consumed in downstream projects. | ||
[style-dictionary](https://www.npmjs.com/package/style-dictionary) library. The resulting packages | ||
include various build targets, such as ES6 modules, CSS variables files, SASS vars... to be consumed | ||
in downstream projects. | ||
@@ -19,4 +19,4 @@ ## Usage | ||
If you are only _consuming_ the design tokens, the easiest integration path is adding | ||
the NPM package as dependency to your project: | ||
If you are only _consuming_ the design tokens, the easiest integration path is adding the NPM | ||
package as dependency to your project: | ||
@@ -31,9 +31,9 @@ ```bash | ||
If you actively need to add or change design tokens, we recommend installing the package | ||
locally and using npm workspaces or `npm link` for the least-friction experience. For | ||
Open Forms specifically, we include the package as a git-submodule and leverage | ||
npm workspaces with instructions in the downstream projects. | ||
If you actively need to add or change design tokens, we recommend installing the package locally and | ||
using npm workspaces or `npm link` for the least-friction experience. For Open Forms specifically, | ||
we include the package as a git-submodule and leverage npm workspaces with instructions in the | ||
downstream projects. | ||
This allows you to create atomic PRs with design token changes, while being able to | ||
develop against the newest changes. | ||
This allows you to create atomic PRs with design token changes, while being able to develop against | ||
the newest changes. | ||
@@ -50,4 +50,4 @@ Run: | ||
Because of the way style-dictionary works, you have to pay close attention to the | ||
structure of the tokens. E.g. if you have two tokens definition files like: | ||
Because of the way style-dictionary works, you have to pay close attention to the structure of the | ||
tokens. E.g. if you have two tokens definition files like: | ||
@@ -76,4 +76,4 @@ ```json | ||
Then only `--of-color-fg` will be emitted since the merged object sees a `value` key | ||
at the `of.color.fg` path. | ||
Then only `--of-color-fg` will be emitted since the merged object sees a `value` key at the | ||
`of.color.fg` path. | ||
@@ -88,4 +88,4 @@ You can usually avoid this by sticking to a structure adhering to: | ||
Alternatively, if the structure is not that important, you can put the tokens on the | ||
same level, e.g.: | ||
Alternatively, if the structure is not that important, you can put the tokens on the same level, | ||
e.g.: | ||
@@ -103,1 +103,16 @@ ```json | ||
The latter form is harder to keep track off across files though. | ||
## Release flow | ||
We don't let `npm` apply the git tags when releasing a new version, instead follow this process: | ||
```bash | ||
npm version --no-git-tag-version minor | ||
git commit -am ":bookmark: Bump to version <newVersion>" | ||
git tag "<newVersion>" | ||
git push origin main --tags | ||
``` | ||
If you have PGP keys set up, you can use them for the git tag operation. | ||
The CI pipeline will then publish the new version to npmjs. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
188494
38
5036
112