README.md

Universal Design Tokens (UDT)

Universal Design Tokens (UDT) is a collection of libraries and utilities for working with DTCG design tokens files.

• Packages
  • Core
  • CLI tools
  • Other
• Development
  • Pre-requisites
  • Initial setup
  • Build
  • Testing

Packages

This is a monorepo containing the source code for several UDT packages

Core

• @udt/tom: A Token Object Model (TOM) library for creating and manipulating design tokens which is aligned to the DTCG file format.
• @udt/dtcg-parser: A library for parsing DTCG design token files to a Token Object Model (TOM) representation.
• @udt/dtcg-serializer: A library for serializing Token Object Models (TOM) to DTCG design token files.
• @udt/parser-utils: Low-level logic and utilities for parsing DTCG and DTCG-like files.

CLI tools

• @udt/dtcg2csv: A CLI tool that can parse DTCG design token files and output information about the design tokens as a CSV file.

Other

• UDT Demos: Demo scripts to showcase how the core UDT libraries can be used.

Development

Pre-requisites

• Node >= 16
• NPM >= 8

Initial setup

After cloning the repo or if package dependencies have been changed since you last did this, you need to run the following from the root of the monorepo:

npm install
npm run bootstrap

Build

To build all the packages, run the following from the root of the monorepo:

npm run build

After an initial build, you can run the following to watch for changes to the code and automatically rebuild modules and packages as needed:

npm run watch

Testing

Run:

npm run test