errorprone:configuration

Full name:

io.github.jonasrutishauser.maven:errorprone-maven-plugin:1.1.0:configuration

Description:

No description.

Attributes:

Requires a Maven project to be executed.
The goal is thread-safe and supports parallel builds.
Binds by default to the lifecycle phase: process-resources.

Optional Parameters

Name	Type	Since	Description
`<allDisabledChecksAsWarnings>`	`boolean`	`-`	Enables all Error Prone checks, checks that are disabled by default are enabled as warnings. Maps to `-XepAllDisabledChecksAsWarnings`. This will be among the first arguments, so checks can then be disabled again on a case-by-case basis. Default: `false` User Property: `errorprone.allDisabledChecksAsWarnings`
`<allErrorsAsWarnings>`	`boolean`	`-`	Turns all Error Prone errors into warnings. Maps to `-XepAllErrorsAsWarnings`. This will be among the first arguments, so checks can then be promoted back to error on a case-by-case basis. Default: `false` User Property: `errorprone.allErrorsAsWarnings`
`<allSuggestionsAsWarnings>`	`boolean`	`-`	Turn all Error Prone suggestions into warnings. Maps to `-XepAllSuggestionsAsWarnings`. This will be among the first arguments, so checks can then be demoted back to suggestions on a case-by-case basis. Default: `false` User Property: `errorprone.allSuggestionsAsWarnings`
`<arguments>`	`List<String>`	`-`	Additional arguments passed to Error Prone. User Property: `errorprone.arguments`
`<checks>`	`Map<String,CheckSeverity>`	`-`	A map of check name to `CheckSeverity`, to configure which checks are enabled or disabled, and their severity. Maps each entry to `-Xep:<key>:<value>`, or `-Xep:<key>` if the value is `CheckSeverity.DEFAULT`.
`<compilingTestOnlyCode>`	`boolean`	`-`	Tells Error Prone that the compilation contains only test code. Maps to `-XepCompilingTestOnlyCode`. Default: `false`
`<disableAllChecks>`	`boolean`	`-`	Disable all Error Prone checks. Maps to `-XepDisableAllChecks`. This will be the first argument, so checks can then be re-enabled on a case-by-case basis. Default: `false` User Property: `errorprone.disableAllChecks`
`<disableAllWarnings>`	`boolean`	`-`	Disables all Error Prone warnings. Maps to `-XepDisableAllWarnings`. This will be among the first arguments, so checks can then be re-enabled on a case-by-case basis. Default: `false` User Property: `errorprone.disableAllWarnings`
`<disableWarningsInGeneratedCode>`	`boolean`	`-`	Disables warnings in classes annotated with `@Generated`. Maps to `-XepDisableWarningsInGeneratedCode`. Default: `false` User Property: `errorprone.disableWarningsInGeneratedCode`
`<enabled>`	`boolean`	`-`	Allows disabling Error Prone altogether. Error Prone will still be in the annotation processor path, but `-Xplugin:ErrorProne` won't be passed as a compiler argument. Default: `true` User Property: `errorprone.enabled`
`<excludePaths>`	`String`	`-`	A regular expression pattern of file paths to exclude from Error Prone checking. Maps to `-XepExcludedPaths`. User Property: `errorprone.excludePaths`
`<ignoreSuppressionAnnotations>`	`boolean`	`-`	Ignores suppression annotations, such as `@SuppressWarnings`. Maps to `-XepIgnoreSuppressionAnnotations`. Default: `false` User Property: `errorprone.ignoreSuppressionAnnotations`
`<ignoreUnknownCheckNames>`	`boolean`	`-`	Tells Error Prone to ignore unknown check names in `checks`. Maps to `-XepIgnoreUnknownCheckNames`. Default: `false` User Property: `errorprone.ignoreUnknownCheckNames`
`<namespacedOptions>`	`Map<...>`	`-`	A map of namespaced check options to their value. Use an explicit `"true"` value for a boolean option. Maps each entry to `-XepOpt:<namespace>:<key>=<value>`.
`<options>`	`Map<String,String>`	`-`	A map of check options to their value. Use an explicit `"true"` value for a boolean option. Maps each entry to `-XepOpt:<key>=<value>`.
`<propertyName>`	`String`	`-`	The name of the `project property` which will be set to the generated compiler argument (the value will be of the form `-Xplugin:ErrorProne <options>`). Default: `errorprone.compile.argument`

