@textlint-rule/textlint-rule-no-invalid-control-character
v3.0.0
Published
textlint rule check unnessary control character in the document.
Downloads
98,525
Keywords
Readme
@textlint-rule/textlint-rule-no-invalid-control-character
textlint rule check invalid control character in the document.
Allow
\r
\n
\t
Disallow
Other control character.
For example, following control character is not allowed.
(
\u0010
DATA LINK ESCAPE)(
\u0019
ND OF MEDIUM)- etc...
Install
Install with npm:
npm install @textlint-rule/textlint-rule-no-invalid-control-character
Usage
Via .textlintrc
(Recommended)
{
"rules": {
"@textlint-rule/no-invalid-control-character": true
}
}
Via CLI
textlint --rule @textlint-rule/no-invalid-control-character README.md
Options
allow
:string[]
- Define allow control characters
checkCode
:boolean
- Default:
false
- Check code if it is
true
- Default:
checkImage
:boolean
- Default:
true
(v2+) - Check image title and alt texts if it is
true
- Default:
{
"rules": {
"@textlint-rule/no-invalid-control-character": {
"allow": [
"\v"
]
}
}
}
Reference
- JavaScript character escape sequences · Mathias Bynens
- azu/check-invalid-control-characters: Check invalid control characters like
\u0008
in plain text.
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