Edit

ESLint

Supported Version	Language	Runtime	Website
5.0.0+ (default: 7.2.0)	JavaScript	Node.js 12.18.0	https://eslint.org

ESLint is a static analysis tool for JavaScript and its flavors (e.g. TypeScript, JSX, Vue). It can find problems, style violations, or security issues, etc. in your code, and have so many plugins.

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 for ESLint

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

Configuration

You can use the following options of sider.yml to make analysis fitter for your project. For example:

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

Name	Type	Default
root_dir	string	-
npm_install	boolean, string	-
dir	string, string[]	.
config	string	-
ext	string	.js
ignore-path	string	-
no-ignore	boolean	false
ignore-pattern	string, string[]	-
global	string	-
quiet	boolean	false

dir

This option allows you to specify one or more directories to analyze. For example:

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

config

This option allows you to specify an additional configuration file. See also the --config option.

ext

This option allows you to specify file extensions to analyze. See also the --ext option.

ignore-path

This option allows you to exclude files from analysis by your ignore file. See also the --ignore-path option.

no-ignore

This option allows you to disable the use of ignore files or patterns. See also the --no-ignore option.

ignore-pattern

This option allows you to ignore files by patterns. See also the --ignore-pattern option.

global

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

quiet

This option allows you to suppress warnings. When true, only errors are reported. See also the --quiet option.