This cli tool provides comprehensive analysis over declarative rules files.

Simply run the following command:

rules-lint check --config path/to/your/config.yml

Below you can check the available commands:

The config specification is the latest and recommended version of the config file format. It helps you define a configuration file which is used to configure your linting rules.

The top-level directories property is defined by the config specification as the root folder where to look for rules files.

The top-level rules property is where users specify which lint rules to run.

Example config.yml:

directories:
  - ./rules

rules:
  checkTemplateVars: true
  checkUnusedContextKeys: true
  checkAsyncIncongruence: true

CheckTemplateVars: Will check whether the template variables are formatted correctly line by line, checking for missing opening and closing curly braces.

CheckUnusedContextKeys: Highlights whether defined context keys are currently not being used.

CheckAsyncIncongruence: Validates that anytime a rule is defined as async there's a matches conditional present.

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.