Skip to main content

Misspell

Supported VersionLanguageWebsite
0.3.4Englishhttps://github.com/client9/misspell

Misspell is a spell checker to correct commonly misspelled English.

Getting Started#

To start using Misspell, enable it in your repository settings.

Configuration#

Here is a configuration example via sider.yml:

linter:  misspell:    exclude:      - vendor      - "**/*.min.js"      - exclude_file.rb    target:      - target_directory      - another_target_directory/foo.rb      - bar.rb    locale: UK    ignore:      - center      - behavior

You can use several options to more comfortable analysis to your project.

NameTypeDefault
root_dirstring-
targetstring, string[].
excludestring, string[]-
locale"US", "UK"-
ignorestring, string[]-

target#

This option allows you to specify files or directories to analyze.

caution

targets option is deprecated. Use target instead.

exclude#

This option allows you to exclude files or directories from your analysis. Glob is also available.

locale#

This option allows you to choose a spelling feature which is depended on locales. You can select:

  • US - American English
  • UK - British English

If the option is omitted, some words which have different spelling between the locales above will not be detected. For example, color and colour, center and centre, etc.

ignore#

This option allows you to ignore certain words when checking. This value can be a comma-separated list.