diff --git a/README.disabled.header.md b/README.disabled.header.md new file mode 100644 index 0000000..0703dd1 --- /dev/null +++ b/README.disabled.header.md @@ -0,0 +1 @@ +These checks are not enabled. Notes are included for each explaining why. diff --git a/README.disabled.sevntu.header.md b/README.disabled.sevntu.header.md new file mode 100644 index 0000000..6e58dce --- /dev/null +++ b/README.disabled.sevntu.header.md @@ -0,0 +1 @@ +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. diff --git a/README.enabled.header.md b/README.enabled.header.md new file mode 100644 index 0000000..fa3e2c0 --- /dev/null +++ b/README.enabled.header.md @@ -0,0 +1 @@ +The following is a list of each of the checks and the expectations each has on your code. diff --git a/README.footer.md b/README.footer.md new file mode 100644 index 0000000..05057a1 --- /dev/null +++ b/README.footer.md @@ -0,0 +1 @@ +[Effective Java]: http://amzn.to/2aSz6GE diff --git a/README.header.md b/README.header.md new file mode 100644 index 0000000..c39e0f4 --- /dev/null +++ b/README.header.md @@ -0,0 +1,81 @@ +# 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. + +```` + + 7.0 + 1.21.0 + 0.1.1 + + + + + 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.xml + + + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + validate + validate + + check + checkstyle + + + + + +```` + +## All Checks