Enveritas Design Tokens

This repository contains the design tokens of the Enveritas Design System (eds). The design tokens are prepared to synchronize with the Figma Token Studio plugin via Github. The tokens are converted into distribution formats with style-dictionary.

General Structure

There are four main folders relevant to this repository:

• src/scripts Contains the style-dictionary instructions for building the corresponding style dictionaries.
• build Contains the style dictionary figma.json that is synchronized with the Figma Token Studio plugin. The initial set of tokens was computed based on a set of base tokens which can be found in the initial commit.
• dist Contains the style dictionaries for further distribution and consumption of other modules.

Scripts

There are three different scripts for creating the style dictionaries:

• src/scripts/dist.js This script prepares the tokens from build/figma.json into the defined distribution style dictionaries. These dictionaries are written into the folder dist.

Workflow

The file build/figma.json should be synchronized on the figma branch with the Figma Token Studio Plugin. Updates from Figma can be pushed through Figma in a pull request. After merging to the main branch, the distribution sets can be generated with the dist.js script.

Releasing

Release should be done by creating a release based on the main branch. Before making a release you should:

1. Create a pull request from pre-release to main that

   • Updates the CHANGELOG.md file and moves Unreleased changes to the version you are planning to release
   • Updates the version in the package.json file

2. Merge the pull from pre-release to main

3. Create a release in Github based on the HEAD of the main branch. Creating a release in Github will trigger the action to deploy the new package version to NPMJS.