textlint rule that ignore error using comments directive.
Install with npm:
npm install textlint-filter-rule-comments
Dependencies:
- textlint >= 6.9
Example case in Markdown.
This is error text.
<!-- textlint-disable -->
This is ignored text by rule.
Disables all rules between comments
<!-- textlint-enable -->
This is error text.Ignore specified rules:
<!-- textlint-disable ruleA,ruleB -->
Ignore RuleA and RuleB
<!-- textlint-enable ruleA -->
Still ignore RuleBLimitation(markdown):
Require new-line around of <!-- textlint-disable --> in Markdown.
This limitation com from remark.
NG:
<!-- textlint-disable -->
this is wrong
<!-- textlint-enable -->OK:
<!-- textlint-disable -->
this is ok
<!-- textlint-enable -->Via .textlintrc(Recommended)
{
"filters": {
"comments": true
}
}enablingComment:- default:
"textlint-enable" - enable comment directive
- e.g.)
<!-- textlint-enable -->
- default:
disablingComment:- default:
"textlint-disable" - disable comment directive
- e.g.)
<!-- textlint-disable -->
- default:
{
"filters": {
"comments": {
// enable comment directive
// if comment has the value, then enable textlint rule
"enablingComment": "textlint-enable",
// disable comment directive
// if comment has the value, then disable textlint rule
"disablingComment": "textlint-disable"
}
}
}See Releases page.
Install devDependencies and Run npm test:
npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
MIT © azu