apache-rat:rat

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

Full name:

org.apache.rat:apache-rat-plugin:0.13-SNAPSHOT:rat

Description:

Generates a report with Rat's output.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Required Parameters

Name Type Since Description
basedir File - The base directory, in which to search for files.
Default value is: ${basedir}.
User property is: rat.basedir.
outputDirectory File - Specifies the directory where the report will be generated
Default value is: ${project.reporting.outputDirectory}.

Optional Parameters

Name Type Since Description
addDefaultLicenseMatchers boolean - Whether to add the default list of license matchers.
Default value is: true.
User property is: rat.addDefaultLicenseMatchers.
excludeSubProjects boolean - Whether to exclude subprojects. This is recommended, if you want a separate apache-rat-plugin report for each subproject.
Default value is: true.
User property is: rat.excludeSubprojects.
excludes String[] - Specifies files, which are excluded in the report. By default, no files are excluded.
excludesFile String - Specifies a file, from which to read excludes. Basically, an alternative to specifying the excludes as a list. The excludesFile is assumed to be using the UFT8 character set.
User property is: rat.excludesFile.
excludesFileCharset String - Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.
Default value is: ${project.build.sourceEncoding}.
User property is: rat.excludesFileCharset.
includes String[] - Specifies files, which are included in the report. By default, all files are included.
includesFile String - Specifies a file, from which to read includes. Basically, an alternative to specifying the includes as a list.
User property is: rat.includesFile.
includesFileCharset String - Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.
Default value is: ${project.build.sourceEncoding}.
User property is: rat.includesFileCharset.
licenseFamilies ILicenseFamily[] 0.8 Specifies the license families to accept.
licenseMatchers HeaderMatcherSpecification[] - Deprecated. Use licenses instead.
licenses IHeaderMatcher[] 0.8 Specifies the licenses to accept. By default, these are added to the default licenses, unless you set addDefaultLicenseMatchers to false.
parseSCMIgnoresAsExcludes boolean - Whether to parse source code management system (SCM) ignore files and use their contents as excludes. At the moment this works for the following SCMs:
Default value is: true.
User property is: rat.parseSCMIgnoresAsExcludes.
skip boolean 0.11 Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.
Default value is: false.
User property is: rat.skip.
useDefaultExcludes boolean - Whether to use the default excludes when scanning for files. The default excludes are:
Default value is: true.
User property is: rat.useDefaultExcludes.
useEclipseDefaultExcludes boolean - Whether to use the Eclipse specific default excludes when scanning for files. Eclipse specific default excludes are given by the constant ECLIPSE_DEFAULT_EXCLUDES: The .classpath and .project files, the .settings directory, and so on.
Default value is: true.
User property is: rat.useEclipseDefaultExcludes.
useIdeaDefaultExcludes boolean - Whether to use the IDEA specific default excludes when scanning for files. IDEA specific default excludes are given by the constant IDEA_DEFAULT_EXCLUDES: The *.iml, *.ipr and *.iws files and the .idea directory.
Default value is: true.
User property is: rat.useIdeaDefaultExcludes.
useMavenDefaultExcludes boolean - Whether to use the Maven specific default excludes when scanning for files. Maven specific default excludes are given by the constant MAVEN_DEFAULT_EXCLUDES: The target directory, the cobertura.ser file, and so on.
Default value is: true.
User property is: rat.useMavenDefaultExcludes.

Parameter Details

addDefaultLicenseMatchers:

Whether to add the default list of license matchers.
  • Type: boolean
  • Required: No
  • User Property: rat.addDefaultLicenseMatchers
  • Default: true

basedir:

The base directory, in which to search for files.
  • Type: java.io.File
  • Required: Yes
  • User Property: rat.basedir
  • Default: ${basedir}

excludeSubProjects:

Whether to exclude subprojects. This is recommended, if you want a separate apache-rat-plugin report for each subproject.
  • Type: boolean
  • Required: No
  • User Property: rat.excludeSubprojects
  • Default: true

excludes:

Specifies files, which are excluded in the report. By default, no files are excluded.
  • Type: java.lang.String[]
  • Required: No

excludesFile:

Specifies a file, from which to read excludes. Basically, an alternative to specifying the excludes as a list. The excludesFile is assumed to be using the UFT8 character set.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.excludesFile

excludesFileCharset:

Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.excludesFileCharset
  • Default: ${project.build.sourceEncoding}

includes:

Specifies files, which are included in the report. By default, all files are included.
  • Type: java.lang.String[]
  • Required: No

includesFile:

Specifies a file, from which to read includes. Basically, an alternative to specifying the includes as a list.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.includesFile

includesFileCharset:

Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.includesFileCharset
  • Default: ${project.build.sourceEncoding}

licenseFamilies:

Specifies the license families to accept.
  • Type: org.apache.rat.license.ILicenseFamily[]
  • Since: 0.8
  • Required: No

licenseMatchers:

Deprecated. Use licenses instead.
Specifies the licenses to accept. Deprecated, use licenses instead.
  • Type: org.apache.rat.mp.HeaderMatcherSpecification[]
  • Required: No

licenses:

Specifies the licenses to accept. By default, these are added to the default licenses, unless you set addDefaultLicenseMatchers to false.
  • Type: org.apache.rat.analysis.IHeaderMatcher[]
  • Since: 0.8
  • Required: No

outputDirectory:

Specifies the directory where the report will be generated
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}

parseSCMIgnoresAsExcludes:

Whether to parse source code management system (SCM) ignore files and use their contents as excludes. At the moment this works for the following SCMs:
  • Type: boolean
  • Required: No
  • User Property: rat.parseSCMIgnoresAsExcludes
  • Default: true

skip:

Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.
  • Type: boolean
  • Since: 0.11
  • Required: No
  • User Property: rat.skip
  • Default: false

useDefaultExcludes:

Whether to use the default excludes when scanning for files. The default excludes are:
  • Type: boolean
  • Required: No
  • User Property: rat.useDefaultExcludes
  • Default: true

useEclipseDefaultExcludes:

Whether to use the Eclipse specific default excludes when scanning for files. Eclipse specific default excludes are given by the constant ECLIPSE_DEFAULT_EXCLUDES: The .classpath and .project files, the .settings directory, and so on.
  • Type: boolean
  • Required: No
  • User Property: rat.useEclipseDefaultExcludes
  • Default: true

useIdeaDefaultExcludes:

Whether to use the IDEA specific default excludes when scanning for files. IDEA specific default excludes are given by the constant IDEA_DEFAULT_EXCLUDES: The *.iml, *.ipr and *.iws files and the .idea directory.
  • Type: boolean
  • Required: No
  • User Property: rat.useIdeaDefaultExcludes
  • Default: true

useMavenDefaultExcludes:

Whether to use the Maven specific default excludes when scanning for files. Maven specific default excludes are given by the constant MAVEN_DEFAULT_EXCLUDES: The target directory, the cobertura.ser file, and so on.
  • Type: boolean
  • Required: No
  • User Property: rat.useMavenDefaultExcludes
  • Default: true