Sider Documentation

Sider Documentation

  • Enterprise
  • News
  • Sider Top

›Others

Getting Started

  • Home
  • Intro Videos
  • Setting up Sider
  • Dashboard Overview
  • Repository Settings
  • Custom Analysis Configuration
  • Recommended Ruleset
  • Working with Issues
  • Permissions
  • Skip Analyzing

Analysis Tools

    Ruby

    • RuboCop
    • Reek
    • Querly
    • Rails Best Practices
    • Brakeman
    • HAML-Lint
    • Slim-Lint (beta)

    Java

    • Checkstyle
    • PMD
    • JavaSee

    Kotlin

    • ktlint (beta)
    • detekt (beta)

    JavaScript and Flavors

    • ESLint
    • JSHint
    • TyScan
    • CoffeeLint
    • TSLint (deprecated)

    CSS

    • stylelint
    • SCSS-Lint (deprecated)

    PHP

    • PHP_CodeSniffer
    • PHPMD
    • Phinder

    Python

    • Flake8
    • Pylint (beta)

    Swift

    • SwiftLint

    Go

    • GolangCI-Lint

    C/C++

    • Cppcheck
    • cpplint
    • Clang-Tidy (beta)

    C#

    • FxCop (beta)

    Shell script

    • ShellCheck

    Dockerfile

    • hadolint

    Markdown

    • remark-lint

    Others

    • Goodcheck
    • Misspell
    • LanguageTool (beta)
    • PMD CPD (beta)

Custom Rules

  • Intro to Custom Rules
  • Goodcheck
  • Tips & Tricks

Advanced Settings

  • Inline Comments
  • Private Dependencies
  • Restricting access to Close button
  • Transferring a repository

Billing and Plans

  • Billing and Plans

Troubleshooting

  • Troubleshooting

Enterprise

  • Outline
  • System Overview
  • Installation
  • Configuration
  • Operation
  • Update
  • Load Balancer
  • MySQL
  • Redis
  • MinIO
  • Amazon S3
  • GitHub Enterprise Server
  • Clustering
  • Example Deployments

    • Single Node with Docker Compose

    Releases

    • Overview
    • February 2021
    • January 2021
    • December 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • February 2020
    • January 2020
    • November 2019
    • Older releases

News

  • 2021
  • 2020
  • 2019
Edit

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[][]
locale"US", "UK"-
ignorestring, string[]-

target

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

DEPRECATED: targets option has been 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.

← GoodcheckLanguageTool (beta) →
  • Getting Started
  • Configuration
    • target
    • exclude
    • locale
    • ignore
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.