builder:README-template.md: added
This commit is contained in:
parent
fb02dc5f88
commit
6e9ac736e9
1 changed files with 124 additions and 0 deletions
124
builder/src/main/resources/README-template.md
Normal file
124
builder/src/main/resources/README-template.md
Normal file
|
|
@ -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.
|
||||||
|
|
||||||
|
````
|
||||||
|
<properties>
|
||||||
|
<checkstyle.version>7.3</checkstyle.version>
|
||||||
|
<sevntu-checkstyle-maven-plugin.version>1.22.0</sevntu-checkstyle-maven-plugin.version>
|
||||||
|
<kemitix-checkstyle-ruleset.version>0.2.0</kemitix-checkstyle-ruleset.version>
|
||||||
|
</properties>
|
||||||
|
<pluginManagement>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.puppycrawl.tools</groupId>
|
||||||
|
<artifactId>checkstyle</artifactId>
|
||||||
|
<version>${checkstyle.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.github.sevntu.checkstyle</groupId>
|
||||||
|
<artifactId>sevntu-checkstyle-maven-plugin</artifactId>
|
||||||
|
<version>${sevntu-checkstyle-maven-plugin.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>net.kemitix</groupId>
|
||||||
|
<artifactId>kemitix-checkstyle-ruleset</artifactId>
|
||||||
|
<version>${kemitix-checkstyle-ruleset.version}</version>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
<configuration>
|
||||||
|
<configLocation>net/kemitix/checkstyle-5-complexity.xml</configLocation>
|
||||||
|
</configuration>
|
||||||
|
</plugin><!-- maven-checkstyle-plugin -->
|
||||||
|
</plugins>
|
||||||
|
</pluginManagement>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>validate</id>
|
||||||
|
<phase>validate</phase>
|
||||||
|
<goals>
|
||||||
|
<goal>check</goal>
|
||||||
|
<goal>checkstyle</goal>
|
||||||
|
</goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin><!-- maven-checkstyle-plugin -->
|
||||||
|
</plugins>
|
||||||
|
````
|
||||||
|
|
||||||
|
## 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
|
||||||
Loading…
Reference in a new issue