Skip to content

Commit bb1bcd7

Browse files
carlsonsantanacarlsonsantana
committed
🎉 Initial commit
1 parent 92be1a6 commit bb1bcd7

File tree

7 files changed

+971
-0
lines changed

7 files changed

+971
-0
lines changed

‎checkstyle.xml‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4+
"http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
5+
6+
<!--
7+
8+
Checkstyle configuration that checks the sun coding conventions from:
9+
10+
- the Java Language Specification at
11+
http://java.sun.com/docs/books/jls/second_edition/html/index.html
12+
13+
- the Sun Code Conventions at http://java.sun.com/docs/codeconv/
14+
15+
- the Javadoc guidelines at
16+
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
17+
18+
- the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
19+
20+
- some best practices
21+
22+
Checkstyle is very configurable. Be sure to read the documentation at
23+
http://checkstyle.sf.net (or in your downloaded distribution).
24+
25+
Most Checks are configurable, be sure to consult the documentation.
26+
27+
To completely disable a check, just comment it out or delete it from the file.
28+
29+
Finally, it is worth reading the documentation.
30+
31+
-->
32+
33+
<module name="Checker">
34+
<!--
35+
If you set the basedir property below, then all reported file
36+
names will be relative to the specified directory. See
37+
http://checkstyle.sourceforge.net/5.x/config.html#Checker
38+
39+
<property name="basedir" value="${basedir}"/>
40+
-->
41+
42+
<property name="fileExtensions" value="java, properties, xml"/>
43+
44+
<!-- Checks that a package-info.java file exists for each package. -->
45+
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
46+
<module name="JavadocPackage"/>
47+
48+
<!-- Checks whether files end with a new line. -->
49+
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
50+
<module name="NewlineAtEndOfFile"/>
51+
52+
<!-- Checks that property files contain the same keys. -->
53+
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
54+
<module name="Translation"/>
55+
56+
<!-- Checks for Size Violations. -->
57+
<!-- See http://checkstyle.sf.net/config_sizes.html -->
58+
<module name="FileLength"/>
59+
60+
<!-- Checks for whitespace -->
61+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
62+
<module name="FileTabCharacter"/>
63+
64+
<!-- Miscellaneous other checks. -->
65+
<!-- See http://checkstyle.sf.net/config_misc.html -->
66+
<module name="RegexpSingleline">
67+
<property name="format" value="\s+$"/>
68+
<property name="minimum" value="0"/>
69+
<property name="maximum" value="0"/>
70+
<property name="message" value="Line has trailing spaces."/>
71+
</module>
72+
73+
<!-- Checks for Headers -->
74+
<!-- See http://checkstyle.sf.net/config_header.html -->
75+
<!-- <module name="Header"> -->
76+
<!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
77+
<!-- <property name="fileExtensions" value="java"/> -->
78+
<!-- </module> -->
79+
80+
<module name="TreeWalker">
81+
82+
<!-- Checks for Javadoc comments. -->
83+
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
84+
<module name="JavadocMethod"/>
85+
<module name="JavadocType"/>
86+
<module name="JavadocVariable"/>
87+
<module name="JavadocStyle"/>
88+
89+
<!-- Checks for Naming Conventions. -->
90+
<!-- See http://checkstyle.sf.net/config_naming.html -->
91+
<module name="ConstantName"/>
92+
<module name="LocalFinalVariableName"/>
93+
<module name="LocalVariableName"/>
94+
<module name="MemberName"/>
95+
<module name="MethodName"/>
96+
<module name="PackageName"/>
97+
<module name="ParameterName"/>
98+
<module name="StaticVariableName"/>
99+
<module name="TypeName"/>
100+
101+
<!-- Checks for imports -->
102+
<!-- See http://checkstyle.sf.net/config_import.html -->
103+
<module name="AvoidStarImport"/>
104+
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
105+
<module name="RedundantImport"/>
106+
<module name="UnusedImports">
107+
<property name="processJavadoc" value="false"/>
108+
</module>
109+
110+
<!-- Checks for Size Violations. -->
111+
<!-- See http://checkstyle.sf.net/config_sizes.html -->
112+
<module name="LineLength"/>
113+
114+
<!-- Checks for whitespace -->
115+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
116+
<module name="EmptyForIteratorPad"/>
117+
<module name="GenericWhitespace"/>
118+
<module name="MethodParamPad"/>
119+
<module name="NoWhitespaceAfter"/>
120+
<module name="NoWhitespaceBefore"/>
121+
<module name="OperatorWrap"/>
122+
<module name="ParenPad"/>
123+
<module name="TypecastParenPad"/>
124+
<module name="WhitespaceAfter"/>
125+
<module name="WhitespaceAround"/>
126+
127+
<!-- Modifier Checks -->
128+
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
129+
<module name="ModifierOrder"/>
130+
<module name="RedundantModifier"/>
131+
132+
<!-- Checks for blocks. You know, those {}'s -->
133+
<!-- See http://checkstyle.sf.net/config_blocks.html -->
134+
<module name="AvoidNestedBlocks"/>
135+
<module name="EmptyBlock"/>
136+
<module name="LeftCurly"/>
137+
<module name="NeedBraces"/>
138+
<module name="RightCurly"/>
139+
140+
<!-- Checks for common coding problems -->
141+
<!-- See http://checkstyle.sf.net/config_coding.html -->
142+
<module name="AvoidInlineConditionals"/>
143+
<module name="EmptyStatement"/>
144+
<module name="EqualsHashCode"/>
145+
<module name="HiddenField"/>
146+
<module name="IllegalInstantiation"/>
147+
<module name="InnerAssignment"/>
148+
<module name="MagicNumber"/>
149+
<module name="MissingSwitchDefault"/>
150+
<module name="SimplifyBooleanExpression"/>
151+
<module name="SimplifyBooleanReturn"/>
152+
153+
<!-- Checks for class design -->
154+
<!-- See http://checkstyle.sf.net/config_design.html -->
155+
<!--<module name="DesignForExtension"/>-->
156+
<module name="FinalClass"/>
157+
<module name="HideUtilityClassConstructor"/>
158+
<module name="InterfaceIsType"/>
159+
<module name="VisibilityModifier">
160+
<property name="protectedAllowed" value="true"/>
161+
</module>
162+
163+
<!-- Miscellaneous other checks. -->
164+
<!-- See http://checkstyle.sf.net/config_misc.html -->
165+
<module name="ArrayTypeStyle"/>
166+
<module name="FinalParameters"/>
167+
<module name="TodoComment"/>
168+
<module name="UpperEll"/>
169+
170+
</module>
171+
172+
</module>

