outsystems-design-tokens/README.md

Store the Design Tokens used on the Ionic Framework and Widgets Library

# outsystems-design-tokens

Store the Design Tokens used on the OutSystems UI Frameworks. Other related assets, like Font files, are stored on the `assets` folder.

## Table of Contents

- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Options](#options)
- [Contributing](#contributing)
- [License](#license)

## Introduction

This repository contains the design tokens used in the OutSystems UI Frameworks. Design tokens are the visual design atoms of the design system — specifically, they are named entities that store visual design attributes. These tokens are used in the Ionic Framework and Widgets Library to ensure consistency and scalability in design.

## Installation

To install the dependencies, run:

```sh
npm install
```

## Usage
To build the design tokens, you can use the provided script. The script parses command line arguments to set environment variables and then runs the build process.

## Build Tokens
To build the tokens, run:
`npm run build`

Alternatively, you can use the binary command:
`npx build.tokens --src <source-directory> --dest <destination-directory> [options]`

## Options
The following options are available for the build.tokens command.

- `--src`: The source directory containing the token files. Must end with a slash `/`
- `--dest`: The destination directory where the built tokens will be saved. Must end with a slash `/`.
- `--config`: Path to a custom configuration file. Must end with a slash `/`.
- `--prefix`: Prefix to add to the token names.
- `--scss`: Set to true to also generate a scss file with variables.

Example:
```sh
npx build.tokens --src='./tokens/' --dest='./dist/' --config='./config.json' --prefix='os'
```

## Contributing
We welcome contributions! Please see our CONTRIBUTING.md for guidelines on how to contribute to this project.

## License
This project is licensed under the BSD-3-Clause License. See the LICENSE file for more details.