@dxdeveloperexperience/hygie
Version:
Hygie is an easy-to-use Open-Source REST API allowing you to interact with GIT events. This NestJS API expose a set of customizable rules to automate your project's life cycle.
30 lines (20 loc) • 1.18 kB
Markdown
# Config Generator
You can customize your `.rulesrc` config file with the [Hygie-Config-Generator project](https://github.com/DX-DeveloperExperience/hygie-config-generator).
This SPA allows you to generate this file with a friendly user-interface.
[Check it out](https://dx-developerexperience.github.io/hygie-config-generator/)!
## Autocomplete `.rulesrc` files
If for some reasons, you have to edit your `*.rules` files manually, you can import our [JSON Schema](https://zenika-open-source.github.io/hygie/rules-schema.json) that provide autocomplete for all rules and runnables.
Check-out your editor setting to know how to use it.
### Visual Studio Code
If you're using Visual Studio Code, you need to install the [YAML extension from Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) if your config file fit the YAML synthax.
Then, open the `settings.json` file and add the following code:
```json
"yaml.schemas": {
"https://zenika-open-source.github.io/hygie/rules-schema.json": "**/*.rulesrc"
},
"json.schemas": [
{
"fileMatch": ["**/*.rulesrc"],
"url": "https://zenika-open-source.github.io/hygie/rules-schema.json"
}
```