Scalastyle examines your Scala code and indicates potential problems with it.
Note: This tool offers a different jar for each scala version. Inspecode uses the jar associated with the specified scala version.
Patterns to include in execution and reports.
Patterns to exclude from execution and reports.
Amount of CPU. The default machine has
0.25 CPU with
960 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.
-Xmx720m is specified by default (for
-Xmx5520m is specified for
Below is the list of options that are supported:
-c, --config FILE configuration file (required) --inputEncoding STRING encoding for the source files -e, --externalJar FILE jar containing custom rules -x, --excludedFiles STRING regular expressions to exclude file paths (delimitted by semicolons)
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:
- JAR files:
- Files specified to
With default options:
inspecode: scalastyle: default
With custom machine:
inspecode: scalastyle: machine: cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
With custom options:
inspecode: scalastyle: options: --externalJar: nofoobarchecker.jar
With a configuration file:
inspecode: scalastyle: config-file: lib/scalastyle_config.xml
The above configuration is equivalent to:
inspecode: scalastyle: options: --config: lib/scalastyle_config.xml
If no configuration files are specified via
options field, Inspecode walks the file tree in lexical order in your repository to find one of the following configuration files and specifies the file first found to Scalastyle 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: scalastyle: config-file: ""
If there are no configuration files in your repository, Inspecode specifies the default configuration file to Scalastyle by default since Scalastyle always requires a configuration file via