Parameter Details

<allDisabledChecksAsWarnings>

Enables all Error Prone checks, checks that are disabled by default are enabled as warnings. Maps to -XepAllDisabledChecksAsWarnings.

This will be among the first arguments, so checks can then be disabled again on a case-by-case basis.

Type: boolean
Required: No
User Property: errorprone.allDisabledChecksAsWarnings
Default: false

<allErrorsAsWarnings>

Turns all Error Prone errors into warnings. Maps to -XepAllErrorsAsWarnings.

This will be among the first arguments, so checks can then be promoted back to error on a case-by-case basis.

Type: boolean
Required: No
User Property: errorprone.allErrorsAsWarnings
Default: false

<allSuggestionsAsWarnings>

Turn all Error Prone suggestions into warnings. Maps to -XepAllSuggestionsAsWarnings.

This will be among the first arguments, so checks can then be demoted back to suggestions on a case-by-case basis.

Type: boolean
Required: No
User Property: errorprone.allSuggestionsAsWarnings
Default: false

<arguments>

Additional arguments passed to Error Prone.

Type: java.util.List<java.lang.String>
Required: No
User Property: errorprone.arguments

<checks>

A map of check name to CheckSeverity, to configure which checks are enabled or disabled, and their severity.

Maps each entry to -Xep:<key>:<value>, or -Xep:<key> if the value is CheckSeverity.DEFAULT.

Type: java.util.Map<java.lang.String, io.github.jonasrutishauser.errorprone.maven.plugin.CheckSeverity>
Required: No

<compilingTestOnlyCode>

Tells Error Prone that the compilation contains only test code. Maps to -XepCompilingTestOnlyCode.

Type: boolean
Required: No
Default: false

<disableAllChecks>

Disable all Error Prone checks. Maps to -XepDisableAllChecks.

This will be the first argument, so checks can then be re-enabled on a case-by-case basis.

Type: boolean
Required: No
User Property: errorprone.disableAllChecks
Default: false

<disableAllWarnings>

Disables all Error Prone warnings. Maps to -XepDisableAllWarnings.

This will be among the first arguments, so checks can then be re-enabled on a case-by-case basis.

Type: boolean
Required: No
User Property: errorprone.disableAllWarnings
Default: false

<disableWarningsInGeneratedCode>

Disables warnings in classes annotated with @Generated. Maps to -XepDisableWarningsInGeneratedCode.

Type: boolean
Required: No
User Property: errorprone.disableWarningsInGeneratedCode
Default: false

<enabled>

Allows disabling Error Prone altogether.

Error Prone will still be in the annotation processor path, but -Xplugin:ErrorProne won't be passed as a compiler argument.

Type: boolean
Required: No
User Property: errorprone.enabled
Default: true

<excludePaths>

A regular expression pattern of file paths to exclude from Error Prone checking. Maps to -XepExcludedPaths.

Type: java.lang.String
Required: No
User Property: errorprone.excludePaths

<ignoreSuppressionAnnotations>

Ignores suppression annotations, such as @SuppressWarnings. Maps to -XepIgnoreSuppressionAnnotations.

Type: boolean
Required: No
User Property: errorprone.ignoreSuppressionAnnotations
Default: false

<ignoreUnknownCheckNames>

Tells Error Prone to ignore unknown check names in checks. Maps to -XepIgnoreUnknownCheckNames.

Type: boolean
Required: No
User Property: errorprone.ignoreUnknownCheckNames
Default: false

<namespacedOptions>

A map of namespaced check options to their value.

Use an explicit "true" value for a boolean option.

Maps each entry to -XepOpt:<namespace>:<key>=<value>.

Type: java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>
Required: No

<options>

A map of check options to their value.

Use an explicit "true" value for a boolean option.

Maps each entry to -XepOpt:<key>=<value>.

Type: java.util.Map<java.lang.String, java.lang.String>
Required: No

<propertyName>

The name of the project property which will be set to the generated compiler argument (the value will be of the form -Xplugin:ErrorProne <options>).

Type: java.lang.String
Required: No
Default: errorprone.compile.argument