README.md: update checkstyle section for kemitix-checkstyle-ruleset
This commit is contained in:
parent
6cd0d1f2b0
commit
6cfb1d840b
1 changed files with 8 additions and 11 deletions
19
README.md
19
README.md
|
@ -48,24 +48,21 @@ jacoco-class-missed-count-maximum|0
|
||||||
|
|
||||||
The [Maven Checkstyle Plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/)
|
The [Maven Checkstyle Plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/)
|
||||||
uses the latest version of the Checkstyle library
|
uses the latest version of the Checkstyle library
|
||||||
([Release Notes](http://checkstyle.sourceforge.net/releasenotes.html)).
|
([Release Notes](http://checkstyle.sourceforge.net/releasenotes.html)) and the
|
||||||
|
[Sevntu](http://sevntu-checkstyle.github.io/sevntu.checkstyle/) library.
|
||||||
|
|
||||||
Also available for you to use are the rules defined by
|
As from version 2.0.0 you no longer provide a `checkstyle.xml` file. Any file you
|
||||||
[Sevntu](http://sevntu-checkstyle.github.io/sevntu.checkstyle/).
|
provide will be ignored unless you re-configure the maven-checkstyle-plugin yourself.
|
||||||
|
|
||||||
<strong>Your project <em>must</em> provide a `checkstyle.xml` file in it's root
|
The ruleset that will be used is defined in
|
||||||
directory.</strong> See the Checkstyle Plugin homepage for `sun_checks.xml` and
|
[kemitix-checkstyle-ruleset](https://github.com/kemitix/kemitix-checkstyle-ruleset).
|
||||||
`google_checks.xml` examples. There is a modified version of `sun_checks.xml`
|
See the that project's `README.md` file for details on the ruleset.
|
||||||
bundled in the source jar as `checkstyle.xml`.
|
|
||||||
|
|
||||||
Your build will fail on any violations or errors found. You can modify your
|
|
||||||
`checkstyle.xml` to suite your own needs.
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
Ref [checkstyle:check](https://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html)
|
Ref [checkstyle:check](https://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html)
|
||||||
|
|
||||||
* configLocation: checkstyle.xml
|
* configLocation: [checkstyle.xml](https://github.com/kemitix/kemitix-checkstyle-ruleset/blob/master/src/main/resources/net/kemitix/checkstyle.xml)
|
||||||
* consoleOutput: true
|
* consoleOutput: true
|
||||||
* encoding: UTF-8
|
* encoding: UTF-8
|
||||||
* failOnViolation: true
|
* failOnViolation: true
|
||||||
|
|
Loading…
Reference in a new issue