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

Merge branch 'release/2.2.0'

Browse source
This commit is contained in:
Paul Campbell 2017-03-11 17:43:31 +00:00
commit 4526dd4b8e
14 changed files with 82 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGELOG
View file

@ -1,6 +1,13 @@
CHANGELOG
=========
2.2.0
-----
* Upgrade sevntu to 1.23.1
* Upgrade checkstyle to 7.6
* Detect sync conflicts
2.1.3
-----

17
README.md
View file

@ -219,6 +219,7 @@ Rule|Level|Source|Enabled|Suppressable
[Regexp](#regexp)|unspecified|checkstyle||
[RegexpHeader](#regexpheader)|unspecified|checkstyle||
[RegexpMultiline](#regexpmultiline)|unspecified|checkstyle||
[RegexpOnFilename](#regexponfilename)|layout|checkstyle|Yes|
[RegexpOnFilename](#regexponfilename)|unspecified|checkstyle||
[RegexpSingleline](#regexpsingleline)|unspecified|checkstyle||
[RegexpSinglelineJava](#regexpsinglelinejava)|unspecified|checkstyle||
@ -274,6 +275,22 @@ The following is a list of each of the checks and the expectations each has on y
Rules are listed in alphabetical order.
#### [RegexpOnFilename](http://checkstyle.sourceforge.net/config_regexp.html#RegexpOnFilename)
Checks for the existence of forbidden java file names.
File names are forbidden if they match the pattern `(.sync-conflict-| conflicted copy )`.
N.B. only `*.java` files are checked.
This check is intended to detect Syncthing and Dropbox conflict files.
e.g.
````
DataClass (Bob's conflicted copy 2017-03-11).java
DataClass.sync-conflict-20170311-1648.java
````
#### [AbbreviationAsWordInName](http://checkstyle.sourceforge.net/config_naming.html#AbbreviationAsWordInName)
Enforces proper `CamelCase` and avoids sequences of consecutive uppercase characters in identifiers. Does not apply to @Overridden methods.

2
builder/pom.xml
View file

@ -12,7 +12,7 @@
</parent>
<artifactId>kemitix-checkstyle-ruleset-builder</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
<packaging>jar</packaging>
<name>Kemitix Checkstyle Ruleset Builder</name>

10
builder/src/main/resources/application.yml
View file

@ -12,6 +12,16 @@ template:
readme-template: builder/src/main/resources/README-template.md
readme-fragments: builder/src/main/resources/rules
rules:
-
name: RegexpOnFilename
parent: CHECKER
level: LAYOUT
enabled: true
source: CHECKSTYLE
uri: http://checkstyle.sourceforge.net/config_regexp.html#RegexpOnFilename
properties:
fileNamePattern: "(.sync-conflict-| conflicted copy )"
match: true
-
name: AbbreviationAsWordInName
parent: TREEWALKER

15
builder/src/main/resources/rules/RegexpOnFilename.md Normal file
View file

@ -0,0 +1,15 @@
Checks for the existence of forbidden java file names.
File names are forbidden if they match the pattern `(.sync-conflict-| conflicted copy )`.
N.B. only `*.java` files are checked.
This check is intended to detect Syncthing and Dropbox conflict files.
e.g.
````
DataClass (Bob's conflicted copy 2017-03-11).java
DataClass.sync-conflict-20170311-1648.java
````

2
plugin-sample/pom.xml
View file

@ -8,7 +8,7 @@
<!-- don't use parent to avoid using grandparent's checkstyle configuration -->
<groupId>net.kemitix</groupId>
<artifactId>kemitix-checkstyle-ruleset-plugin-sample</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
<name>Kemitix Checkstyle Ruleset Plugin Sample</name>
<description>Sample usage of the Kemitix Checkstyle Ruleset Plugin</description>

2
plugin/pom.xml
View file

@ -7,7 +7,7 @@
<parent>
<groupId>net.kemitix</groupId>
<artifactId>kemitix-checkstyle-ruleset-parent</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
</parent>
<artifactId>kemitix-checkstyle-ruleset-maven-plugin</artifactId>

6
pom.xml
View file

@ -6,7 +6,7 @@
<groupId>net.kemitix</groupId>
<artifactId>kemitix-checkstyle-ruleset-parent</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
<packaging>pom</packaging>
<name>Kemitix Checkstyle Ruleset (Parent)</name>
@ -21,8 +21,8 @@
<maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
<maven-checkstyle-plugin.version>2.17</maven-checkstyle-plugin.version>
<checkstyle.version>7.5.1</checkstyle.version>
<sevntu.version>1.23.0</sevntu.version>
<checkstyle.version>7.6</checkstyle.version>
<sevntu.version>1.23.1</sevntu.version>
</properties>
<modules>

4
ruleset/pom.xml
View file

@ -7,11 +7,11 @@
<parent>
<groupId>net.kemitix</groupId>
<artifactId>kemitix-checkstyle-ruleset-parent</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
</parent>
<artifactId>kemitix-checkstyle-ruleset</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
<packaging>jar</packaging>
<name>Kemitix Checkstyle Ruleset</name>

6
ruleset/src/main/resources/net/kemitix/checkstyle-1-layout.xml
View file

@ -4,7 +4,11 @@
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="FileTabCharacter"/>
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="(.sync-conflict-| conflicted copy )"/>
<property name="match" value="true"/>
</module>
<module name="FileTabCharacter"/>
<module name="Header">
<property name="fileExtensions" value="java"/>
<property name="headerFile" value="LICENSE.txt"/>

6
ruleset/src/main/resources/net/kemitix/checkstyle-2-naming.xml
View file

@ -4,7 +4,11 @@
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="FileTabCharacter"/>
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="(.sync-conflict-| conflicted copy )"/>
<property name="match" value="true"/>
</module>
<module name="FileTabCharacter"/>
<module name="Header">
<property name="fileExtensions" value="java"/>
<property name="headerFile" value="LICENSE.txt"/>

6
ruleset/src/main/resources/net/kemitix/checkstyle-3-javadoc.xml
View file

@ -4,7 +4,11 @@
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="FileTabCharacter"/>
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="(.sync-conflict-| conflicted copy )"/>
<property name="match" value="true"/>
</module>
<module name="FileTabCharacter"/>
<module name="Header">
<property name="fileExtensions" value="java"/>
<property name="headerFile" value="LICENSE.txt"/>

6
ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml
View file

@ -4,7 +4,11 @@
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="FileTabCharacter"/>
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="(.sync-conflict-| conflicted copy )"/>
<property name="match" value="true"/>
</module>
<module name="FileTabCharacter"/>
<module name="Header">
<property name="fileExtensions" value="java"/>
<property name="headerFile" value="LICENSE.txt"/>

6
ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml
View file

@ -4,7 +4,11 @@
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="FileLength"/>
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="(.sync-conflict-| conflicted copy )"/>
<property name="match" value="true"/>
</module>
<module name="FileLength"/>
<module name="FileTabCharacter"/>
<module name="Header">
<property name="fileExtensions" value="java"/>