Skip to content

Commit f5d9a0b

Browse files
shekhargulatishekhargulati
committed
#88 Added Checkstyle to project
1 parent 5eca581 commit f5d9a0b

7 files changed

Lines changed: 147 additions & 5 deletions

File tree

‎build.gradle‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ apply plugin: 'maven'
99
apply plugin: 'maven-publish'
1010
apply plugin: 'signing'
1111
apply plugin: "jacoco"
12+
apply from: rootProject.file('gradle/checkstyle.gradle')
1213

1314
sourceCompatibility = 1.8
1415

@@ -92,4 +93,4 @@ jacocoTestReport {
9293
}
9394
}
9495

95-
check.dependsOn jacocoTestReport
96+
check.dependsOn jacocoTestReport

‎etc/checkstyle-exclude.xml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0"?>
2+
3+
<!DOCTYPE suppressions PUBLIC
4+
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
5+
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
6+
7+
<suppressions>
8+
</suppressions>

‎etc/checkstyle.xml‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
3+
<module name="com.puppycrawl.tools.checkstyle.Checker">
4+
<!-- Root Checks -->
5+
<module name="com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck">
6+
<property name="lineSeparator" value="lf"/>
7+
</module>
8+
9+
<module name="SuppressionFilter">
10+
<property name="file" value="etc/checkstyle-exclude.xml" />
11+
</module>
12+
13+
<!-- TreeWalker Checks -->
14+
<module name="com.puppycrawl.tools.checkstyle.TreeWalker">
15+
<!-- Annotations -->
16+
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck">
17+
<property name="elementStyle" value="compact" />
18+
</module>
19+
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck" />
20+
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck" />
21+
<module name="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck">
22+
<property name="allowSamelineSingleParameterlessAnnotation"
23+
value="false" />
24+
</module>
25+
26+
<!-- Block Checks -->
27+
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck">
28+
<property name="option" value="text" />
29+
</module>
30+
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck" />
31+
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck">
32+
<property name="tokens" value="LITERAL_CATCH"/>
33+
<property name="option" value="alone" />
34+
</module>
35+
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck" />
36+
<module name="com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck" />
37+
38+
<!-- Class Design -->
39+
<module name="com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck" />
40+
<module name="com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck" />
41+
<module name="com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck" />
42+
<module name="com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck" />
43+
<module name="com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck" />
44+
<module name="com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck" />
45+
46+
<!-- Coding -->
47+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck" />
48+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck" />
49+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck" />
50+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck" />
51+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck" />
52+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck" />
53+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck" />
54+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck">
55+
<property name="max" value="3" />
56+
</module>
57+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck">
58+
<property name="max" value="3" />
59+
</module>
60+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck">
61+
<property name="max" value="3" />
62+
</module>
63+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck" />
64+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck">
65+
<property name="checkMethods" value="false" />
66+
<property name="validateOnlyOverlapping" value="false" />
67+
</module>
68+
<module name="com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck" />
69+
70+
<!-- Imports -->
71+
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck">
72+
<property name="excludes" value="javax.persistence, java.util.stream.Collectors, java.util.*,org.hamcrest.CoreMatchers, org.junit.Assert, strman.Strman"/>
73+
</module>
74+
<module name="com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck" />
75+
<module name="com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck" />
76+
<module name="com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck">
77+
<property name="processJavadoc" value="true" />
78+
</module>
79+
<module name="com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck">
80+
<property name="groups" value="java,/^javax?\./,*" />
81+
<property name="ordered" value="true" />
82+
<property name="separated" value="true" />
83+
<property name="option" value="bottom" />
84+
<property name="sortStaticImportsAlphabetically" value="true" />
85+
</module>
86+
87+
<!-- Miscellaneous -->
88+
<module name="com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck">
89+
<property name="tokens" value="BLOCK_COMMENT_BEGIN"/>
90+
</module>
91+
<module name="com.puppycrawl.tools.checkstyle.checks.UpperEllCheck" />
92+
<module name="com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck" />
93+
<module name="com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck" />
94+
95+
<!-- Modifiers -->
96+
<module name="com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck" />
97+
98+
<!-- Regexp -->
99+
<module name="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck">
100+
<property name="maximum" value="0"/>
101+
<property name="format" value="org\.junit\.Assert\.assert" />
102+
<property name="message"
103+
value="Please use AssertJ imports." />
104+
<property name="ignoreComments" value="true" />
105+
</module>
106+
<module name="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck">
107+
<property name="format" value="[ \t]+$" />
108+
<property name="illegalPattern" value="true" />
109+
<property name="message" value="Trailing whitespace" />
110+
</module>
111+
112+
<!-- Whitespace -->
113+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck" />
114+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck" />
115+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck" >
116+
<property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS, ARRAY_DECLARATOR"/>
117+
</module>
118+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck" />
119+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck" />
120+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck" />
121+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck" />
122+
<module name="com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck" />
123+
</module>
124+
</module>

‎gradle/checkstyle.gradle‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
apply plugin: 'checkstyle'
2+
3+
checkstyle {
4+
configFile rootProject.file('etc/checkstyle.xml')
5+
showViolations true
6+
}
7+
8+
dependencies {
9+
checkstyle 'com.puppycrawl.tools:checkstyle:7.7'
10+
}

‎gradle/wrapper/gradle-wrapper.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
33
distributionPath=wrapper/dists
44
zipStoreBase=GRADLE_USER_HOME
55
zipStorePath=wrapper/dists
6-
distributionUrl=https\://services.gradle.org/distributions/gradle-2.5-all.zip
6+
distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-all.zip

‎src/main/java/strman/Strman.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1152,7 +1152,6 @@ public static String capitalize(final String input) throws IllegalArgumentExcept
11521152
*
11531153
* @param input The string to convert
11541154
* @return The converted string
1155-
* @throws IllegalArgumentException
11561155
*/
11571156
public static String lowerFirst(final String input) throws IllegalArgumentException {
11581157
if (input == null) {

‎src/test/java/strman/StrmanTests.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@
2626

2727
package strman;
2828

29+
import java.util.*;
30+
2931
import org.junit.Ignore;
3032
import org.junit.Test;
3133

32-
import java.util.*;
33-
3434
import static java.util.Arrays.asList;
3535
import static java.util.Collections.singletonList;
3636
import static java.util.stream.Collectors.toList;

0 commit comments

Comments
 (0)