Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard.
Patterns to include in execution and reports.
Patterns to exclude from execution and reports.
Amount of CPU. The default machine has
0.75 CPU with
2880 MiB RAM.
Inspecode configures the maximum heap size (
-Xmx) of the Java virtual machine (JVM) according to this value.
240 MiB RAM for system, and makes the rest of RAM available to JVM for heap allocation.
-Xmx2640m is specified by default (for
-Xmx5520m is specified for
Below is the list of options that are supported:
-c=<configurationFile> Sets the check configuration file to use. -e, --exclude=<exclude> Directory/File path to exclude from CheckStyle -E, --executeIgnoredModules Allows ignored modules to be run. -p=<propertiesFile> Loads the properties file
No tool specific severity levels are available.
Note: The incremental analysis is disabled if any kinds of configuration files are changed. The files recognized as configuration files are as follows:
- Configuration files:
- Files specified in
- Files specified to
- If none of the above configuration files are found:
- Properties files:
- Files specified to
No tool specific experimental options are available.
With default options:
inspecode: tools: checkstyle: default
With enabling auto-fixing and default options:
inspecode: tools: checkstyle: auto-fix
With custom machine:
inspecode: tools: checkstyle: machine: cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
With custom options:
inspecode: tools: checkstyle: options: -p: myCheckstyle.properties
With a configuration file:
inspecode: tools: checkstyle: config-file: /google_checks.xml
The above configuration is equivalent to:
inspecode: tools: checkstyle: options: -c: /google_checks.xml
/google_checks.xml is a configuration file embedded in Checkstyle, however, you can of course specify your own configuration file if you have.
If no configuration files are specified via
options field, Inspecode walks the file tree in lexical order in your repository to find a configuration file named
checkstyle.xml and specifies the file first found to Checkstyle automatically via
Note: Inspecode ignores specific configuration files while searching. See Configuration > Tool Configuration > Field:
If the configuration file detected by Inspecode is not the one you want to use or you do not want to use any configuration files, you can disable Inspecode from detecting configuration files by explicitly setting an empty string to
config-file field like below:
inspecode: tools: checkstyle: config-file: ""
If no configuration file can be determined from the YAML configuration and the repository search, Inspecode specifies /sun_checks.xml, which is embedded in Checkstyle itself, to Checkstyle by default since Checkstyle always requires a configuration file via