If you use the CLI, you need to fill three properties:
repository
is @organization/repository
personalAccessToken
which you can generate
rules
are where you provide parsers and compatible options
{
"version": "2",
"repository": "@organization/repository",
// Only use the personalAccessToken when working with the CLI
"personalAccessToken": "<your-personal-access-token>",
"rules": [
{
"name": "Generate tokens for Flutter",
"parsers": [
{
"name": "to-flutter",
"output": {
"type": "file",
"filePath": "public/tokens.dart"
}
}
]
},
{
"name": "Optimize and generate icons as SVG files",
"parsers": [
{
"name": "svgo",
"output": {
"type": "directory",
"directoryPath": "public/vectors"
}
}
]
}
]
}
If you use the GitHub, you need to fill 4 properties:
repository
is @organization/repository
head
lets you set the branch your PR will be created on
base
lets you set the branch your PR will be merged on
rules
lets you transform tokens by chaining parsers
{
"version": "2",
"repository": "@organization/repository",
"head": "specifyrc-json",
"base": "main",
"rules": [
{
"name": "Generate tokens for Flutter",
"parsers": [
{
"name": "to-flutter",
"output": {
"type": "file",
"filePath": "public/tokens.dart"
}
}
]
},
{
"name": "Optimize and generate icons as SVG files",
"parsers": [
{
"name": "svgo",
"output": {
"type": "directory",
"directoryPath": "public/vectors"
}
}
]
}
]
}