Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/universal-design-tokens/udt
Universal Design Tokens (UDT) is a collection of libraries and utilities for working with DTCG design tokens files.
https://github.com/universal-design-tokens/udt
design-systems design-tokens dtcg parser serializer
Last synced: about 2 months ago
JSON representation
Universal Design Tokens (UDT) is a collection of libraries and utilities for working with DTCG design tokens files.
- Host: GitHub
- URL: https://github.com/universal-design-tokens/udt
- Owner: universal-design-tokens
- License: isc
- Created: 2018-01-05T10:12:07.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T09:51:49.000Z (2 months ago)
- Last Synced: 2024-05-02T22:27:43.718Z (2 months ago)
- Topics: design-systems, design-tokens, dtcg, parser, serializer
- Language: TypeScript
- Homepage: https://udt.design/
- Size: 2.91 MB
- Stars: 142
- Watchers: 6
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-list - udt - design-tokens | 97 | (TypeScript)
README
# Universal Design Tokens (UDT)
Universal Design Tokens (UDT) is a collection of libraries and utilities for working with [DTCG design tokens files](https://tr.designtokens.org/format/).
- [Packages](#packages)
- [Core](#core)
- [CLI tools](#cli-tools)
- [Other](#other)
- [Development](#development)
- [Pre-requisites](#pre-requisites)
- [Initial setup](#initial-setup)
- [Build](#build)
- [Testing](#testing)
## Packages
This is a monorepo containing the source code for several UDT packages
### Core
* [**`@udt/tom`**](./packages/tom): A Token Object Model (TOM) library for creating and manipulating design tokens which is aligned to the DTCG file format.
* [**`@udt/dtcg-parser`**](./packages/dtcg-parser): A library for parsing DTCG design token files to a Token Object Model (TOM) representation.
* [**`@udt/dtcg-serializer`**](./packages/dtcg-serializer): A library for serializing Token Object Models (TOM) to DTCG design token files.
### CLI tools
* [**@udt/dtcg2csv**](./packages/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**](./packages/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
```