‎pom.xml‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
5+
<groupId>org.hatemile</groupId>
6+
<artifactId>hatemile-jee</artifactId>
7+
<version>1.0</version>
8+
<packaging>jar</packaging>
9+
10+
<name>HaTeMiLe for JEE</name>
11+
<description>
12+
HaTeMiLe for JEE is a library that help developers to convert a HTML
13+
code in a code more accessible for Java EE web applications.
14+
</description>
15+
<url>https://github.com/carlsonsantana/hatemile-jee</url>
16+
17+
<licenses>
18+
<license>
19+
<name>Apache License, Version 2.0</name>
20+
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
21+
<distribution>repo</distribution>
22+
</license>
23+
</licenses>
24+
25+
<scm>
26+
<url>https://github.com/carlsonsantana/hatemile-jee</url>
27+
<connection>scm:git:git://github.com/carlsonsantana/hatemile-jee.git</connection>
28+
<developerConnection>scm:git:git@github.com:carlsonsantana/hatemile-jee.git</developerConnection>
29+
</scm>
30+
31+
<issueManagement>
32+
<system>GitHub Issues</system>
33+
<url>https://github.com/carlsonsantana/hatemile-jee/issues</url>
34+
</issueManagement>
35+
36+
<developers>
37+
<developer>
38+
<name>Carlson Santana Cruz</name>
39+
<url>https://github.com/carlsonsantana/</url>
40+
</developer>
41+
</developers>
42+
43+
<properties>
44+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
45+
</properties>
46+
47+
<repositories>
48+
<repository>
49+
<id>jitpack.io</id>
50+
<url>https://jitpack.io</url>
51+
</repository>
52+
</repositories>
53+
54+
<dependencies>
55+
<dependency>
56+
<groupId>javax.servlet</groupId>
57+
<artifactId>servlet-api</artifactId>
58+
<version>3.0-alpha-1</version>
59+
<scope>provided</scope>
60+
</dependency>
61+
<dependency>
62+
<groupId>com.github.carlsonsantana</groupId>
63+
<artifactId>HaTeMiLe-for-Java</artifactId>
64+
<version>2.2.0</version>
65+
</dependency>
66+
</dependencies>
67+
68+
<build>
69+
<plugins>
70+
<plugin>
71+
<groupId>org.apache.maven.plugins</groupId>
72+
<artifactId>maven-checkstyle-plugin</artifactId>
73+
<version>2.17</version>
74+
<executions>
75+
<execution>
76+
<id>validate</id>
77+
<phase>validate</phase>
78+
<configuration>
79+
<configLocation>checkstyle.xml</configLocation>
80+
<encoding>UTF-8</encoding>
81+
<consoleOutput>true</consoleOutput>
82+
<failsOnError>true</failsOnError>
83+
<linkXRef>false</linkXRef>
84+
</configuration>
85+
<goals>
86+
<goal>check</goal>
87+
</goals>
88+
</execution>
89+
</executions>
90+
</plugin>
91+
</plugins>
92+
</build>
93+
94+
<reporting>
95+
<outputDirectory>${basedir}/docs</outputDirectory>
96+
<plugins>
97+
<plugin>
98+
<groupId>org.apache.maven.plugins</groupId>
99+
<artifactId>maven-javadoc-plugin</artifactId>
100+
<version>3.0.0-M1</version>
101+
</plugin>
102+
<plugin>
103+
<groupId>org.apache.maven.plugins</groupId>
104+
<artifactId>maven-checkstyle-plugin</artifactId>
105+
<version>2.17</version>
106+
<configuration>
107+
<configLocation>checkstyle.xml</configLocation>
108+
<failOnViolation>false</failOnViolation>
109+
</configuration>
110+
</plugin>
111+
</plugins>
112+
</reporting>
113+
</project>

0 commit comments

Comments
 (0)