textlint-filter-rule-whitelist
textlint filter rule that filter any word by white list.
Install
Install with npm:
npm install textlint-filter-rule-whitelist
Usage
Via .textlintrc
(Recommended)
{
"filters": {
"whitelist": {
"allow": [
"ignored-word",
"/\\d+/",
"/^===/m"
]
}
}
}
Options
allow
: string[]
- white list words or RegExp strings
whitelistConfigPaths
: string[]
- File path list that includes allow words.
- Support file format: JSON, yml, js
For example, you can specify whitelistConfigPaths
to .textlintrc
.
{
"filters": {
"whitelist": {
"whitelistConfigPaths": [
"./allow.json",
"./allow.yml"
]
}
}
}
These files should be following formats.
allow.json
:
[
"allow",
"/yes/i"
]
allow.yml
:
- "allow",
- /yes/i
RegExp String
textlint-filter-rule-whitelist allow to use RegExp like string.
The string is stated with /
and ended with /
or /flag
.
"/\\d+/";
Note:
Multiline pattern should be use m
flag like /regexp/m
.
Changelog
See Releases page.
Running tests
Install devDependencies and Run npm test
:
npm i -d && npm test
Contributing
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
Author
License
MIT © azu