@tokens-bruecke/sd-utils v3.0.0

TokensBrücke utils for Style Dictionary

This is the repo/package with utils for Style Dictionary. Utils were made for the TokensBrücke Figma plugin.

Table of contents

• TokensBrücke utils for Style Dictionary
  • Table of contents
  • Installation
  • Parsers
    • DTCGParser
    • compositeParser
  • Transforms
    • Available transforms
    • How to use the transforms
    • Shadow CSS Transform
    • Blur CSS Transform
    • Typography CSS Transform
    • Typography SCSS Transform
    • Shorthand Typography CSS Transform
  • Examples folder
    • Parsers
    • Transforms
  • How to tests in development
  • Feedback and requests
  • Changelog

Installation

# using npm
npm i @tokens-bruecke/sd-utils

# or yarn
yarn add @tokens-bruecke/sd-utils

Then you can import the package:

const tokensbrueckeSDUtils = require("@tokens-bruecke/sd-utils");

Parsers

In order to correctly parse the tokens, you need to register the parser first. It will clean unnecessary data from the file and it can also pre-transform the tokens.

DTCGParser

This parser will transform DTCG tokens into Style Dictionary tokens. It will remove the $ sign from the token name and remove the metadata.

const StyleDictionary = require("style-dictionary");
const tokensbrueckeSDUtils = require("@tokens-bruecke/sd-utils");

StyleDictionary.registerParser(tokensbrueckeSDUtils.DTCGParser);

Then you can use custom transforms to generate values for your platforms.

compositeParser

This parser will break down tokens with composite values into multiple tokens. You can use this parser in combination with the other transforms if you don't need to convert your composite tokens into a single-line property (eg. shadow-css)

Here is an example for the typography token:

"XLarge Desktop": {
  "value": {
    "fontFamily": "Gza",
    "fontWeight": 700,
    "fontSize": "66px",
    "lineHeight": "114%",
    "letterSpacing": "0px"
  },
  "type": "typography",
  "description": "",
  "extensions": {
    "styleId": "S:9990a34fcca6a42f145f80dd9b79ccc7522c27f2,"
  }
}

The parser will break it down into multiple tokens:

--typography-x-large-desktop-font-family: Gza;
--typography-x-large-desktop-font-weight: 700;
--typography-x-large-desktop-font-size: 66px;
--typography-x-large-desktop-line-height: 114%;
--typography-x-large-desktop-letter-spacing: 0px;

You can register the parser with all composite tokens:

const StyleDictionary = require("style-dictionary");
const tokensbrueckeSDUtils = require("@tokens-bruecke/sd-utils");

StyleDictionary.registerParser(tokensbrueckeSDUtils.compositeParser());

Curtomize specific tokens to parse

Or you can register the parser with a specific tokens only:

const StyleDictionary = require("style-dictionary");
const tokensbrueckeSDUtils = require("@tokens-bruecke/sd-utils");

StyleDictionary.registerParser(
  tokensbrueckeSDUtils.compositeParser(["typography", "grid"])
);

The parser accepts an array of token types typography, grid, shadow and blur.

Transforms

Available transforms

How to use the transforms

You need first to register the parser and then register the transform group. Then you can use the transform group in the Style Dictionary config. Find out more examples in the examples folder.

In order to use the transforms, you need to register them first with the registerTransform() function. The registerTransform() function could accept a string or an array of strings. The string is the name of the transform:

// REGISTER ONE TRANSFORM
tokensbrueckeSDUtils.registerTransform("tokens-bruecke/blur-css");

// REGISTER MULTIPLE TRANSFORMS
tokensbrueckeSDUtils.registerTransform([
  "tokens-bruecke/blur-css",
  "tokens-bruecke/shadow-css"
]);

Do not forget to specify the transform group in the Style Dictionary config. Currently sd-utils supports only css and scss transform groups. Some CSS transforms also works for SCSS transform group. See example CSS + SCSS transforms.

Transform groups:

• tokens-bruecke/css
• tokens-bruecke/scss

// IMPORT
const StyleDictionary = require("style-dictionary");
const tokensbrueckeSDUtils = require("@tokens-bruecke/sd-utils");

