cspell

MegaLinter 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 !

If you do not want cspell to analyze the files names, define SPELL_CSPELL_ANALYZE_FILE_NAMES to false

cspell documentation

Version in MegaLinter: 8.16.0
Visit Official Web Site
See How to configure cspell rules
See How to disable cspell rules in files

Configuration in MegaLinter

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_ANALYZE_FILE_NAMES	If set to `true`, MegaLinter will also send file names to cspell for analysis. Disable by defining `SPELL_CSPELL_ANALYZE_FILE_NAMES` to `false`	`true`
SPELL_CSPELL_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
SPELL_CSPELL_COMMAND_REMOVE_ARGUMENTS	User custom arguments to remove from command line before calling the linter 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	`list_of_files`
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_UNSECURED_ENV_VARIABLES	List of env variables explicitly not filtered before calling SPELL_CSPELL and its pre/post commands	None
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 MegaLinter 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`
SPELL_CSPELL_CLI_EXECUTABLE	Override CLI executable	`['cspell']`

IDE Integration

Use cspell in your favorite IDE to catch errors before MegaLinter !

	IDE	Extension Name	Install
	Visual Studio Code	Code Spell Checker

MegaLinter Flavors

This linter is available in the following flavors

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	124
c_cpp	Optimized for pure C/C++ projects	54
cupcake	MegaLinter for the most commonly used languages	83
documentation	MegaLinter for documentation projects	49
dotnet	Optimized for C, C++, C# or VB based projects	62
dotnetweb	Optimized for C, C++, C# or VB based projects with JS/TS	71
go	Optimized for GO based projects	51
java	Optimized for JAVA based projects	52
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	59
php	Optimized for PHP based projects	54
python	Optimized for PYTHON based projects	62
ruby	Optimized for RUBY based projects	50
rust	Optimized for RUST based projects	50
salesforce	Optimized for Salesforce based projects	54
swift	Optimized for SWIFT based projects	50
terraform	Optimized for TERRAFORM based projects	54

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 (list_of_files CLI lint mode)

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] [globs...]             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.
  suggestions|sug [options] [words...]  Spelling Suggestions for words.
  link                                  Link dictionaries and other settings to
                                        the cspell global config.
  help [command]                        display help for command

Installation on mega-linter Docker image

NPM packages (node.js):
- cspell