Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 1.2 KB

README.md

File metadata and controls

67 lines (44 loc) · 1.2 KB

textlint-rule-en-spell

textlint rule

A textlint rule to check English spelling. The dictionary is included.

1:1  ✓ error  typimg => typing                                  en-spell

Install

Install with npm:

npm install textlint-rule-en-spell

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "en-spell": true
    }
}

with TextlintRuleEnSpellOptions

{
    "rules": {
        "en-spell": {
            "personalDictionary": ["foo", "bar/color", "*baz"]
        }
    }
}

Via CLI

textlint --rule en-spell README.md

Build

Builds source codes for publish to the lib folder. You can write ES2015+ source codes in src/ folder.

npm run build

Tests

Run test code in test folder. Test textlint rule by textlint-tester.

npm test

Disclaimer

Please see DISCLAIMER.md.

License

MIT © Hood