textlint rule check unnessary control character in the document.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.gitignore
.travis.yml
LICENSE
README.md
package.json
yarn.lock

README.md

@textlint-rule/textlint-rule-no-invalid-control-character Build Status

textlint rule check invalid control character in the document.

Allow

  • \r
  • \n
  • \t

Not Allow

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
{
    "rules": {
        "@textlint-rule/no-invalid-control-character": {
            "allow": [
                "\v"
            ]
        }
    }
}

Reference

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.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu