From 6e9ac736e99971b72affbc028c5af1e3fe24d1f8 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Thu, 5 Jan 2017 16:32:30 +0000 Subject: [PATCH] builder:README-template.md: added --- builder/src/main/resources/README-template.md | 124 ++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 builder/src/main/resources/README-template.md diff --git a/builder/src/main/resources/README-template.md b/builder/src/main/resources/README-template.md new file mode 100644 index 0000000..f4e2fc9 --- /dev/null +++ b/builder/src/main/resources/README-template.md @@ -0,0 +1,124 @@ +# kemitix-checkstyle-ruleset + +Provides an extensive Checkstyle ruleset for use with Apache's `maven-checkstyle-plugin`. + +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) + * [Checkstyle](#checkstyle) + * [Sevntu](#sevntu) +* [Disabled Checks](#disabled-checks) + * [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 in your `maven-checkstyle-plugin` configuration add `checkstyle`, `sevntu-checkstyle-maven-plugin` and `kemitix-checktyle-ruleset` as dependencies of the `maven-checkstyle-plugin`. + +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. + +```` + + 7.3 + 1.22.0 + 0.2.0 + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + com.puppycrawl.tools + checkstyle + ${checkstyle.version} + + + com.github.sevntu.checkstyle + sevntu-checkstyle-maven-plugin + ${sevntu-checkstyle-maven-plugin.version} + + + net.kemitix + kemitix-checkstyle-ruleset + ${kemitix-checkstyle-ruleset.version} + + + + net/kemitix/checkstyle-5-complexity.xml + + + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + validate + validate + + check + checkstyle + + + + + +```` + +## All Checks + +%s + +## Enabled Checks + +The following is a list of each of the checks and the expectations each has on your code. + +### Checkstyle + +Rules are listed in alphabetical order. + +%s + +### Sevntu + +%s + +## Disabled Checks + +These checks are not enabled. Notes are included for each explaining why. + +### Checkstyle + +%s + +### Sevntu + +As the sevntu check are considered experimental not all those that are not enabled are listed here. Only where they are disabled due to a conflict with my 'style' or there is another irreconcilable difference that prevents them from being enabled, will they be documented to prevent repeated investigations. + +%s + +[Effective Java]: http://amzn.to/2aSz6GE