// REGISTER THE BASIC PARSER
StyleDictionary.registerParser(tokensbrueckeSDUtils.DTCGParser);

// REGISTER A TRANSFORM
tokensbrueckeSDUtils.registerTransform("tokens-bruecke/blur-css");

// APPLY THE TRABSFORM
const StyleDictionaryExtended = StyleDictionary.extend({
  source: ["tokens/**/*.json"],
  platforms: {
    css: {
      transformGroup: "tokens-bruecke/css", // <-- TRANSFORM GROUP NAME
      buildPath: "build/",
      files: [
        {
          destination: "_variables.css",
          format: "css/variables"
        }
      ]
    }
  }
});

// FINALLY, BUILD ALL THE PLATFORMS
StyleDictionaryExtended.buildAllPlatforms();

Shadow CSS Transform

tokensbrueckeSDUtils.registerTransform("tokens-bruecke/shadow-css");

The shadow transform is used to generate CSS box-shadow property

/* default */
--effects-shadow-md: 0px 4px 14px 0px #00000040;
/* or with `inset` */
--effects-shadow-sm: inset 0px 4px 4px 0px #00000040;

Blur CSS Transform

tokensbrueckeSDUtils.registerTransform("tokens-bruecke/blur-css");

Could be used in CSS filter property or backdrop-filter property. The role property is skipped in the output, because it's not used in CSS.

--effects-blur-lg: blur(24px);

Typography CSS Transform

This transform will convert the typography tokens into CSS variables including its shorthand property.

⚠️ This transform is only compatible with CSS variables, and will add -- prefix to the variable name.

tokensbrueckeSDUtils.registerTransform("tokens-bruecke/typography-css");

--typography-x-large-desktop: 700 66px/114% "Gza";
--typography-x-large-desktop-font-family: "Gza";
--typography-x-large-desktop-font-weight: 700;
--typography-x-large-desktop-font-size: 66px;
--typography-x-large-desktop-line-height: 114%;
--typography-x-large-desktop-letter-spacing: 0px;

Typography SCSS Transform

Works the same as the typography-css transform, but it will generate SCSS variables instead of CSS variables with $ prefix.

tokensbrueckeSDUtils.registerTransform("tokens-bruecke/typography-scss");

$typography-x-large-desktop: 700 66px/114% "Gza";
$typography-x-large-desktop-font-family: "Gza";
$typography-x-large-desktop-font-weight: 700;
$typography-x-large-desktop-font-size: 66px;
$typography-x-large-desktop-line-height: 114%;
$typography-x-large-desktop-letter-spacing: 0px;

Shorthand Typography CSS Transform

This transform will convert the typography tokens into a shorthand CSS variable without other properties.

tokensbrueckeSDUtils.registerTransform(
  "tokens-bruecke/typography-css-shorthand"
);

--typography-x-large-desktop: 700 66px/114% "Gza";

Examples folder

You can find examples in the examples folder. In order to run the examples, you need to install the dependencies first:

yarn

then you can run the build command:

yarn build

Parsers

• compositeParser
• DTCGParser
• DTCGParser mixed with custom tranforms

Transforms

For transforms there are separate folders for each platform/language. Some examples in build.js are commented out.

• CSS transforms
• CSS + SCSS transforms

How to tests in development

The examples folder is using yalc to link the local version of the plugin to the examples folder.

1. Install yalc package globally: npm i -g yalc
2. In the root folder run yalc publish to publish the local version of the package
3. Go to a test folder, e.g. examples/compositeParser
4. Install the local version of the package: yalc update
5. Install other dependencies: yarn
6. Run style dictionary build: yarn build

You can also replace local version of the package with the published version from npm.

Feedback and requests

If you have any feedback or requests, please create an issue in this repo.

Changelog

2.0.0

• Added style-dictionary as a dependency
• Updated README.md file

2.0.1

• Updated package.json file

3.0.0

Breaking changes:

• TransformGroup name "tokens-bruecke/custom" breaks down into "tokens-bruecke/css" and "tokens-bruecke/scss"
• Documented typography-css-shorthand transform
• Added typography-scss transform