Setup

Installation

haxelib install checkstyle

Options

To see all the options available run the following command.

haxelib run checkstyle

[-s | --source] <path>    : Set source folder to process (multiple allowed)
[-c | --config] <path>    : Set config file (default: checkstyle.json)
[-e | --exclude] <path>   : Set exclude config file (default: checkstyle-exclude.json)
[-r | --reporter] <name>  : Set reporter (xml, json or text, default: text)
[-p | --path] <path>      : Set reporter output path
[-x | --xslt] <style>     : Set reporter style (XSLT)
[-progress]               : Show percentage progress
[-exitcode]               : Return number of failed checks in exitcode
[--list-checks]           : List all available checks and exit
[--list-reporters]        : List all available reporters and exit
[--default-config] <path> : Generate a default config and exit
[-nostyle]                : To omit styling in output summary
[-report]                 : Show report [DEPRECATED]

Rules

The default configuration can be found here.

It's recommended to define your own set of rules based on the needs of your project.

The library will automatically look for checkstyle.json at root level where all the rules and excludes can be defined.

By default the severity of all the checks was set to INFO. You can define the severity of each check in the custom configuration of your project.

The following is a sample .json with 2 rules.

{
    "checks": [
        {
            "type": "EmptyLines",
            "props": {
                "severity": "INFO",
                "maxConsecutiveEmptyLines": 1
            }
        },
        {
            "type": "FileLength",
            "props": {
                "severity": "WARNING",
                "max": 2000
            }
        }
    ]
}

Running Checkstyle

haxelib run checkstyle -s src

Multiple source folders can be defined as shown below:

haxelib run checkstyle -s src -s samples

Exclude Packages/Classes

Classes/Packages can be excluded as shown below for each check:

Note that exclude paths should be relative to the source paths specified.

"exclude": {
        "all": [],
        "Dynamic": [
            "checkstyle.Main",
            "checkstyle.Checker"
        ],
        "MultipleStringLiterals": [
            "checks",
            "token"
        ],
        "NestedForDepth": [
            "TestMain"
        ],
        "MemberName": [
            "checkstyle.Main"
        ]
    }

Suppress Warnings

An alternative way to exclude classes/methods using meta data.

SuppressWarnings is an useful feature when you want to omit a class/function/line from a specific check.

For example, if you have a class which has Dynamic usage and you want to omit that class from Dynamic check you can use @SuppressWarnings as show below.

@SuppressWarnings("checkstyle:Dynamic")`

You can also omit multiple checks.

@SuppressWarnings("checkstyle:Dynamic", "checkstyle:LineLength")`

Note that @SuppressWarnings may not work on all checks.

Hudson and Bamboo Integration

Checkstyle has xml report option that can be used to integrate with Hudson and Bamboo.

If you want to style the generated XML you can set XSLT style for the XML generated. See the sample below.

haxelib run checkstyle -s src -c config.json -p report.xml -x report.xsl

Sample Hudson Checkstyle Trend Chart: