docs: use RuleConfigSeverity in config docs #3521
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There is the following enum for checking rule config severity
in `commitlint/@commitlint/types/src/rules` that we should use
in typescript plugins instead of 0, 1, and 2 numbers to make
the code clearer.
```
export enum RuleConfigSeverity {
Disabled = 0,
Warning = 1,
Error = 2,
}
```
tehraninasab
changed the title
tehraninasab
force-pushed
the
use-RuleConfigSeverity-in-documentation
branch
from
881ccb5 to
fc3d4bd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There is the following enum for checking rule config severity in
commitlint/@commitlint/types/src/rulesthat we should use in typescript plugins instead of 0, 1, and 2 numbers to make the code clearer.Motivation and Context
To make the docs clearer.
How Has This Been Tested?
It has been used in our local plugins.
Checklist: