commit
75b5f5c5a9
17 changed files with 284 additions and 153 deletions
|
@ -1 +1 @@
|
|||
Subproject commit b8593e541ba9a11447fa9559a83e5f99097ca4d2
|
||||
Subproject commit b97def251b784ecc8de6d3cc30d2793ac0bd375e
|
10
CHANGELOG
10
CHANGELOG
|
@ -1,6 +1,16 @@
|
|||
CHANGELOG
|
||||
=========
|
||||
|
||||
4.0.0
|
||||
-----
|
||||
|
||||
* Upgrade to `maven-checkstyle-plugin` 3.0.0
|
||||
* Change ruleset groupId/artifactId to `net.kemitix.checkstyle/ruleset`
|
||||
* Add maven-tile `net.kemitix.checkstyle:tile`
|
||||
* \[bug] update the ruleset files
|
||||
* Restore Header and JavadocPackage checks
|
||||
* Add missing reasons for disabling checks
|
||||
|
||||
3.4.0
|
||||
-----
|
||||
|
||||
|
|
114
README.md
114
README.md
|
@ -1,10 +1,9 @@
|
|||
# kemitix-checkstyle-ruleset
|
||||
|
||||
Provides an extensive Checkstyle ruleset for use with Apache's `maven-checkstyle-plugin`.
|
||||
Provides an extensive Checkstyle ruleset for use with Checkstyle, together with a fully configured maven-tile.
|
||||
|
||||
The ruleset includes checks from both the core Checkstyle library and from the Sevntu-Checkstyle library.
|
||||
|
||||
* [Requirements](#requirements)
|
||||
* [Usage](#usage)
|
||||
* [All Checks](#all-checks)
|
||||
* [Enabled Checks](#enabled-checks)
|
||||
|
@ -14,16 +13,32 @@ The ruleset includes checks from both the core Checkstyle library and from the S
|
|||
* [Checkstyle](#checkstyle-1)
|
||||
* [Sevntu](#sevntu-1)
|
||||
|
||||
## Requirements
|
||||
|
||||
* [maven-checkstyle-plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/) 2.17+
|
||||
* [Checkstyle](http://checkstyle.sourceforge.net/) 7.0+
|
||||
* [Sevntu-checkstyle](http://sevntu-checkstyle.github.io/sevntu.checkstyle/) 1.21.0+
|
||||
|
||||
## Usage
|
||||
|
||||
To use this ruleset add the plugin `kemitix-checktyle-ruleset-maven-plugin`.
|
||||
The `maven-checkstyle-plugin` will be included automatically.
|
||||
The simplest way to use the ruleset is with the maven-tile:
|
||||
|
||||
```xml
|
||||
<project>
|
||||
<properties>
|
||||
<tiles-maven-plugin.version>2.10</tiles-maven-plugin.version>
|
||||
</properties>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.repaint.maven</groupId>
|
||||
<artifactId>tiles-maven-plugin</artifactId>
|
||||
<version>${tiles-maven-plugin.version}</version>
|
||||
<extensions>true</extensions>
|
||||
<configuration>
|
||||
<tiles>
|
||||
<tile>net.kemitix.checkstyle:tile:4.0.0</tile>
|
||||
</tiles>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
```
|
||||
|
||||
The following levels implement increasingly strict rulesets:
|
||||
|
||||
|
@ -34,40 +49,11 @@ The following levels implement increasingly strict rulesets:
|
|||
* 4-tweaks
|
||||
* 5-complexity
|
||||
|
||||
The default ruleset from the maven-tile is 5-complexity. Other levels can be selected by setting the `kemitix.checkstyle.ruleset.level` to one the values above.
|
||||
|
||||
### Change from 2.x
|
||||
|
||||
In 2.x, the level was specified as the goal to invoke. In 3.x, there is only the 'check' goal.
|
||||
The level is now specified as a configuration parameter. See the example below.
|
||||
|
||||
### Example
|
||||
|
||||
````
|
||||
<properties>
|
||||
<kemitix-checkstyle-ruleset.version>2.1.0</kemitix-checkstyle-ruleset.version>
|
||||
<kemitix-checkstyle-ruleset.level>5-complexity</kemitix-checkstyle-ruleset.level>
|
||||
</properties>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>net.kemitix</groupId>
|
||||
<artifactId>kemitix-checkstyle-ruleset-maven-plugin</artifactId>
|
||||
<version>${kemitix-checkstyle-ruleset.version}</version>
|
||||
<configuration>
|
||||
<level>${kemitix-checkstyle-ruleset.level}</level>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>validate</phase>
|
||||
<goals>
|
||||
<goal>check</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
````
|
||||
In 2.x, the level was specified as the goal to invoke. In 3.x, there is only the 'check' goal. The level is now specified as a configuration parameter. See the example below. The kemitix-checkstyle-maven-plugin has also been removed in favour of the maven-tile.
|
||||
|
||||
## All Checks
|
||||
|
||||
|
@ -90,8 +76,8 @@ Rule|Level|Source|Enabled|Suppressible
|
|||
[AvoidModifiersForTypes](#avoidmodifiersfortypes)|unspecified|sevntu||
|
||||
[AvoidNestedBlocks](#avoidnestedblocks)|complexity|checkstyle|Yes|
|
||||
[AvoidNotShortCircuitOperatorsForBoolean](#avoidnotshortcircuitoperatorsforboolean)|tweaks|sevntu|Yes|
|
||||
[AvoidStarImport](#avoidstarimport)|layout|checkstyle|Yes|
|
||||
[AvoidStaticImport](#avoidstaticimport)|complexity|checkstyle|Yes|
|
||||
[AvoidStarImport](#avoidstarimport)|layout|checkstyle||
|
||||
[AvoidStaticImport](#avoidstaticimport)|complexity|checkstyle||
|
||||
[BooleanExpressionComplexity](#booleanexpressioncomplexity)|complexity|checkstyle|Yes|
|
||||
[CatchParameterName](#catchparametername)|naming|checkstyle|Yes|
|
||||
[CauseParameterInException](#causeparameterinexception)|tweaks|sevntu||
|
||||
|
@ -414,37 +400,6 @@ Invalid:
|
|||
// ...
|
||||
}
|
||||
````
|
||||
#### [AvoidStarImport](http://checkstyle.sourceforge.net/config_imports.html#AvoidStarImport)
|
||||
|
||||
Prevents the use of the star import.
|
||||
|
||||
Invalid:
|
||||
````
|
||||
import java.awt.*;
|
||||
import java.awt.event.*;
|
||||
import javax.swing.*;
|
||||
import javax.swing.event.*;
|
||||
````
|
||||
#### [AvoidStaticImport](http://checkstyle.sourceforge.net/config_imports.html#AvoidStaticImport)
|
||||
|
||||
Prevents importing static members, unless they are one of the following:
|
||||
|
||||
* `org.assertj.core.api.Assertions.assertThat`
|
||||
* `org.mockito.BDDMockito.given`
|
||||
* `org.mockito.Mockito.*`
|
||||
* `org.mockito.Matchers.*`
|
||||
* `org.mockito.Mockito.*`
|
||||
|
||||
Valid:
|
||||
````
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
````
|
||||
|
||||
Invalid:
|
||||
````
|
||||
import static java.nio.charset.StandardCharsets.UTF_8;
|
||||
````
|
||||
#### [BooleanExpressionComplexity](http://checkstyle.sourceforge.net/config_metrics.html#BooleanExpressionComplexity)
|
||||
|
||||
Restrict the number of number of &&, ||, &, | and ^ in an expression to 2.
|
||||
|
@ -1233,7 +1188,7 @@ Checks that paragraphs in Javadoc blocks are wrapped in `<p>` elements and have
|
|||
Checks the formatting of the Javadoc blocks. See the official [Checkstyle documentation](http://checkstyle.sourceforge.net/config_javadoc.html#JavadocStyle) for all the checks that are applied.
|
||||
#### [JavadocType](http://checkstyle.sourceforge.net/config_javadoc.html#JavadocType)
|
||||
|
||||
Checks the format for Javadoc for classes and enums. Javadoc must be present, not have any unknown tags and not missing any `@param` tags. The `@author` tag must have a name and, in brackets, an email address.
|
||||
Checks the format for Javadoc for classes and enums. Javadoc must be present, not have any unknown tags and not missing any `@param` tags.
|
||||
#### [JavaNCSS](http://checkstyle.sourceforge.net/config_metrics.html#JavaNCSS)
|
||||
|
||||
Restricts the NCSS score for methods, classes and files to 40, 1200 and 1600 respectively. The NCSS score is a measure of the number of statements within a scope.
|
||||
|
@ -2681,6 +2636,13 @@ These checks are not enabled. Notes are included for each explaining why.
|
|||
#### [ArrayTrailingComma](http://checkstyle.sourceforge.net/config_coding.html#ArrayTrailingComma)
|
||||
|
||||
Couldn't get my IDE's (IntelliJ) code style to match.
|
||||
#### [AvoidStarImport](http://checkstyle.sourceforge.net/config_imports.html#AvoidStarImport)
|
||||
|
||||
Ref: Clean Code, Robert C. Martin, J1: Avoid Long Import Lists by Using Wildcards
|
||||
#### [AvoidStaticImport](http://checkstyle.sourceforge.net/config_imports.html#AvoidStaticImport)
|
||||
|
||||
Ref: Clean Code, Robert C. Martin, J2: Don't Inherit Constants
|
||||
Recommends using a static import to access constants from another class over inheriting them.
|
||||
#### [FinalLocalVariable](http://checkstyle.sourceforge.net/config_coding.html#FinalLocalVariable)
|
||||
|
||||
Doesn't recognise Lombok's `val` as being `final`.
|
||||
|
|
|
@ -12,16 +12,17 @@
|
|||
</parent>
|
||||
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>ruleset-builder</artifactId>
|
||||
<artifactId>builder</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
<version>3.4.0</version>
|
||||
<version>4.0.0</version>
|
||||
|
||||
<properties>
|
||||
<maven.install.skip>true</maven.install.skip>
|
||||
<java.version>1.8</java.version>
|
||||
<tiles-maven-plugin.version>2.10</tiles-maven-plugin.version>
|
||||
<kemitix-tiles.version>0.2.0</kemitix-tiles.version>
|
||||
|
||||
<checkstyle.version>8.7</checkstyle.version>
|
||||
<checkstyle.version>8.6</checkstyle.version>
|
||||
<sevntu.version>1.26.0</sevntu.version>
|
||||
<lombok.version>1.16.18</lombok.version>
|
||||
<spring-platform.version>Brussels-SR6</spring-platform.version>
|
||||
|
@ -30,6 +31,11 @@
|
|||
<map-builder.version>1.0.0</map-builder.version>
|
||||
<mockito.version>2.13.0</mockito.version>
|
||||
<assertj.version>3.9.0</assertj.version>
|
||||
|
||||
<maven-checkstyle-plugin.version>3.0.0</maven-checkstyle-plugin.version>
|
||||
<kemitix.checkstyle.ruleset.version>${project.version}</kemitix.checkstyle.ruleset.version>
|
||||
<kemitix.checkstyle.ruleset.level>5-complexity</kemitix.checkstyle.ruleset.level>
|
||||
<kemitix.checkstyle.ruleset.location>net/kemitix/checkstyle-${kemitix.checkstyle.ruleset.level}.xml</kemitix.checkstyle.ruleset.location>
|
||||
</properties>
|
||||
|
||||
<dependencyManagement>
|
||||
|
@ -120,7 +126,6 @@
|
|||
<tile>net.kemitix.tiles:maven-plugins-tile:${kemitix-tiles.version}</tile>
|
||||
<tile>net.kemitix.tiles:enforcer-tile:${kemitix-tiles.version}</tile>
|
||||
<tile>net.kemitix.tiles:compiler-tile:${kemitix-tiles.version}</tile>
|
||||
<!--<tile>net.kemitix.tiles:checkstyle-tile:${kemitix-tiles.version}</tile>-->
|
||||
<tile>net.kemitix.tiles:huntbugs-tile:${kemitix-tiles.version}</tile>
|
||||
<tile>net.kemitix.tiles:pmd-tile:${kemitix-tiles.version}</tile>
|
||||
<tile>net.kemitix.tiles:testing-tile:${kemitix-tiles.version}</tile>
|
||||
|
@ -138,8 +143,42 @@
|
|||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>repackage</goal>
|
||||
<goal>run</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
<version>${maven-checkstyle-plugin.version}</version>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.puppycrawl.tools</groupId>
|
||||
<artifactId>checkstyle</artifactId>
|
||||
<version>${checkstyle.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.sevntu-checkstyle</groupId>
|
||||
<artifactId>sevntu-checkstyle-maven-plugin</artifactId>
|
||||
<version>${sevntu.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>ruleset</artifactId>
|
||||
<version>${kemitix.checkstyle.ruleset.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<configuration>
|
||||
<configLocation>${kemitix.checkstyle.ruleset.location}</configLocation>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>verify</phase>
|
||||
<goals>
|
||||
<goal>check</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
|
|
|
@ -1,10 +1,9 @@
|
|||
# kemitix-checkstyle-ruleset
|
||||
|
||||
Provides an extensive Checkstyle ruleset for use with Apache's `maven-checkstyle-plugin`.
|
||||
Provides an extensive Checkstyle ruleset for use with Checkstyle, together with a fully configured maven-tile.
|
||||
|
||||
The ruleset includes checks from both the core Checkstyle library and from the Sevntu-Checkstyle library.
|
||||
|
||||
* [Requirements](#requirements)
|
||||
* [Usage](#usage)
|
||||
* [All Checks](#all-checks)
|
||||
* [Enabled Checks](#enabled-checks)
|
||||
|
@ -14,16 +13,32 @@ The ruleset includes checks from both the core Checkstyle library and from the S
|
|||
* [Checkstyle](#checkstyle-1)
|
||||
* [Sevntu](#sevntu-1)
|
||||
|
||||
## Requirements
|
||||
|
||||
* [maven-checkstyle-plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/) 2.17+
|
||||
* [Checkstyle](http://checkstyle.sourceforge.net/) 7.0+
|
||||
* [Sevntu-checkstyle](http://sevntu-checkstyle.github.io/sevntu.checkstyle/) 1.21.0+
|
||||
|
||||
## Usage
|
||||
|
||||
To use this ruleset add the plugin `kemitix-checktyle-ruleset-maven-plugin`.
|
||||
The `maven-checkstyle-plugin` will be included automatically.
|
||||
The simplest way to use the ruleset is with the maven-tile:
|
||||
|
||||
```xml
|
||||
<project>
|
||||
<properties>
|
||||
<tiles-maven-plugin.version>2.10</tiles-maven-plugin.version>
|
||||
</properties>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.repaint.maven</groupId>
|
||||
<artifactId>tiles-maven-plugin</artifactId>
|
||||
<version>${tiles-maven-plugin.version}</version>
|
||||
<extensions>true</extensions>
|
||||
<configuration>
|
||||
<tiles>
|
||||
<tile>net.kemitix.checkstyle:tile:4.0.0</tile>
|
||||
</tiles>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
```
|
||||
|
||||
The following levels implement increasingly strict rulesets:
|
||||
|
||||
|
@ -34,40 +49,11 @@ The following levels implement increasingly strict rulesets:
|
|||
* 4-tweaks
|
||||
* 5-complexity
|
||||
|
||||
The default ruleset from the maven-tile is 5-complexity. Other levels can be selected by setting the `kemitix.checkstyle.ruleset.level` to one the values above.
|
||||
|
||||
### Change from 2.x
|
||||
|
||||
In 2.x, the level was specified as the goal to invoke. In 3.x, there is only the 'check' goal.
|
||||
The level is now specified as a configuration parameter. See the example below.
|
||||
|
||||
### Example
|
||||
|
||||
````
|
||||
<properties>
|
||||
<kemitix-checkstyle-ruleset.version>2.1.0</kemitix-checkstyle-ruleset.version>
|
||||
<kemitix-checkstyle-ruleset.level>5-complexity</kemitix-checkstyle-ruleset.level>
|
||||
</properties>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>net.kemitix</groupId>
|
||||
<artifactId>kemitix-checkstyle-ruleset-maven-plugin</artifactId>
|
||||
<version>${kemitix-checkstyle-ruleset.version}</version>
|
||||
<configuration>
|
||||
<level>${kemitix-checkstyle-ruleset.level}</level>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>validate</phase>
|
||||
<goals>
|
||||
<goal>check</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
````
|
||||
In 2.x, the level was specified as the goal to invoke. In 3.x, there is only the 'check' goal. The level is now specified as a configuration parameter. See the example below. The kemitix-checkstyle-maven-plugin has also been removed in favour of the maven-tile.
|
||||
|
||||
## All Checks
|
||||
|
||||
|
|
|
@ -103,6 +103,7 @@ rules:
|
|||
level: LAYOUT
|
||||
enabled: false
|
||||
source: CHECKSTYLE
|
||||
reason: "Ref: Clean Code, Robert C. Martin, J1: Avoid Long Import Lists by Using Wildcards"
|
||||
uri: http://checkstyle.sourceforge.net/config_imports.html#AvoidStarImport
|
||||
-
|
||||
name: AvoidStaticImport
|
||||
|
@ -110,6 +111,9 @@ rules:
|
|||
level: COMPLEXITY
|
||||
enabled: false
|
||||
source: CHECKSTYLE
|
||||
reason: "Ref: Clean Code, Robert C. Martin, J2: Don't Inherit Constants
|
||||
|
||||
Recommends using a static import to access constants from another class over inheriting them."
|
||||
uri: http://checkstyle.sourceforge.net/config_imports.html#AvoidStaticImport
|
||||
properties:
|
||||
excludes: org.assertj.core.api.Assertions.assertThat,org.mockito.BDDMockito.given,org.mockito.Mockito.*,org.mockito.Matchers.*,org.mockito.Mockito.*
|
||||
|
@ -324,7 +328,7 @@ rules:
|
|||
name: Header
|
||||
parent: CHECKER
|
||||
level: LAYOUT
|
||||
enabled: false
|
||||
enabled: true
|
||||
source: CHECKSTYLE
|
||||
uri: http://checkstyle.sourceforge.net/config_header.html#Header
|
||||
properties:
|
||||
|
@ -427,7 +431,7 @@ rules:
|
|||
name: JavadocPackage
|
||||
parent: CHECKER
|
||||
level: JAVADOC
|
||||
enabled: false
|
||||
enabled: true
|
||||
source: CHECKSTYLE
|
||||
uri: http://checkstyle.sourceforge.net/config_javadoc.html#JavadocPackage
|
||||
-
|
||||
|
|
9
pom.xml
9
pom.xml
|
@ -5,14 +5,19 @@
|
|||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>ruleset-root</artifactId>
|
||||
<version>3.4.0</version>
|
||||
<artifactId>root</artifactId>
|
||||
<version>4.0.0</version>
|
||||
<packaging>pom</packaging>
|
||||
|
||||
<properties>
|
||||
<maven.install.skip>true</maven.install.skip>
|
||||
</properties>
|
||||
|
||||
<modules>
|
||||
<module>builder</module>
|
||||
<module>ruleset</module>
|
||||
<module>regressions</module>
|
||||
<module>tile</module>
|
||||
</modules>
|
||||
|
||||
</project>
|
||||
|
|
|
@ -11,15 +11,22 @@
|
|||
</parent>
|
||||
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>ruleset-regressions</artifactId>
|
||||
<version>3.4.0</version>
|
||||
<artifactId>regressions</artifactId>
|
||||
<version>4.0.0</version>
|
||||
|
||||
<properties>
|
||||
<maven.install.skip>true</maven.install.skip>
|
||||
<tiles-maven-plugin.version>2.10</tiles-maven-plugin.version>
|
||||
<kemitix-tiles.version>0.2.0</kemitix-tiles.version>
|
||||
|
||||
<checkstyle.version>8.6</checkstyle.version>
|
||||
<sevntu.version>1.26.0</sevntu.version>
|
||||
<maven-checkstyle-plugin.version>3.0.0</maven-checkstyle-plugin.version>
|
||||
<kemitix.checkstyle.ruleset.version>${project.version}</kemitix.checkstyle.ruleset.version>
|
||||
<!--<kemitix.checkstyle.ruleset.level>5-complexity</kemitix.checkstyle.ruleset.level>-->
|
||||
<!-- use the disabled ruleset for normal builds. comment out the following line to check that conditions are caught -->
|
||||
<ruleset.level>0-disabled</ruleset.level>
|
||||
<kemitix.checkstyle.ruleset.level>0-disabled</kemitix.checkstyle.ruleset.level>
|
||||
<kemitix.checkstyle.ruleset.location>net/kemitix/checkstyle-${kemitix.checkstyle.ruleset.level}.xml</kemitix.checkstyle.ruleset.location>
|
||||
<digraph-dependency.basePackage>net.kemitix.checkstyle.regressions</digraph-dependency.basePackage>
|
||||
<pitest.skip>true</pitest.skip>
|
||||
<immutables-value.version>2.5.6</immutables-value.version>
|
||||
|
@ -43,10 +50,44 @@
|
|||
<extensions>true</extensions>
|
||||
<configuration>
|
||||
<tiles>
|
||||
<tile>net.kemitix.tiles:checkstyle-tile:${kemitix-tiles.version}</tile>
|
||||
<tile>net.kemitix.tiles:maven-plugins-tile:${kemitix-tiles.version}</tile>
|
||||
<tile>net.kemitix.tiles:compiler-tile:${kemitix-tiles.version}</tile>
|
||||
</tiles>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
<version>${maven-checkstyle-plugin.version}</version>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.puppycrawl.tools</groupId>
|
||||
<artifactId>checkstyle</artifactId>
|
||||
<version>${checkstyle.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.sevntu-checkstyle</groupId>
|
||||
<artifactId>sevntu-checkstyle-maven-plugin</artifactId>
|
||||
<version>${sevntu.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>ruleset</artifactId>
|
||||
<version>${kemitix.checkstyle.ruleset.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<configuration>
|
||||
<configLocation>${kemitix.checkstyle.ruleset.location}</configLocation>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>verify</phase>
|
||||
<goals>
|
||||
<goal>check</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
|
|
|
@ -11,8 +11,9 @@
|
|||
<relativePath/>
|
||||
</parent>
|
||||
|
||||
<artifactId>kemitix-checkstyle-ruleset</artifactId>
|
||||
<version>3.4.0</version>
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>ruleset</artifactId>
|
||||
<version>4.0.0</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<name>Kemitix Checkstyle Ruleset</name>
|
||||
|
@ -22,6 +23,7 @@
|
|||
<properties>
|
||||
<tiles-maven-plugin.version>2.10</tiles-maven-plugin.version>
|
||||
<kemitix-tiles.version>0.2.0</kemitix-tiles.version>
|
||||
<maven-resources-plugin.version>3.0.2</maven-resources-plugin.version>
|
||||
</properties>
|
||||
|
||||
<licenses>
|
||||
|
@ -61,6 +63,14 @@
|
|||
</tiles>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
<version>${maven-resources-plugin.version}</version>
|
||||
<configuration>
|
||||
<encoding>UTF-8</encoding>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
|
|
|
@ -22,7 +22,6 @@
|
|||
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck"/>
|
||||
|
|
|
@ -25,7 +25,6 @@
|
|||
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck"/>
|
||||
|
|
|
@ -31,7 +31,6 @@
|
|||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck">
|
||||
<property name="tagOrder" value="@param, @author, @version, @serial, @return, @throws, @exception, @serialData, @serialField, @see, @since, @deprecated"/>
|
||||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck"/>
|
||||
|
@ -51,9 +50,7 @@
|
|||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck">
|
||||
<property name="authorFormat" value="^.+ (\S+@[\S.]+)$"/>
|
||||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck">
|
||||
<property name="max" value="120"/>
|
||||
|
|
|
@ -34,7 +34,6 @@
|
|||
<module name="com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck">
|
||||
<property name="allowEscapesForControlCharacters" value="true"/>
|
||||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck"/>
|
||||
|
@ -78,9 +77,7 @@
|
|||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck">
|
||||
<property name="authorFormat" value="^.+ (\S+@[\S.]+)$"/>
|
||||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck">
|
||||
<property name="max" value="120"/>
|
||||
|
|
|
@ -38,10 +38,6 @@
|
|||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck">
|
||||
<property name="excludes" value="org.assertj.core.api.Assertions.assertThat,org.mockito.BDDMockito.given,org.mockito.Mockito.*,org.mockito.Matchers.*,org.mockito.Mockito.*"/>
|
||||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck">
|
||||
<property name="max" value="2"/>
|
||||
</module>
|
||||
|
@ -99,9 +95,7 @@
|
|||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck">
|
||||
<property name="authorFormat" value="^.+ (\S+@[\S.]+)$"/>
|
||||
</module>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"/>
|
||||
<module name="com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck">
|
||||
<property name="classMaximum" value="1200"/>
|
||||
<property name="fileMaximum" value="1600"/>
|
||||
|
|
41
tile/pom.xml
Normal file
41
tile/pom.xml
Normal file
|
@ -0,0 +1,41 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<parent>
|
||||
<groupId>net.kemitix</groupId>
|
||||
<artifactId>kemitix-parent</artifactId>
|
||||
<version>5.0.3</version>
|
||||
<relativePath/>
|
||||
</parent>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>tile</artifactId>
|
||||
<version>4.0.0</version>
|
||||
|
||||
<packaging>tile</packaging>
|
||||
|
||||
<properties>
|
||||
<tiles-maven-plugin.version>2.10</tiles-maven-plugin.version>
|
||||
<kemitix-tiles.version>0.2.0</kemitix-tiles.version>
|
||||
</properties>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.repaint.maven</groupId>
|
||||
<artifactId>tiles-maven-plugin</artifactId>
|
||||
<version>${tiles-maven-plugin.version}</version>
|
||||
<extensions>true</extensions>
|
||||
<configuration>
|
||||
<tiles>
|
||||
<tile>net.kemitix.tiles:maven-plugins-tile:${kemitix-tiles.version}</tile>
|
||||
<tile>net.kemitix.tiles:release-tile:${kemitix-tiles.version}</tile>
|
||||
</tiles>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
</project>
|
47
tile/tile.xml
Normal file
47
tile/tile.xml
Normal file
|
@ -0,0 +1,47 @@
|
|||
<project>
|
||||
<properties>
|
||||
<maven-checkstyle-plugin.version>3.0.0</maven-checkstyle-plugin.version>
|
||||
<checkstyle.version>8.6</checkstyle.version>
|
||||
<sevntu.version>1.26.0</sevntu.version>
|
||||
<kemitix.checkstyle.ruleset.version>4.0.0</kemitix.checkstyle.ruleset.version>
|
||||
<kemitix.checkstyle.ruleset.level>5-complexity</kemitix.checkstyle.ruleset.level>
|
||||
<kemitix.checkstyle.ruleset.location>net/kemitix/checkstyle-${kemitix.checkstyle.ruleset.level}.xml</kemitix.checkstyle.ruleset.location>
|
||||
</properties>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
<version>${maven-checkstyle-plugin.version}</version>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.puppycrawl.tools</groupId>
|
||||
<artifactId>checkstyle</artifactId>
|
||||
<version>${checkstyle.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.sevntu-checkstyle</groupId>
|
||||
<artifactId>sevntu-checkstyle-maven-plugin</artifactId>
|
||||
<version>${sevntu.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.kemitix.checkstyle</groupId>
|
||||
<artifactId>ruleset</artifactId>
|
||||
<version>${kemitix.checkstyle.ruleset.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<configuration>
|
||||
<configLocation>${kemitix.checkstyle.ruleset.location}</configLocation>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>verify</phase>
|
||||
<goals>
|
||||
<goal>check</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
Loading…
Reference in a new issue