Figtok NPM | npm.io

FigTok

Consumes Figma Tokens Studio (Formerly Figma Tokens) output files, and serializes the tokens to CSS variables to be used in your projects and design systems.

You can, for example, hook Figma Tokens Sync feature up to a GitHub repo, and then have figtok run in a GH action. Then on each update you get the updated CSS files outputted to a particular location. This would enable you to update styles in Figma, push changes from the UI, and have the updates automatically propagate to your live site/app/whatever.

This project is in a super-WIP state currently and probably won't work for you. It's only really guaranteed to work with Figma Tokens Pro, and if you use the "multiple files" option that splits your tokens into separate json files in directories instead of one huge json file. (see TODOs below.)

Gotchas

If you're not using Figma Tokens "Themes," and just have Token Sets, you need to remember to import all of the necessary css files so that the variable-based values still work. (i.e. if you have a "light" set that also depends on some "global" set tokens, you need to also @import the global set for the light set to work properly.)
If you use any math operators in your tokens, you need to make sure you have a whitespace character either side of the operator when you define the token (i.e. {base-size} * {font-scale} not {base-size}*{font-scale} or {base-size}* {font-scale} etc.)

Installation

yarn add -D figtok
## or
yarn global add figtok

You can also install this package via Cargo

cargo install figtok

Usage

# Below are the default values for the args, 
# you can pass no args or use the dir and out args to suit your environment
figtok --dir ./tokens --out ./build

Contribution

This package is deployed both to Cargo and NPM so that users can install the CLI easily in JS projects alongside their design tokens if they prefer. To deploy, you can use the commands in the Makefile - currently this uses rust-to-npm to automatically print out the boilerplate files for JS environments.

Once you're ready to deploy:

Make sure you have Cargo Bump installed
Run cargo bump [patch | minor | major]
Run make build to compile for prod, and update the necessary JS files to use the latest version.
Run make deploy to push out to Cargo and NPM simultaneously (You may need to enter 2FA for NPM.)

TODO

Support for JSON export (Export JSON that can be used in CSS-in-JS theme setups) - With JSON export, we'll want to replace the value in place rather than replace it with a var(--whatever) - or a reference to a part of the theme. This means that all values become static (theme.background === '#fff' instead of theme.background === "var(--neutral-0)")
~~Improve usage of Clap/CLI~~ Proper separation of concerns between CLI main.rs and Lib lib.rs
Support for Figma tokens Math syntax
Support for if Figma Tokens is set up to export one huge file instead of splitting into files and directories.
Support for "Composition Tokens" (Similar to Typography tokens)
Support for typography tokens
Support for shadow tokens
Support for users that have no Themes, just token sets. (The below should help with this, if we can output the sets separately, we can change the theme output so that by default, all sets get their own css file, and the theme output just uses @import to include the relevant sets in one file.)
Devise a way to output the source sets and enabled sets separately. We will want to also keep track of the source sets we have already processed so that we only handle them once (multiple themes may use the same source sets.) Consider also some kind of index file that @import all of the individual sets per-theme with the option to include all, namespaced by a class name on :root
Add support for HSL colors