textlint-rule-common-misspellings

textlint-rule-common-misspellings

textlint rule to find common misspellings from Wikipedia: Lists of common misspellings.

Installing

npm install textlint-rule-common-misspellings

Usage

$ npm install textlint textlint-rule-common-misspellings
$ textlint --rule common-misspellings README.md

Configuration

Write your configuration into .textlintrc. Read documents in textlint official repository.

The default configuration is following:

{
    "rules": {
        "common-misspellings": {
            // Misspellings to be ignored (case-insensitive)
            "ignore": []
        }
    }
}

Example:

{
    "rules": {
        "common-misspellings": {
            // Misspellings to be ignored (case-insensitive)
            "ignore": [
                "isnt",
                "yuo",
            ]
        }
    }
}

Testing

npm test

Contributing

• 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

License

This software is licensed under GNU GPLv3. See LICENSE for full text of the license.

This software is using Wikipedia: Lists of common misspellings, which is licensed under Creative Commons Attribution-ShareAlike 3.0 Unported License, as a source of misspelling list.

The CC BY-SA 3.0 license says that the derived work also should be licensed under CC BY-SA. However, Creative Commons officially says it is not recommended to apply Creative Commons license to software.

Therefore, I decided to license this software under GPLv3 which is one-way compatible with CC BY-SA 4.0, and CC BY-SA 3.0 is compatible with CC BY-SA 4.0.

Acknowledgement

"textlint" is made by azu-san. Many thanks for creating the awesome linter tool.