TypeScript helper library let's you use the power of TypeScript to configure your labels. In the end, it still compiles to YAML. LabelSync only cares about the changes in labelsync.yml
. Therefore, make sure that you always run compilation method to get the configuration out.
The best way to get started using LabelSync's TypeScript library is by scaffolding your project using our getting started templates.
yarn create label-sync --template typescript
The template comes with preconfigured make
script to compile your TypeScript configuration into labelsync.yml
, and a suggested Prettier configuration. You can, of course, tailor everything to your needs.
https://www.loom.com/share/52adbed187b84e7bbad1ea08f7efe53a
LabelSync's TypeScript library comes with a handful of available methods that you can use to configure LabelSync to your needs.
Methods:
labelsync
: used as a configuration entry point. Outputs yaml version of your configuration to the root of your repository.repo
: used to configure a single repositorylabel
: used to create a single labelPresets: