cspell
Mega-Linter generates content of a .cspell.json
config file at the end of its TextReporter artifact
Copy it at the root of your repository, read it, remove real spelling errors (after have corrected them in the source), and you're good to go !
cspell documentation
- Version in Mega-Linter: 4.1.3
- Visit Official Web Site
- See How to configure cspell rules
- See How to disable cspell rules in files
Configuration in Mega-Linter
- Enable cspell by adding
SPELL_CSPELL
in ENABLE_LINTERS variable - Disable cspell by adding
SPELL_CSPELL
in DISABLE_LINTERS variable
Variable | Description | Default value |
---|---|---|
SPELL_CSPELL_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
SPELL_CSPELL_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src|lib) |
Include every file |
SPELL_CSPELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test|examples) |
Exclude no file |
SPELL_CSPELL_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
Exclude every file |
SPELL_CSPELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"] |
Include every file |
SPELL_CSPELL_CONFIG_FILE | cspell configuration file nameUse LINTER_DEFAULT to let the linter find it |
.cspell.json |
SPELL_CSPELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then Mega-Linter default rules |
SPELL_CSPELL_DISABLE_ERRORS | Run linter but consider errors as warnings | false |
IDE Integration
Use cspell in your favorite IDE to catch errors before Mega-Linter !
IDE | Extension Name | Install | |
---|---|---|---|
Visual Studio Code | Code Spell Checker | ![]() |
Mega-Linter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
![]() |
all | Default Mega-Linter Flavor | 83 | |
dart | Optimized for DART based projects | 37 | ||
documentation | Mega-Linter for documentation projects | 36 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 42 | ||
go | Optimized for GO based projects | 38 | ||
java | Optimized for JAVA based projects | 37 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 45 | ||
php | Optimized for PHP based projects | 40 | ||
python | Optimized for PYTHON based projects | 43 | ||
ruby | Optimized for RUBY based projects | 37 | ||
rust | Optimized for RUST based projects | 37 | ||
salesforce | Optimized for Salesforce based projects | 37 | ||
scala | Optimized for SCALA based projects | 37 | ||
swift | Optimized for SWIFT based projects | 37 | ||
terraform | Optimized for TERRAFORM based projects | 39 |
Behind the scenes
How are identified applicable files
- If this linter is active, all files linted by all other active linters will be linted
Example calls
cspell myfile.any
cspell -c cspell.json myfile.any
Help content
Usage: cspell [options] [command] <files...>
Spelling Checker for Code
Options:
-V, --version output the version number
-c, --config <cspell.json> Configuration file to use. By default cspell
looks for cspell.json in the current directory.
--no-color Turn off color.
--color Force color
-v, --verbose display more information about the files being
checked and the configuration
--local <local> Set language locals. i.e. "en,fr" for English and
French, or "en-GB" for British English.
--legacy Legacy output
--languageId <language> Force programming language for unknown
extensions. i.e. "php" or "scala"
--wordsOnly Only output the words not found in the
dictionaries.
-u, --unique Only output the first instance of a word not
found in the dictionaries.
--debug Output information useful for debugging
cspell.json files.
-e, --exclude <glob> Exclude files matching the glob pattern
--no-issues Do not show the spelling errors.
--no-summary Turn off summary message in console
-s, --silent Silent mode, suppress error messages
-r, --root <root folder> Root directory, defaults to current directory.
-h, --help display help for command
Commands:
trace [options] <words...> Trace words
check [options] <files...> Spell check file(s) and display the result. The
full file is displayed in color.
Examples:
cspell "*.js" Check all .js files in the current directory
cspell "**/*.js" Check all .js files from the current directory
cspell "src/**/*.js" Only check .js under src
cspell "**/*.txt" "**/*.js" Check both .js and .txt files.
cat LICENSE | cspell stdin Read from stdin the contents of LICENSE
Installation on mega-linter Docker image
- NPM packages (node.js):
Example success log
Results of cspell linter (version 4.1.3)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/spell_cspell/
-----------------------------------------------
[SUCCESS] .automation/test/spell
CSpell: Files checked: 1, Issues found: 0 in 0 files
Example error log
Results of cspell linter (version 4.1.3)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/spell_cspell/
-----------------------------------------------
[ERROR] .automation/test/spell
.automation/test/spell/spell_bad_1.js:1:28 - Unknown word (Blablabla)
CSpell: Files checked: 1, Issues found: 1 in 1 files
You can skip this misspellings by defining the following .cspell.json file at the root of your repository
Of course, please correct real typos before :)
{
"version": 0.1,
"language": "en",
"ignorePaths": [
"**/node_modules/**",
"**/vscode-extension/**",
"**/.git/**",
".vscode",
"report"
],
"words": [
"Blablabla"
]
}
You can also copy-paste /tmp/.cspell.json at the root of your repository