Skip to content

sbason/eslint-plugin-spellcheck

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eslint-plugin-spellcheck

eslint plugin to spell check words on identifiers, Strings and comments of javascript files.

Configuration

"comments": <<Boolean>> default: true
Check Spelling inside comments

"strings": <<Boolean>>, default: true
Check Spelling inside comments

"identifiers": <<Boolean>>, default: true
Check Spelling inside identifiers

"templates": <<Boolean>>, default: true
Check Spelling inside ES6 templates you should enable parser options for ES6 features for this to work
Refer to: [specifying-parser-options](https://eslint.org/docs/user-guide/configuring#specifying-parser-options)

"skipWords": <<Array Of Strings>> default: []
Array of words that will not be checked.

"skipIfMatch": <<Array Of Strings>> default: []
Array of Regular Expressions that if matched will not be checked.

Check example below

Usage in a project

  1. Install eslint-plugin-spellcheck as a dev-dependency:

    npm install --save-dev eslint-plugin-spellcheck
  2. Enable the plugin by adding it to your .eslintrc:

    plugins:
      - spellcheck
  3. You can also configure these rules in your .eslintrc. All rules defined in this plugin have to be prefixed by 'spellcheck/'

    "plugins": [
       "spellcheck"
    ],
    "rules": {
       "spellcheck/spell-checker": [1,
           {
               "comments": "true",
               "strings": "true",
               "identifiers": "true",
               "skipWords": [
                   "dict",
                   "aff",
                   "hunspellchecker",
                   "hunspell",
                   "utils"
               ],
               "skipIfMatch": [
                   "https://[^s]*"
               ]
            }
        ]
    }

Usage globally

  1. Install eslint-plugin-spellcheck as a global package:

    npm install -g eslint-plugin-spellcheck
  2. Enable the plugin by adding it to your eslint.json:

    "plugins": [
       "spellcheck"
    ],
    "rules": {
       "spellcheck/spell-checker": [1,
           {
               "comments": "true",
               "strings": "true",
               "identifiers": "true",
               "skipWords": [
                   "dict",
                   "aff",
                   "hunspellchecker",
                   "hunspell",
                   "utils"
                ],
                "skipIfMatch": [
                    "https://[^s]*"
                ]
                }
            ]
       }

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%