README: update usage instructions
Moved configuration to correct location in example.
This commit is contained in:
parent
cfa28e5f38
commit
635bb5e5ff
1 changed files with 17 additions and 6 deletions
23
README.md
23
README.md
|
@ -26,11 +26,22 @@ To use this ruleset in your `maven-checkstyle-plugin` configuration add `checkst
|
||||||
|
|
||||||
You need to include `checkstyle` as the version bundled with the `maven-checkstyle-plugin` is not up-to-date enough.
|
You need to include `checkstyle` as the version bundled with the `maven-checkstyle-plugin` is not up-to-date enough.
|
||||||
|
|
||||||
|
Select the `configLocation` for the level of strictness required:
|
||||||
|
|
||||||
|
* checkstyle-1-layout.xml
|
||||||
|
* checkstyle-2-naming.xml
|
||||||
|
* checkstyle-3-javadoc.xml
|
||||||
|
* checkstyle-4-tweaks.xml
|
||||||
|
* checkstyle-5-complexity.xml
|
||||||
|
|
||||||
|
Only specify a single `configLocation` as each increasing level includes all the rules
|
||||||
|
from the previous.
|
||||||
|
|
||||||
````
|
````
|
||||||
<properties>
|
<properties>
|
||||||
<checkstyle.version>7.0</checkstyle.version>
|
<checkstyle.version>7.3</checkstyle.version>
|
||||||
<sevntu-checkstyle-maven-plugin.version>1.21.0</sevntu-checkstyle-maven-plugin.version>
|
<sevntu-checkstyle-maven-plugin.version>1.22.0</sevntu-checkstyle-maven-plugin.version>
|
||||||
<kemitix-checkstyle-ruleset.version>0.1.1</kemitix-checkstyle-ruleset.version>
|
<kemitix-checkstyle-ruleset.version>0.2.0</kemitix-checkstyle-ruleset.version>
|
||||||
</properties>
|
</properties>
|
||||||
<pluginManagement>
|
<pluginManagement>
|
||||||
<plugins>
|
<plugins>
|
||||||
|
@ -53,10 +64,10 @@ You need to include `checkstyle` as the version bundled with the `maven-checksty
|
||||||
<artifactId>kemitix-checkstyle-ruleset</artifactId>
|
<artifactId>kemitix-checkstyle-ruleset</artifactId>
|
||||||
<version>${kemitix-checkstyle-ruleset.version}</version>
|
<version>${kemitix-checkstyle-ruleset.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<configuration>
|
|
||||||
<configLocation>net/kemitix/checkstyle.xml</configLocation>
|
|
||||||
</configuration>
|
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
<configuration>
|
||||||
|
<configLocation>net/kemitix/checkstyle-5-complexity.xml</configLocation>
|
||||||
|
</configuration>
|
||||||
</plugin><!-- maven-checkstyle-plugin -->
|
</plugin><!-- maven-checkstyle-plugin -->
|
||||||
</plugins>
|
</plugins>
|
||||||
</pluginManagement>
|
</pluginManagement>
|
||||||
|
|
Loading…
Reference in a new issue