A maven plugin that wraps the Detekt CLI. It supports the same parameters as the Detekt CLI.
<build>
<plugins>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
Using the above configuration, Detekt will scan source files in ${basedir}/src and output the results in ${basedir}/detekt.
All parameters available to Detekt version 1.21.0 can be configured in the plugin.
The plugin supports remote config over http and https.
<build>
<plugins>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
<configuration>
<plugins>
<config>https://raw.githubusercontent.com/Ozsie/detekt-maven-plugin/fd0de6d59e6ae1e062a9d2b030a171da1d3225ab/src/test/resources/resolve-config/remote/remote-config.yml</config>
</plugins>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<build>
<plugins>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
<configuration>
<plugins>
<plugin>path/to/plugin.jar</plugin>
</plugins>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
Or
<build>
<plugins>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>group</groupId>
<artifactId>artifact</artifactId>
<version>version</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
<build>
<plugins>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
<configuration>
<report>
<report>txt:reports/detekt.txt</report>
<report>xml:reports/detekt.xml</report>
</report>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
Alternatively, the configuration can be placed outside of the
<executions>
. This allows the configuration be used when running goals
standalone
<build>
<plugins>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<configuration>
<report>
<report>txt:reports/detekt.txt</report>
<report>xml:reports/detekt.xml</report>
</report>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
First a baseline file needs to be generated
mvn detekt:cb
This will generate a baseline file for each module named as baseline-<module-name>.xml
. For more information on generating baselines, see create-baseline. You can now reference the baseline file in your configuration, as below.
<build>
<plugins>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<configuration>
<baseline>baseline.xml</baseline>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
See Issue #144 for an explanation.
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<id>generate-classpath-var</id>
<phase>package</phase>
<goals><goal>build-classpath</goal></goals>
<configuration>
<outputProperty>generated.classpath</outputProperty>
<silent>true</silent>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.21.0</version>
<configuration>
<baseline>baseline.xml</baseline>
<classPath>${generated.classpath}</classPath>
<jvmTarget>17</jvmTarget>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals><goal>check</goal></goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
Used to run detekt. All cli parameters, excluding -gc and -cb, are available using -Ddetekt.{parameter}
Examples
mvn detekt:check -Ddetekt.config=detekt.yml
mvn detekt:check -Ddetekt.debug=true
Used to create a baseline. All cli parameters, excluding -gc and -cb, are available using -Ddetekt.{parameter}. By default, a file called baseline-.xml will be generated. If you include -Ddetekt.baseline in the call you can specify some other name for the baseline file.
Examples
mvn detekt:cb -Ddetekt.config=detekt.yml
mvn detekt:cb -Ddetekt.debug=true
mvn detekt:cb -Ddetekt.baseline=some-other-baseline.xml
mvn detekt:create-baseline -Ddetekt.config=detekt.yml
mvn detekt:create-baseline -Ddetekt.debug=true
Used to generate a default configuration file
Example
mvn detekt:gc
mvn detekt:generate-config
For more information on Detekt, have a look at https://github.com/detekt/detekt