Architecture

This is how Style Dictionary works under the hood:

flowchart LR
    subgraph global
        direction TB
        Z[Config] -->|Parse config| X
        X[Parsed Config] -->|Run| A
        A[Token Files] -->|Parsers| B
        B[JavaScript Objects] -->|Combine| C
        C[Dictionary] -->|Preprocessors| C
        click X "#1-parse-the-config" "Explanation about parsing config"
        click A "#2-find-all-token-files" "Explanation about finding tokens files"
        click B "#3-parse-token-files" "Explanation about parsing tokens files"
        click C "#4-deep-merge-token-files" "Explanation about deep merging tokens into a dictionary"
    end

    subgraph platform
        direction TB
        D[Dictionary] -->|Preprocessors| D
        D -->|Transforms| E
        E[Transformed Dictionary] -->|Resolve references| F
        F[Resolved Dictionary] -->|Transitive transforms| E
        click D "#5-run-preprocessors-over-the-dictionary" "Explanation about preprocessing the dictionary"
        click E "#6-transform-the-tokens" "Explanation about transforming tokens"
        click F "#7-resolve-aliases--references-to-other-values" "Explanation about token references resolution"
    end

    subgraph files
        direction TB
        G[Resolved Dictionary] --> |Filters| H
        H[Filtered Dictionary] --> |Formats| I
        H[Filtered Dictionary] --> |File headers| I
        I[Platform output] --> |Actions| J[Actions output]
        click I "#8-format-the-tokens-into-files" "Explanation about formatting tokens to output files"
        click J "#9-run-actions" "Explanation about running actions"
    end
    global --> platform --> files

Let’s take a closer look into each of these steps.

1. Parse the config

Style Dictionary is a configuration based framework, you tell it what to do in a configuration file. Style Dictionary first parses this configuration to know what to do.

2. Find all token files

In your config file can define include and source, which are arrays of file path globs. These tell Style Dictionary where to find your token files. You can have them anywhere and in any folder structure as long as you tell Style Dictionary where to find them.

3. Parse token files

If there are custom parsers defined and applied in the config, Style Dictionary will run those on files the applied parsers match. For JSON or JavaScript token files, those are parsed automatically through built-in parsers.

4. Deep merge token files

Style Dictionary takes all the files it found and performs a deep merge. This allows you to split your token files in any way you like, without worrying about accidentally overriding groups of tokens. This gives Style Dictionary a single, complete token object to work from.

5. Run preprocessors over the dictionary

Allows users to configure custom preprocessors, to process the merged dictionary as a whole, rather than per token file individually. These preprocessors have to be applied in the config, either on a global or platform level. Platform level preprocessors run once you get/export/format/build a platform, at the very start.

6. Transform the tokens

Style Dictionary now traverses over the whole token object and looks for design tokens. It does this by looking for anything with a value key. When it comes across a design token, it then performs all the transforms defined in your config in order.

Value transforms, transforms that modify a token’s value, are skipped if the token references another token. Starting in 3.0, you can define a transitive transform that will transform a value that references another token after that reference has been resolved.

7. Resolve aliases / references to other values

After all the tokens have been transformed, it then does another pass over the token object looking for aliases, which look like "{size.font.base.value}". When it finds these, it then replaces the reference with the transformed value. Because Style Dictionary merges all token files into a single object, aliases can be in any token file and still work.

8. Format the tokens into files

Now all the design tokens are ready to be written to a file. Style Dictionary takes the whole transformed and resolved token object and for each file defined in the platform it formats the token object and write the output to a file. Internally, Style Dictionary creates a flat array of all the design tokens it finds in addition to the token object. This is how you can output a flat SCSS variables file.

9. Run actions

Actions are custom code that run in a platform after the files are generated. They are useful for things like copying assets to specific build directories or generating images.

After Style Dictionary does steps 4a-4d for each platform, you will have all your output files that are ready to consume in each platform and codebase.