FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
Java/checkstyle.xml at master · Computer-Science-Resources/Java · GitHub
Computer-Science-Resources
Java
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
Java
/
checkstyle.xml
Copy path
More file actions
More file actions
Latest commit
History
History
History
198 lines (160 loc) · 7.63 KB
Breadcrumbs
Java
/
checkstyle.xml
Copy path
File metadata and controls
198 lines (160 loc) · 7.63 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<?
xml
version
=
"
1.0
"
?>
<!
DOCTYPE
module
PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
Checkstyle configuration that checks the sun coding conventions from:
- the Java Language Specification at
https://docs.oracle.com/javase/specs/jls/se11/html/index.html
- the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
- the Javadoc guidelines at
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
- the JDK Api documentation https://docs.oracle.com/en/java/javase/11/
- some best practices
Checkstyle is very configurable. Be sure to read the documentation at
https://checkstyle.org (or in your downloaded distribution).
Most Checks are configurable, be sure to consult the documentation.
To completely disable a check, just comment it out or delete it from the file.
To suppress certain violations please review suppression filters.
Finally, it is worth reading the documentation.
-->
<
module
name
=
"
Checker
"
>
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
https://checkstyle.org/config.html#Checker
<property name="basedir" value="${basedir}"/>
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
property
name
=
"
fileExtensions
"
value
=
"
java, properties, xml
"
/>
<!--
Excludes all 'module-info.java' files
-->
<!--
See https://checkstyle.org/filefilters/index.html
-->
<
module
name
=
"
BeforeExecutionExclusionFileFilter
"
>
<
property
name
=
"
fileNamePattern
"
value
=
"
module\-info\.java$
"
/>
</
module
>
<!--
https://checkstyle.org/filters/suppressionfilter.html
-->
<
module
name
=
"
SuppressionFilter
"
>
<
property
name
=
"
file
"
value
=
"
${org.checkstyle.sun.suppressionfilter.config}
"
default
=
"
checkstyle-suppressions.xml
"
/>
<
property
name
=
"
optional
"
value
=
"
true
"
/>
</
module
>
<!--
Checks that a package-info.java file exists for each package.
-->
<!--
See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage
-->
<!--
TODO <module name="JavadocPackage"/>
-->
<!--
Checks whether files end with a new line.
-->
<!--
See https://checkstyle.org/checks/misc/newlineatendoffile.html
-->
<
module
name
=
"
NewlineAtEndOfFile
"
/>
<!--
Checks that property files contain the same keys.
-->
<!--
See https://checkstyle.org/checks/misc/translation.html
-->
<
module
name
=
"
Translation
"
/>
<!--
Checks for Size Violations.
-->
<!--
See https://checkstyle.org/checks/sizes/index.html
-->
<!--
TODO <module name="FileLength"/>
-->
<!--
TODO <module name="LineLength">
<property name="fileExtensions" value="java"/>
</module>
-->
<!--
Checks for whitespace
-->
<!--
See https://checkstyle.org/checks/whitespace/index.html
-->
<!--
TODO <module name="FileTabCharacter"/>
-->
<!--
Miscellaneous other checks.
-->
<!--
See https://checkstyle.org/checks/misc/index.html
-->
<
module
name
=
"
RegexpSingleline
"
>
<
property
name
=
"
format
"
value
=
"
\s+$
"
/>
<
property
name
=
"
minimum
"
value
=
"
0
"
/>
<
property
name
=
"
maximum
"
value
=
"
0
"
/>
<
property
name
=
"
message
"
value
=
"
Line has trailing spaces.
"
/>
</
module
>
<!--
Checks for Headers
-->
<!--
See https://checkstyle.org/checks/header/index.html
-->
<!--
<module name="Header">
-->
<!--
<property name="headerFile" value="${checkstyle.header.file}"/>
-->
<!--
<property name="fileExtensions" value="java"/>
-->
<!--
</module>
-->
<
module
name
=
"
TreeWalker
"
>
<!--
Checks for Javadoc comments.
-->
<!--
See https://checkstyle.org/checks/javadoc/index.html
-->
<
module
name
=
"
InvalidJavadocPosition
"
/>
<!--
TODO <module name="JavadocMethod"/>
-->
<!--
TODO <module name="JavadocType"/>
-->
<!--
TODO <module name="JavadocVariable"/>
-->
<!--
TODO <module name="JavadocStyle"/>
-->
<!--
TODO <module name="MissingJavadocMethod"/>
-->
<!--
Checks for Naming Conventions.
-->
<!--
See https://checkstyle.org/checks/naming/index.html
-->
<
module
name
=
"
ConstantName
"
/>
<
module
name
=
"
LocalFinalVariableName
"
/>
<
module
name
=
"
LocalVariableName
"
/>
<
module
name
=
"
MemberName
"
/>
<
module
name
=
"
MethodName
"
/>
<
module
name
=
"
PackageName
"
/>
<
module
name
=
"
ParameterName
"
/>
<
module
name
=
"
StaticVariableName
"
/>
<
module
name
=
"
TypeName
"
/>
<!--
Checks for imports
-->
<!--
See https://checkstyle.org/checks/imports/index.html
-->
<
module
name
=
"
AvoidStarImport
"
/>
<
module
name
=
"
IllegalImport
"
/>
<!--
defaults to sun.* packages
-->
<
module
name
=
"
RedundantImport
"
/>
<
module
name
=
"
UnusedImports
"
>
<
property
name
=
"
processJavadoc
"
value
=
"
false
"
/>
</
module
>
<!--
Checks for Size Violations.
-->
<!--
See https://checkstyle.org/checks/sizes/index.html
-->
<
module
name
=
"
MethodLength
"
/>
<
module
name
=
"
ParameterNumber
"
/>
<!--
Checks for whitespace
-->
<!--
See https://checkstyle.org/checks/whitespace/index.html
-->
<
module
name
=
"
EmptyForIteratorPad
"
/>
<!--
TODO <module name="GenericWhitespace"/>
-->
<
module
name
=
"
MethodParamPad
"
/>
<!--
TODO <module name="NoWhitespaceAfter"/>
-->
<
module
name
=
"
NoWhitespaceBefore
"
/>
<
module
name
=
"
OperatorWrap
"
/>
<
module
name
=
"
ParenPad
"
/>
<
module
name
=
"
TypecastParenPad
"
/>
<
module
name
=
"
WhitespaceAfter
"
/>
<
module
name
=
"
WhitespaceAround
"
/>
<!--
Modifier Checks
-->
<!--
See https://checkstyle.org/checks/modifier/index.html
-->
<
module
name
=
"
ModifierOrder
"
/>
<
module
name
=
"
RedundantModifier
"
/>
<!--
Checks for blocks. You know, those {}'s
-->
<!--
See https://checkstyle.org/checks/blocks/index.html
-->
<
module
name
=
"
AvoidNestedBlocks
"
/>
<!--
TODO <module name="EmptyBlock"/>
-->
<!--
TODO <module name="LeftCurly"/>
-->
<
module
name
=
"
NeedBraces
"
/>
<!--
TODO <module name="RightCurly"/>
-->
<!--
Checks for common coding problems
-->
<!--
See https://checkstyle.org/checks/coding/index.html
-->
<
module
name
=
"
EmptyStatement
"
/>
<
module
name
=
"
EqualsHashCode
"
/>
<!--
TODO <module name="HiddenField"/>
-->
<
module
name
=
"
IllegalInstantiation
"
/>
<
module
name
=
"
InnerAssignment
"
/>
<!--
TODO <module name="MagicNumber"/>
-->
<
module
name
=
"
MissingSwitchDefault
"
/>
<
module
name
=
"
MultipleVariableDeclarations
"
/>
<
module
name
=
"
SimplifyBooleanExpression
"
/>
<
module
name
=
"
SimplifyBooleanReturn
"
/>
<!--
Checks for class design
-->
<!--
See https://checkstyle.org/checks/design/index.html
-->
<!--
TODO <module name="DesignForExtension"/>
-->
<
module
name
=
"
FinalClass
"
/>
<
module
name
=
"
HideUtilityClassConstructor
"
/>
<
module
name
=
"
InterfaceIsType
"
/>
<!--
TODO <module name="VisibilityModifier"/>
-->
<!--
Miscellaneous other checks.
-->
<!--
See https://checkstyle.org/checks/misc/index.html
-->
<
module
name
=
"
ArrayTypeStyle
"
/>
<!--
TODO <module name="FinalParameters"/>
-->
<
module
name
=
"
TodoComment
"
/>
<
module
name
=
"
UpperEll
"
/>
<!--
https://checkstyle.org/filters/suppressionxpathfilter.html
-->
<
module
name
=
"
SuppressionXpathFilter
"
>
<
property
name
=
"
file
"
value
=
"
${org.checkstyle.sun.suppressionxpathfilter.config}
"
default
=
"
checkstyle-xpath-suppressions.xml
"
/>
<
property
name
=
"
optional
"
value
=
"
true
"
/>
</
module
>
</
module
>
</
module
>
Back
|
FazBrowse Home
|
New Git URL