Edit

ESLint

Supported Version	Language	Runtime	Website
5.0.0+ (default to 6.8.0)	JavaScript	Node.js 12.14.0	https://eslint.org

DEPRECATED: Sider will drop the support of ESLint 4.19.1 and older versions soon. Please upgrade to 5.0.0 and newer.

Getting Started

To start using ESLint, enable it in your repository settings. After enabled, Sider will automatically analyze your JavaScript files with the default version and default configuration. Or if you already have configured ESLint, Sider will install your dependencies and analyze with your configuration.

But if you want to customize more ESLint with some plugins or shareable configurations, install ESLint first:

$ npm install eslint --save-dev

Next, you may have to create your .eslintrc.* file(s) and configure ESLint with them. We recommend running eslint --init. It can ask you some questions and configure the settings for you automatically:

$ npx eslint --init

For more details about the configuration, see the ESLint documentation.

Then, if you need more customization, you can do it by adding a sider.yml file to your repository. For example, if you want to analyze React files in a frontend/ directory, you may configure your sider.yml as follows:

linter:
  eslint:
    dir: "frontend/"
    ext: ".js,.jsx"

For more details, see the following sections.

Default Configuration

Sider prepares the following configuration by default. The configuration is used when you have no ESLint configurations in your repository or sider.yml.

extends: "eslint:recommended"
rules:
  no-undef: off
  no-unused-vars: off

Configuration via sider.yml

Here is an example for ESLint:

linter:
  eslint:
    dir: frontend/app
    config: .my_eslintrc
    ext: ".js,.jsx,.es6"
    ignore-path: .my_eslintignore
    no-ignore: true
    ignore-pattern: "/src/vendor/*"
    global: "require,exports:true"
    quiet: true

You can use the following options to make analysis fitter for your project.

Name	Type	Default	Description
root_dir	string	-	A root directory.
npm_install	boolean, string	-	A behavior of npm installation.
dir	string, string[]	.	Directories to analyze.
config	string	-	--config option of ESLint.
ext	string	.js	--ext option of ESLint.
ignore-path	string	-	--ignore-path option of ESLint.
no-ignore	boolean	false	--no-ignore option of ESLint.
ignore-pattern	string, string[]	-	--ignore-pattern option of ESLint.
global	string	-	--global option of ESLint.
quiet	boolean	false	--quiet option of ESLint.

For details of the options, check the following sections and the ESLint documentation.

dir

This option allows you to specify a directory to analyze. For example:

linter:
  eslint:
    dir: frontend/src

Also, you can specify multiple directories or glob patterns:

linter:
  eslint:
    dir:
      - frontend/src
      - app/assets/javascripts
      - "**/__tests__/**"

config

This option allows you to specify an additional configuration file.

ext

This option allows you to specify file extensions to analyze.

ignore-path

This option allows you to exclude files from analysis by your ignore file.

no-ignore

This option allows you to disable the use of ignore files or patterns.

ignore-pattern

This option allows you to ignore files by patterns.

global

This option allows you to define global variables. It requires a comma-separated string.

quiet

This option allows you to suppress warnings. When true, only errors are reported.