https://github.com/cloudflightio/style-dictionary-transformer

Cloudflight style dictionary transformer for SCSS
https://github.com/cloudflightio/style-dictionary-transformer

Last synced: 4 months ago
JSON representation

Cloudflight style dictionary transformer for SCSS

• Host: GitHub
• URL: https://github.com/cloudflightio/style-dictionary-transformer
• Owner: cloudflightio
• License: apache-2.0
• Created: 2023-03-07T07:38:59.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-11T06:41:30.000Z (about 2 years ago)
• Last Synced: 2025-08-25T03:39:50.090Z (9 months ago)
• Language: SCSS
• Size: 1.8 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Cloudflight Style Dictionary

[![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://opensource.org/licenses/Apache-2.0)

![master](https://github.com/cloudflightio/cloudflight-style-dictionary-transformer/actions/workflows/build.yml/badge.svg?branch=master)

[![@cloudflight/style-dictionary-transformer](https://img.shields.io/npm/v/@cloudflight/style-dictionary-transformer?label=@cloudflight/style-dictionary-transformer)](https://www.npmjs.com/package/@cloudflight/style-dictionary-transformer)

Amazon style dictionary configured with Cloudflight best practices in mind.

## Installation

The following dependencies are required:

```

"style-dictionary": "*"

```

## Usage

Create a javascript file with the following content:

```javascript

import {cloudflightPlatformConfigWith, registerItems} from '@cloudflight/style-dictionary-transformer';

import StyleDictionary from 'style-dictionary';

registerItems(StyleDictionary);

const StyleDictionaryExtended = StyleDictionary.extend({

    source: ['assets/design-tokens/*.json'],

    platforms: {

        ...cloudflightPlatformConfigWith({

            web: {

                declaration: {

                    outputDirectory: '',

                },

            },

        }),

    },

});

StyleDictionaryExtended.buildAllPlatforms();

```

Execute this script as part of your build. It will generate styles into you output directory for further use.

## Contributing

-   [Contributing to the project](CONTRIBUTING.md)