Skip to main content

roslynator spellcheck

Searches the specified project or solution for possible misspellings or typos.

Synopsis​

roslynator spellcheck <PROJECT|SOLUTION>
    --case-sensitive
    --culture <CULTURE_ID>
-d, --dry-run
    --exclude <GLOB>
    --file-log <FILE_PATH>
    --file-log-verbosity <LEVEL>
-h, --help
    --ignored-projects <PROJECT_NAME>
    --ignored-scope <SCOPE>
    --include <GLOB>
    --include-generated-code
    --interactive
    --language <LANGUAGE>
    --max-word-length <NUM>
    --min-word-length <NUM>
-m, --msbuild-path <DIRECTORY_PATH>
    --projects <PROJECT_NAME>
-p, --properties <NAME=VALUE>
    --scope <SCOPE>
-v, --verbosity <LEVEL>
    --visibility <VISIBILITY>
    --words <PATH>

Arguments​

<PROJECT|SOLUTION>

Path to one or more project/solution files.

Options​

--case-sensitive​

Specifies case-sensitive matching.

--culture <CULTURE_ID>​

Defines culture that should be used to display diagnostic message.

-d, --dry-run​

Display misspellings and typos but do not save changes to a disk.

--exclude <GLOB>​

Space separated list of glob patterns to exclude files, folders, solutions or projects. For further information about the syntax see reference documentation.

--file-log <FILE_PATH>​

Path to a file that should store output.

--file-log-verbosity <LEVEL>​

Verbosity of the file log. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed] and diag[nostic].

-h, --help​

Show command line help.

--ignored-projects <PROJECT_NAME>​

Defines projects that should not be analyzed.

--ignored-scope <SCOPE>​

Defines syntax that should not be analyzed. Allowed values are comment, type, member, local, parameter, literal, non-symbol, symbol and file-name.

--include <GLOB>​

Space separated list of glob patterns to include files, folders, solutions or projects. For further information about the syntax see reference documentation.

--include-generated-code​

Indicates whether generated code should be spellchecked.

--interactive​

Enable editing of a replacement.

--language <LANGUAGE>​

Defines project language. Allowed values are cs[harp] or v[isual-]b[asic].

--max-word-length <NUM>​

Specifies maximal word length to be checked.

--min-word-length <NUM>​

Specifies minimal word length to be checked. Default value is 3.

-m, --msbuild-path <DIRECTORY_PATH>​

Defines a path to MSBuild directory.

--projects <PROJECT_NAME>​

Defines projects that should be analyzed.

-p, --properties <NAME=VALUE>​

Defines one or more MSBuild properties.

--scope <SCOPE>​

Defines syntax that should be analyzed. Allowed values are comment, type, member, local, parameter, literal, non-symbol, symbol, file-name and all. Literals and file names are not analyzed by default.

-v, --verbosity <LEVEL>​

Verbosity of the log. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed] and diag[nostic].

--visibility <VISIBILITY>​

Defines a maximal visibility of a symbol to be fixable. Allowed values are public (default), internal or private.

--words <PATH>​

Specified path to file and/or directory that contains list of known words.

Redirected/Piped Input​

Redirected or piped input is treated as a list of project/solution paths, one per line.

How to Suppress Spellchecking​

Misspellings and typos are reported as diagnostic RCS2001. You can suppress it like any other diagnostic.

List of Allowed Words​

  • Specify one or more wordlists with the --words parameter.
  • A wordlist is a text file containing values separated by newlines.
  • Each value is either a valid word (for example, misspell) or a fix in the format <ERROR>: <FIX> (for example, mispell: misspell).
  • Word matching is case-insensitive by default (use --case-sensitive for case-sensitive matching).
  • Wordb wordlists are tailored for spellchecking.

Output​

  • Command output contains up to four lists in the following order:
    • Words containing unknown words — for example, a method name made up of multiple words where one or more is unknown, such as GetMaxWidht.
    • Unknown words — words not found in any wordlist.
    • Auto fixes — automatically applied fixes.
    • User-applied fixes — fixes applied by the user (when --interactive is set).

Use these lists to update wordlists so they match the codebase more closely.

NOTE: Set verbosity to normal (default) or higher for the output to include these lists.