Skip to content

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

cspell - GitHub

Configuration in Mega-Linter

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_CLI_LINT_MODE Override default CLI lint mode
- file: Calls the linter for each file
- list_of_files: Call the linter with the list of files as argument
- project: Call the linter from the root of the project		 {linter.cli_lint_mode}
SPELL_CSPELL_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".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_PRE_COMMANDS List of bash commands to run before the linter None
SPELL_CSPELL_POST_COMMANDS List of bash commands to run after the linter None
SPELL_CSPELL_CONFIG_FILE cspell configuration file name
Use 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
SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0

IDE Integration

Use cspell in your favorite IDE to catch errors before Mega-Linter !

IDE Extension Name Install
Visual Studio Code Code Spell Checker Install in VsCode

Mega-Linter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default Mega-Linter Flavor 94 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 41 Docker Image Size (tag) Docker Pulls
documentation Mega-Linter for documentation projects 40 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 47 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 42 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 42 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 49 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 44 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 49 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 41 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 41 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 43 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 41 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 41 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 45 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • If this linter is active, all files linted by all other active linters will be linted

How the linting is performed

  • cspell is called once with the list of files as arguments

Example calls

cspell myfile.any

cspell -c cspell.json myfile.any

Help content

Usage: cspell [options] [command]

Spelling Checker for Code

Options:
  -V, --version               output the version number
  -h, --help                  display help for command

Commands:
  lint [options] [files...]   Check spelling
  trace [options] <words...>  Trace words
    Search for words in the configuration and dictionaries.
  check [options] <files...>  Spell check file(s) and display the result. The
                              full file is displayed in color.
  link                        Link dictionaries any other settings to the
                              cspell global config.
  help [command]              display help for command

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://megalinter.github.io/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://megalinter.github.io/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