Checkstyle

Web Sitehttp://checkstyle.sourceforge.net
LanguageJava 8
Supported Version8.10

Getting Started

To start using Checkstyle, enable it in the repository setting.

Configuration

You can customize Checkstyle analysis using sideci.yml.

linter:
  checkstyle:
    config: google
    dir: src
    exclude:
      - vendor
      - pattern: foo
    ignore:
      - warning
      - info

config

This option allows you to declare the configuration you want to follow. The default value is google.

Supported values are:

When you write google or sun, config files distributed from Checkstyle are used.

dir

This option allows you to specify the directories you want to check in your repository. The default value is ..

You can write a string or a sequence of strings.

exclude

This option allows you to specify -e and -x command line option of checkstyle command. The value should be a sequence of the followings:

The default value is empty (nothing will be excluded.)

ignore

This option allows you to ignore issues based on their severity. Write the list of severities you want to ignore in SideCI.

The default value is empty (nothing will be ignored.)

properties

This option allows you to specify properties file given to checkstyle. The value will be passed to the -p commandline option of checkstyle.

There is no default value.