eslint-plugin-comment-pattern
v1.0.0
Published
ESLint plugin to ensure comments consistency
Downloads
2
Maintainers
Readme
ESLint Comment Plugin
This plugin allows you to add patterns to block certain comments in your codebase.
Installation
npm install --save-dev eslint-plugin-comment-pattern
Usage
Add comment-pattern
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["comment-pattern"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"comment-pattern/no-pattern-comments": [
"error",
{
"patterns": [
{
"pattern": "[а-яА-ЯёЁ]",
"message": "Cyrillic characters are not allowed in comments"
},
{
"pattern": "TODO",
"message": "TODO comments are not allowed"
}
]
}
]
}
}