kemitix/kemitix-checkstyle-ruleset
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

builder:README.header.md: update with levels

Browse source
This commit is contained in:
Paul Campbell 2017-01-05 09:47:31 +00:00
parent f110e90cfd
commit 2e1404ffa4
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
builder/src/main/resources/readme/README.header.md
View file

@ -26,6 +26,17 @@ 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.
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>
<checkstyle.version>7.0</checkstyle.version>
@ -55,7 +66,7 @@ You need to include `checkstyle` as the version bundled with the `maven-checksty
</dependency>
</dependencies>
<configuration>
<configLocation>net/kemitix/checkstyle.xml</configLocation>
<configLocation>net/kemitix/checkstyle-5-complexity.xml</configLocation>
</configuration>
</plugin><!-- maven-checkstyle-plugin -->
</plugins>