textlint-filter-rule-whitelist

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

RegExp String

textlint-filter-rule-whitelist allow to use RegExp like string. The string is stated with / and ended with / or /flag.

"/\\d+/"; // => /\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.

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

• github/azu
• twitter/azu_re

License

MIT © azu