Nascent Political Miscreant

    textlint-rule-common-misspellings

    1.0.1 • Public • Published

    textlint-rule-common-misspellings

    textlint rule Build Status npm version GitHub license

    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

    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

    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.

    Install

    npm i textlint-rule-common-misspellings

    DownloadsWeekly Downloads

    4,935

    Version

    1.0.1

    License

    GPL-3.0

    Last publish

    Collaborators

    • avatar