Getting Started

To start using Misspell, enable it in repository settings page on sider.review.

Configuration via sideci.yml

Here are example settings for Misspell under misspell:

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

Options

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

Details of options are in below.

exclude

This option allows you to exclude files or directories from analysis targets of Misspell. You can use glob to specify files or directories which you would like to exclude. You need to set values of the option as a list.

targets

This option allows you to specify files or directories which Misspell analyzes. You need to set values of the option as a list.

locale

This option allows you to choose a spelling feature which is depended on locales. You can select either UK or US. If you would like to check your English based on American English, write US. By default, you will not be corrected for words that have different spelling in British English and American English, for example colour(color), centre(center), etc.

ignore

This option allows you to ignore certain words when checking. If you list words in this option, the listed words will not be checked. If you want to declare multiple words in this option, you need to list each of them, separating each with a comma.