litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Create initial format style enforcement (#121)

Browse source 
- All rules are initially suppressed

Resolves: https://jira.duraspace.org/browse/VIVO-1692
This commit is contained in:
Andrew Woods 2019-07-25 06:43:38 -04:00 • committed by Brian Lowe
parent cc2b98dac0
commit 1a2debe5c3
3 changed files with 137 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
checkstyle/pom.xml Normal file
View file

@ -0,0 +1,7 @@
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.vivoweb</groupId>
<artifactId>checkstyle</artifactId>
<version>1.11.0-SNAPSHOT</version>
<name>Vitro Checkstyle</name>
</project>

81
checkstyle/src/main/resources/vitro-checkstyle/checkstyle-suppressions.xml Normal file
View file

@ -0,0 +1,81 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<!-- Suppressions for Javadoc in Test classes -->
<suppress checks="JavadocMethod" files="src[/\\]test[/\\]java"/>
<suppress checks="JavadocType" files="src[/\\]test[/\\]java"/>
<!-- Suppressions for generated source files -->
<suppress checks=".*" files="[/\\]target[/\\]" />
<!-- Disables Javadoc requirement for all public methods. This suppression
is not recommended, but may be needed (temporarily) to allow checkstyle
to be applied to existing codebases. -->
<suppress checks="JavadocMethod" files="src[/\\]main[/\\]java"/>
<!-- No tab characters ('\t') allowed in the source code -->
<suppress checks="FileTabCharacter" files="src"/>
<!-- No Trailing Whitespace, except on lines that only have an asterisk (e.g. Javadoc comments) -->
<suppress checks="RegexpSingleline" files=".*\.java"/>
<!-- Maximum line length is 120 characters -->
<suppress checks="LineLength" files=".*\.java"/>
<!-- Highlight any TODO or FIXME comments in info messages -->
<suppress checks="TodoComment" files=".*\.java"/>
<!-- ##### Import statement requirements ##### -->
<!-- Star imports (e.g. import java.util.*) are NOT ALLOWED -->
<suppress checks="AvoidStarImport" files=".*\.java"/>
<!-- Redundant import statements are NOT ALLOWED -->
<suppress checks="RedundantImport" files=".*\.java"/>
<!-- Unused import statements are NOT ALLOWED -->
<suppress checks="UnusedImports" files=".*\.java"/>
<!-- Ensure imports appear alphabetically and grouped -->
<suppress checks="CustomImportOrder" files=".*\.java"/>
<!-- ##### Requirements for K&R Style braces ##### -->
<!-- Code blocks MUST HAVE braces, even single line statements (if, while, etc) -->
<suppress checks="NeedBraces" files=".*\.java"/>
<!-- Left braces should be at the end of current line (default value)-->
<suppress checks="LeftCurly" files=".*\.java"/>
<!-- Right braces should be on start of a new line (default value) -->
<suppress checks="RightCurly" files=".*\.java"/>
<!-- ##### Indentation / Whitespace requirements ##### -->
<!-- Require 4-space indentation (default value) -->
<suppress checks="Indentation" files=".*\.java"/>
<!-- Whitespace should exist around all major tokens -->
<suppress checks="WhitespaceAround" files=".*\.java"/>
<!-- Validate whitespace around Generics (angle brackets) per typical conventions
http://checkstyle.sourceforge.net/config_whitespace.html#GenericWhitespace -->
<suppress checks="GenericWhitespace" files=".*\.java"/>
<!-- ##### Blank line requirements ##### -->
<suppress checks="EmptyLineSeparator" files=".*\.java"/>
<!-- ##### Requirements for "switch" statements ##### -->
<!-- "switch" statements MUST have a "default" clause -->
<suppress checks="MissingSwitchDefault" files=".*\.java"/>
<!-- "case" clauses in switch statements MUST include break, return, throw or continue -->
<suppress checks="FallThrough" files=".*\.java"/>
<!-- ##### Other / Miscellaneous requirements ##### -->
<!-- Require utility classes do not have a public constructor -->
<suppress checks="HideUtilityClassConstructor" files=".*\.java"/>
<!-- Require each variable declaration is its own statement on its own line -->
<suppress checks="MultipleVariableDeclarations" files=".*\.java"/>
<!-- Each line of code can only include one statement -->
<suppress checks="OneStatementPerLine" files=".*\.java"/>
<!-- Require that "catch" statements are not empty (must at least contain a comment) -->
<suppress checks="EmptyCatchBlock" files=".*\.java"/>
<!-- Require that 'final' used on variables and parameters -->
<suppress checks="FinalLocalVariable" files=".*.java"/>
<suppress checks="FinalParameters" files=".*.java"/>
</suppressions>