Configuring SideCI Analysis for Yourself

Your pull requests are analyzed by SideCI as soon as you register your project without specific configuration. SideCI provides you with analysis results even if you do not configure any settings. However, it may not provide you with analysis results you expected in some case. For example, it is when you would use your own config files: .myrubocop.yml and so on.
Using sideci.yml can help you to resolve that.

Configuration via sideci.yml

You need to add sideci.yml in your project's root directory to control SideCI analysis.

linter:
  rubocop:
    config: 'lint_yml/.myrubocop.yml'

  eslint:
    root_dir: 'frontend'
    npm_install: true
    options:
      config: 'frontend/.eslintrc'
      ext: 'js,jsx'

  stylelint:
    root_dir: 'app/assets/stylesheets'
    options:
      glob: '**/*.{css,scss}'

The options you can specify through sideci.yml are grouped into two categories.

  1. Analyzer specific options
  2. Common options available to all analyzers

Currently, root_dir is the only one common option.

Analysis tool specific configurations

You need to put settings on sideci.yml if you cannot configure in your settings file of the tool. It usually means command line interface of each tool. Furthermore you can use an option to make execution environment of analyzers; it is, for example, npm install. See documentations for each tool for the available option of the tool.

root_dir option

This is the common option for analyzers. The option is to specify the directory in your repository where SideCI runs the analyzer in. For example, when you put all JavaScript files in frontend directory, you would have a /sideci.yml like below:

linter:
  eslint:
    root_dir: 'frontend'

SideCI runs ESLint analysis in frontend directory. This allows to omit some configurations in /sideci.yml.