Skip to content

Commit d5e6279

Browse files
allanimallanim
authored
Merge pull request #1 from allanim/master
Add java style
2 parents 9ce0839 + 32a6d51 commit d5e6279

7 files changed

Lines changed: 1113 additions & 0 deletions

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## vogle code style

‎editconfig/.editorconfig‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
insert_final_newline = true
6+
trim_trailing_whitespace = true
7+
indent_style = space
8+
9+
[*.java]
10+
indent_size = 4
11+
max_line_length = 120
12+
13+
[*.xml]
14+
indent_size = 2
15+
max_line_length = 120
16+
17+
[*.{gradle,groovy}]
18+
indent_size = 4
19+
max_line_length = 120
20+
21+
[*.{html,js,css,scss}]
22+
indent_size = 2
23+
24+
[*.json]
25+
indent_size = 2
26+
27+
[*.{yml,yaml}]
28+
indent_size = 2
29+
trim_trailing_whitespace = false
30+
31+
[*.md]
32+
trim_trailing_whitespace = false
33+
34+
[*.sql]
35+
indent_size = 2

‎java-checkstyle-vogle-style.xml‎

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
5+
6+
<!--
7+
** vogle style **
8+
9+
Checkstyle is very configurable. Be sure to read the documentation at
10+
http://checkstyle.sourceforge.net/ (or in your downloaded distribution).
11+
12+
To completely disable a check, just comment it out or delete it from the file.
13+
14+
Authors: Allan Im
15+
-->
16+
17+
<module name="Checker">
18+
<property name="charset" value="UTF-8"/>
19+
20+
<property name="severity" value="warning"/>
21+
22+
<property name="fileExtensions" value="java, properties, xml"/>
23+
<!-- Checks for whitespace -->
24+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
25+
<module name="FileTabCharacter">
26+
<property name="eachLine" value="true"/>
27+
</module>
28+
29+
<module name="TreeWalker">
30+
<module name="OuterTypeFilename"/>
31+
<module name="IllegalTokenText">
32+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
33+
<property name="format"
34+
value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
35+
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
36+
</module>
37+
<module name="AvoidEscapedUnicodeCharacters">
38+
<property name="allowEscapesForControlCharacters" value="true"/>
39+
<property name="allowByTailComment" value="true"/>
40+
<property name="allowNonPrintableEscapes" value="true"/>
41+
</module>
42+
<module name="LineLength">
43+
<property name="max" value="120"/>
44+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
45+
</module>
46+
<module name="AvoidStarImport"/>
47+
<module name="OneTopLevelClass"/>
48+
<module name="NoLineWrap"/>
49+
<module name="EmptyBlock">
50+
<property name="option" value="TEXT"/>
51+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
52+
</module>
53+
<module name="NeedBraces"/>
54+
<module name="LeftCurly">
55+
<property name="maxLineLength" value="120"/>
56+
</module>
57+
<module name="RightCurly"/>
58+
<module name="RightCurly">
59+
<property name="option" value="alone"/>
60+
<property name="tokens"
61+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
62+
</module>
63+
<module name="WhitespaceAround">
64+
<property name="allowEmptyConstructors" value="true"/>
65+
<property name="allowEmptyMethods" value="true"/>
66+
<property name="allowEmptyTypes" value="true"/>
67+
<property name="allowEmptyLoops" value="true"/>
68+
<message key="ws.notFollowed"
69+
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
70+
<message key="ws.notPreceded"
71+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
72+
</module>
73+
<module name="OneStatementPerLine"/>
74+
<module name="MultipleVariableDeclarations"/>
75+
<module name="ArrayTypeStyle"/>
76+
<module name="MissingSwitchDefault"/>
77+
<module name="FallThrough"/>
78+
<module name="UpperEll"/>
79+
<module name="ModifierOrder"/>
80+
<module name="EmptyLineSeparator">
81+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
82+
</module>
83+
<module name="SeparatorWrap">
84+
<property name="tokens" value="DOT"/>
85+
<property name="option" value="nl"/>
86+
</module>
87+
<module name="SeparatorWrap">
88+
<property name="tokens" value="COMMA"/>
89+
<property name="option" value="EOL"/>
90+
</module>
91+
<module name="PackageName">
92+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
93+
<message key="name.invalidPattern"
94+
value="Package name ''{0}'' must match pattern ''{1}''."/>
95+
</module>
96+
<module name="TypeName">
97+
<message key="name.invalidPattern"
98+
value="Type name ''{0}'' must match pattern ''{1}''."/>
99+
</module>
100+
<module name="MemberName">
101+
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
102+
<message key="name.invalidPattern"
103+
value="Member name ''{0}'' must match pattern ''{1}''."/>
104+
</module>
105+
<module name="ParameterName">
106+
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
107+
<message key="name.invalidPattern"
108+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
109+
</module>
110+
<module name="CatchParameterName">
111+
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
112+
<message key="name.invalidPattern"
113+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
114+
</module>
115+
<module name="LocalVariableName">
116+
<property name="tokens" value="VARIABLE_DEF"/>
117+
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
118+
<property name="allowOneCharVarInForLoop" value="true"/>
119+
<message key="name.invalidPattern"
120+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
121+
</module>
122+
<module name="ClassTypeParameterName">
123+
<property name="format" value="(^[A-Z]{1,3}[0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
124+
<message key="name.invalidPattern"
125+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
126+
</module>
127+
<module name="MethodTypeParameterName">
128+
<property name="format" value="(^[A-Z]{1,3}[0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
129+
<message key="name.invalidPattern"
130+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
131+
</module>
132+
<module name="InterfaceTypeParameterName">
133+
<property name="format" value="(^[A-Z]{1,3}[0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
134+
<message key="name.invalidPattern"
135+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
136+
</module>
137+
<module name="NoFinalizer"/>
138+
<module name="GenericWhitespace">
139+
<message key="ws.followed"
140+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
141+
<message key="ws.preceded"
142+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
143+
<message key="ws.illegalFollow"
144+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
145+
<message key="ws.notPreceded"
146+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
147+
</module>
148+
<module name="Indentation">
149+
<property name="basicOffset" value="4"/>
150+
<property name="braceAdjustment" value="0"/>
151+
<property name="caseIndent" value="4"/>
152+
<property name="throwsIndent" value="4"/>
153+
<property name="lineWrappingIndentation" value="4"/>
154+
<property name="arrayInitIndent" value="4"/>
155+
</module>
156+
<module name="AbbreviationAsWordInName">
157+
<property name="ignoreFinal" value="false"/>
158+
<property name="allowedAbbreviationLength" value="3"/>
159+
</module>
160+
<module name="OverloadMethodsDeclarationOrder"/>
161+
<module name="VariableDeclarationUsageDistance"/>
162+
<module name="CustomImportOrder">
163+
<property name="standardPackageRegExp" value="^(java|javax|com|net|org)\."/>
164+
<property name="specialImportsRegExp" value="^(org.springframework|org.junit)\."/>
165+
<property name="sortImportsInGroupAlphabetically" value="true"/>
166+
<property name="customImportOrderRules"
167+
value="STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STATIC"/>
168+
</module>
169+
<module name="MethodParamPad"/>
170+
<module name="OperatorWrap">
171+
<property name="option" value="NL"/>
172+
<property name="tokens"
173+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
174+
</module>
175+
<module name="AnnotationLocation">
176+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
177+
</module>
178+
<module name="AnnotationLocation">
179+
<property name="tokens" value="VARIABLE_DEF"/>
180+
<property name="allowSamelineMultipleAnnotations" value="true"/>
181+
</module>
182+
<module name="NonEmptyAtclauseDescription"/>
183+
<module name="JavadocTagContinuationIndentation"/>
184+
<module name="SummaryJavadoc">
185+
<property name="forbiddenSummaryFragments"
186+
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
187+
<property name="period" value=""/>
188+
</module>
189+
<module name="JavadocParagraph"/>
190+
<module name="AtclauseOrder">
191+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
192+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
193+
</module>
194+
<module name="JavadocMethod">
195+
<property name="scope" value="public"/>
196+
<property name="allowMissingJavadoc" value="true"/>
197+
<property name="allowMissingPropertyJavadoc" value="true"/>
198+
<property name="allowMissingParamTags" value="true"/>
199+
<property name="allowMissingThrowsTags" value="true"/>
200+
<property name="allowMissingReturnTag" value="true"/>
201+
<property name="minLineCount" value="2"/>
202+
<property name="allowedAnnotations" value="Override, Test"/>
203+
<property name="allowThrowsTagsForSubclasses" value="true"/>
204+
</module>
205+
<module name="MethodName">
206+
<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
207+
<message key="name.invalidPattern"
208+
value="Method name ''{0}'' must match pattern ''{1}''."/>
209+
</module>
210+
<module name="SingleLineJavadoc">
211+
<property name="ignoreInlineTags" value="false"/>
212+
</module>
213+
<module name="CommentsIndentation"/>
214+
</module>
215+
</module>

‎java-eclipse-vogle-style.importorder‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#vogleStyle Import Order
2+
#update 2018.06.09
3+
9=\#
4+
8=org.junit
5+
7=org.springframework
6+
6=
7+
5=io
8+
4=org
9+
3=net
10+
2=com
11+
1=javax
12+
0=java

0 commit comments

Comments
 (0)