Clirr Maven Plugin – clirr:clirr

clirr:clirr

Note:This goal should be used as a Maven report.

Full name:

org.codehaus.mojo:clirr-maven-plugin:2.8:clirr

Description:

Generate a report from the Clirr output.

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: compile.
Invokes the execution of the lifecycle phase compile prior to executing itself.

Required Parameters

Name	Type	Since	Description
outputDirectory	`File`	`-`	Specifies the directory where the report will be generated. Default value is: `${project.reporting.outputDirectory}`.

Optional Parameters

Name	Type	Since	Description
classesDirectory	`File`	`-`	The classes of this project to compare the last release against. Default value is: `${project.build.outputDirectory}`.
comparisonArtifacts	`ArtifactSpecification[]`	`-`	List of artifacts to compare the current code against. This overrides `comparisonVersion`, if present. Each `comparisonArtifact` is made of a `groupId`, an `artifactId` and a `version` number. Optionally it may have a `classifier` (default null) and a `type` (default "jar").
comparisonVersion	`String`	`-`	Version to compare the current code against. Default value is: `(,${project.version})`. User property is: `comparisonVersion`.
excludes	`String[]`	`-`	A list of classes to exclude. These classes are excluded from the list of classes that are included. Values are specified in path pattern notation, e.g. `org/codehaus/mojo/**`.
htmlReport	`boolean`	`-`	Whether to render the HTML report or not. Default value is: `true`. User property is: `htmlReport`.
ignored	`Difference[]`	`2.5`	A list of differences reported by Clirr that should be ignored when producing the final report. Values specified here will be joined with the ones specified using the "ignoredDifferencesFile" parameter.
ignoredDifferencesFile	`File`	`2.5`	A path to the XML file containing the ignored differences definitions. Values specified int the file will be joined with the ones specified using the "ignored" parameter. File Format <differences> ... <difference> <className>com.thoughtworks.qdox.parser.impl.Parser</className> <field></field> </difference> ... </differences> User property is*: `clirr.ignoredDifferencesFile`.
includes	`String[]`	`-`	A list of classes to include. Anything not included is excluded. If omitted, all are assumed to be included. Values are specified in path pattern notation, e.g. `org/codehaus/mojo/**`.
linkXRef	`boolean`	`-`	Link the violation line numbers to the source Xref. This will create links if the JXR Plugin is being used. Default value is: `true`. User property is: `linkXRef`.
logResults	`boolean`	`-`	Whether to log the results to the console or not. Default value is: `false`. User property is: `logResults`.
minSeverity	`String`	`-`	Show only messages of this severity or higher. Valid values are `info`, `warning` and `error`. Default value is: `warning`. User property is: `minSeverity`.
showSummary	`boolean`	`-`	Whether to show the summary of the number of errors, warnings and informational messages. Default value is: `true`. User property is: `showSummary`.
skip	`boolean`	`-`	Flag to easily skip execution. Default value is: `false`. User property is: `clirr.skip`.
skipArtifactTypeTest	`boolean`	`-`	(no description) Default value is: `false`. User property is: `clirr.skipArtifactTypeTest`.
textOutputFile	`File`	`-`	A text output file to render to. If omitted, no output is rendered to a text file. User property is: `textOutputFile`.
xmlOutputFile	`File`	`-`	An XML file to render to. If omitted, no output is rendered to an XML file. User property is: `xmlOutputFile`.
xrefLocation	`File`	`-`	Location of the Xrefs to link to. Default value is: `${project.build.directory}/site/xref`. User property is: `xrefLocation`.

Parameter Details

classesDirectory:

The classes of this project to compare the last release against.

Type: java.io.File
Required: No
Default: ${project.build.outputDirectory}

comparisonArtifacts:

List of artifacts to compare the current code against. This overrides comparisonVersion, if present. Each comparisonArtifact is made of a groupId, an artifactId and a version number. Optionally it may have a classifier (default null) and a type (default "jar").

Type: org.codehaus.mojo.clirr.ArtifactSpecification[]
Required: No

comparisonVersion:

Version to compare the current code against.

Type: java.lang.String
Required: No
User Property: comparisonVersion
Default: (,${project.version})

excludes:

A list of classes to exclude. These classes are excluded from the list of classes that are included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.

Type: java.lang.String[]
Required: No

htmlReport:

Whether to render the HTML report or not.

Type: boolean
Required: No
User Property: htmlReport
Default: true

ignored:

A list of differences reported by Clirr that should be ignored when producing the final report. Values specified here will be joined with the ones specified using the "ignoredDifferencesFile" parameter.

Type: org.codehaus.mojo.clirr.Difference[]
Since: 2.5
Required: No

ignoredDifferencesFile:

A path to the XML file containing the ignored differences definitions. Values specified int the file will be joined with the ones specified using the "ignored" parameter.
File Format

<differences>
  ...
  <difference>
    <className>com.thoughtworks.qdox.parser.impl.Parser</className>
    <field>*</field>
  </difference>
  ...
</differences>

Type: java.io.File
Since: 2.5
Required: No
User Property: clirr.ignoredDifferencesFile

includes:

A list of classes to include. Anything not included is excluded. If omitted, all are assumed to be included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.

Type: java.lang.String[]
Required: No

linkXRef:

Link the violation line numbers to the source Xref. This will create links if the JXR Plugin is being used.