@osynlig/support-tool v0.3.2

🧀 The Osynlig Support Tool

Getting started

1. Install into project with npm i -D @osynlig/support-tool.
2. Add "ost": "ost" to scripts in package.json.
3. Run npm run ost init to create example template in .ost config folder.
4. Add variables to the .env file in your project root, see .ost/.env.example for available variables
5. Run cp .ost/config.example.json .ost/config.json to copy config file

Usage

Scaffolding templates

Commands

Run npm run ost make component [ComponentName] to create a new component from a template.

Configure template types and target directories .ost/config.json.

Generating icons from Figma

instructions missing :(

Generating css files containing tokens from Osynlig Baseline Tokens

1. Run npm run ost tokens
2. Token css files will be generated to target directory specified in config.json

External libraries

• Commander for CLI-functionality
• Ora for terminal spinners
• figma-js as wrapper for Figma API
• ejs for population of templates

Developing

Setup

1. Clone the repo
2. Run npm install to install dependencies
3. Run npm run start and keep it running in a terminal

Test scripts

1. Create a script in src/commands/
2. Import your script in src/index.ts and add it to the program
3. Run cd testdir to go to the test project
4. Run npm install to install dependencies for the test project
5. Run npm run ost [your-script] to test your script

Todo

• Warn when trying to create component that already exists
• Config for src dir
• Make sure created component ends up in the right dir
• Make sure we are in an initialized project
• Typescript
• ESlint
• Prettier
• Tests
• Make into installable package
• ost init to create example template structure
• Create readme

Maybe?

• command to create a prettier config?
• command to create a readme base?
• fig/autocomplete helper?