From 80f22e0bfad7187952df9c0e326e4ec99719244a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sven=20H=C3=B6xter?= Date: Tue, 20 Feb 2024 14:30:02 +0100 Subject: [PATCH] chore: fix link to axioms documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sven Höxter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b41634ad..a5b76a1a 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,7 @@ Rules are objects of the following format: - **`rule`** - The check to perform. Repolinter can perform any check listed under the [rules documentation](./docs/rules.md). Unlike eslint, Repolinter checks are designed to be reused and specialized: for example, the `file-existence` check can be used in a `README-file-exists` rule and a `LICENSE-file-exists` rule in the same ruleset. This allows a user to write a very specific ruleset from configuring generic checks. - **`level`** - The error level to notify if the check fails. `warning` will not change the exit code and `off` will not run the check. -- **`where`** - Conditionally enable or disable this rule based off of [axioms](#axioms). Strings in this array follow the format of `=`, where value is either an axiom output or `*` to simply test if the axiom is enabled. If this option is present, this rule will only run if all specified axiom outputs are present. The available axioms in Repolinter can be found in the [axioms documentation](./docs/rules/axioms.md). +- **`where`** - Conditionally enable or disable this rule based off of [axioms](#axioms). Strings in this array follow the format of `=`, where value is either an axiom output or `*` to simply test if the axiom is enabled. If this option is present, this rule will only run if all specified axiom outputs are present. The available axioms in Repolinter can be found in the [axioms documentation](./docs/axioms.md). - **`fix`** _(optional)_ - The action to perform if the check performed by `rule` fails. Repolinter can perform any action listed under [fixes documentation](./docs/fixes.md). - **`policyInfo`**, **`policyUrl`** _(optional)_ - Information used by the formatter to indicate why the check exists from a policy perspective. Note: `policyInfo` will automatically have a period appended to it for formatting purposes.