diff --git a/CHANGELOG b/CHANGELOG
index f6a1f07..4352587 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,9 +1,11 @@
CHANGELOG
=========
-3.4.1
+4.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
diff --git a/README.md b/README.md
index f76f6de..6e420fa 100644
--- a/README.md
+++ b/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
+
+
+ 2.10
+
+
+
+
+ io.repaint.maven
+ tiles-maven-plugin
+ ${tiles-maven-plugin.version}
+ true
+
+
+ net.kemitix.checkstyle:tile:4.0.0
+
+
+
+
+
+
+```
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
-
-````
-
- 2.1.0
- 5-complexity
-
-
-
-
-
- net.kemitix
- kemitix-checkstyle-ruleset-maven-plugin
- ${kemitix-checkstyle-ruleset.version}
-
- ${kemitix-checkstyle-ruleset.level}
-
-
-
- validate
-
- check
-
-
-
-
-
-
-````
+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
@@ -2277,7 +2263,7 @@ enum InvalidConstants {
````
#### [FinalizeImplementation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/FinalizeImplementationCheck.html)
-Checks that the `finalize()` implementation doesn't ignore the base class implementation, and doesn't *only* call the base class implementation.
+Checks that the `finalize()` implementation doesn't ignore the base class implementation, and doesn't *only* call the base class implementation.
Valid:
```java
diff --git a/builder/pom.xml b/builder/pom.xml
index 9d8d5fa..498575f 100644
--- a/builder/pom.xml
+++ b/builder/pom.xml
@@ -14,14 +14,14 @@
net.kemitix.checkstyle
builder
jar
- 3.4.1
+ 4.0.0
1.8
2.10
0.2.0
- 8.7
+ 8.6
1.26.0
1.16.18
Brussels-SR6
diff --git a/builder/src/main/resources/README-template.md b/builder/src/main/resources/README-template.md
index efd53b7..98c3585 100644
--- a/builder/src/main/resources/README-template.md
+++ b/builder/src/main/resources/README-template.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
+
+
+ 2.10
+
+
+
+
+ io.repaint.maven
+ tiles-maven-plugin
+ ${tiles-maven-plugin.version}
+ true
+
+
+ net.kemitix.checkstyle:tile:4.0.0
+
+
+
+
+
+
+```
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
-
-````
-
- 2.1.0
- 5-complexity
-
-
-
-
-
- net.kemitix
- kemitix-checkstyle-ruleset-maven-plugin
- ${kemitix-checkstyle-ruleset.version}
-
- ${kemitix-checkstyle-ruleset.level}
-
-
-
- validate
-
- check
-
-
-
-
-
-
-````
+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
diff --git a/builder/src/main/resources/rules/FinalizeImplementation.md b/builder/src/main/resources/rules/FinalizeImplementation.md
index 323e07e..6d5f9c1 100644
--- a/builder/src/main/resources/rules/FinalizeImplementation.md
+++ b/builder/src/main/resources/rules/FinalizeImplementation.md
@@ -1,5 +1,5 @@
-Checks that the `finalize()` implementation doesn't ignore the base class implementation, and doesn't *only* call the base class implementation.
+Checks that the `finalize()` implementation doesn't ignore the base class implementation, and doesn't *only* call the base class implementation.
Valid:
```java
diff --git a/pom.xml b/pom.xml
index 432a7a2..82b2a1c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -6,13 +6,14 @@
net.kemitix.checkstyle
root
- 3.4.1
+ 4.0.0
pom
builder
ruleset
regressions
+ tile
diff --git a/regressions/pom.xml b/regressions/pom.xml
index 5776846..8fc684a 100644
--- a/regressions/pom.xml
+++ b/regressions/pom.xml
@@ -12,7 +12,7 @@
net.kemitix.checkstyle
regressions
- 3.4.1
+ 4.0.0
2.10
diff --git a/ruleset/pom.xml b/ruleset/pom.xml
index 6f5df84..098e75f 100644
--- a/ruleset/pom.xml
+++ b/ruleset/pom.xml
@@ -13,7 +13,7 @@
net.kemitix.checkstyle
ruleset
- 3.4.1
+ 4.0.0
jar
Kemitix Checkstyle Ruleset
diff --git a/tile/pom.xml b/tile/pom.xml
new file mode 100644
index 0000000..f25ee16
--- /dev/null
+++ b/tile/pom.xml
@@ -0,0 +1,34 @@
+
+
+
+ net.kemitix
+ kemitix-parent
+ 5.0.3
+
+
+ 4.0.0
+
+ net.kemitix.checkstyle
+ tile
+ 4.0.0
+
+ tile
+
+
+ 2.10
+
+
+
+
+
+ io.repaint.maven
+ tiles-maven-plugin
+ ${tiles-maven-plugin.version}
+ true
+
+
+
+
+
diff --git a/tile/tile.xml b/tile/tile.xml
new file mode 100644
index 0000000..5bbca56
--- /dev/null
+++ b/tile/tile.xml
@@ -0,0 +1,47 @@
+
+
+ 2.17
+ 8.6
+ 1.26.0
+ 3.4.0
+ 5-complexity
+ net/kemitix/checkstyle-${kemitix.checkstyle.ruleset.level}.xml
+
+
+
+
+ org.apache.maven.plugins
+ maven-checkstyle-plugin
+ ${maven-checkstyle-plugin.version}
+
+
+ com.puppycrawl.tools
+ checkstyle
+ ${checkstyle.version}
+
+
+ com.github.sevntu-checkstyle
+ sevntu-checkstyle-maven-plugin
+ ${sevntu.version}
+
+
+ net.kemitix
+ kemitix-checkstyle-ruleset
+ ${kemitix.checkstyle.ruleset.version}
+
+
+
+ ${kemitix.checkstyle.ruleset.location}
+
+
+
+ verify
+
+ check
+
+
+
+
+
+
+