|
1 | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
2 | 2 | <!--
|
3 |
| - SPDX-License-Identifier: Apache-2.0 |
4 |
| - Copyright Red Hat Inc. and Hibernate Authors |
| 3 | + SPDX-License-Identifier: Apache-2.0 |
| 4 | + Copyright Red Hat Inc. and Hibernate Authors |
5 | 5 | -->
|
6 | 6 |
|
7 | 7 | <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
|
8 |
| - "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> |
| 8 | + "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> |
9 | 9 |
|
10 | 10 | <module name="Checker">
|
11 | 11 |
|
12 |
| - <property name="cacheFile" value="${checkstyle.cache.file}" /> |
13 |
| - |
14 |
| - <module name="Header"> |
15 |
| - <property name="headerFile" value="classpath:/org/hibernate/search/headers/java.header"/> |
16 |
| - <property name="fileExtensions" value="java"/> |
17 |
| - </module> |
18 |
| - |
19 |
| - <module name="Header"> |
20 |
| - <property name="headerFile" value="classpath:/org/hibernate/search/headers/xml.header"/> |
21 |
| - <property name="fileExtensions" value="xml"/> |
22 |
| - </module> |
23 |
| - |
24 |
| - <module name="Header"> |
25 |
| - <property name="headerFile" value="classpath:/org/hibernate/search/headers/properties.header"/> |
26 |
| - <property name="fileExtensions" value="properties"/> |
27 |
| - </module> |
28 |
| - |
29 |
| - <module name="Header"> |
30 |
| - <property name="headerFile" value="classpath:/org/hibernate/search/headers/adoc.header"/> |
31 |
| - <property name="fileExtensions" value="adoc,asciidoc"/> |
32 |
| - </module> |
33 |
| - |
34 |
| - <module name="TreeWalker"> |
35 |
| - |
36 |
| - <module name="SuppressionCommentFilter" /> |
37 |
| - |
38 |
| - <module name="RegexpSinglelineJava"> |
39 |
| - <property name="format" value="(?<!^import static)\s[\w\.]*\b([A-Z]\w*)?Assert(ions?)?\.[a-z]\w*\(" /> |
40 |
| - <property name="message" value="Always use static imports for assertions" /> |
41 |
| - <property name="ignoreComments" value="true" /> |
42 |
| - </module> |
43 |
| - |
44 |
| - <module name="RegexpSinglelineJava"> |
45 |
| - <property name="format" value="(?<!^import static)\s[\w\.]*\b([A-Z]\w*)?(Assume|Assumptions?)\.[a-z]\w*\(" /> |
46 |
| - <property name="message" value="Always use static imports for assumptions" /> |
47 |
| - <property name="ignoreComments" value="true" /> |
48 |
| - </module> |
49 |
| - |
50 |
| - <module name="RegexpSinglelineJava"> |
51 |
| - <property name="format" value="(?<!^import static)\s[\w\.]*\bOrmUtils\.[a-z]\w*\(" /> |
52 |
| - <property name="message" value="Always use static imports for OrmUtils" /> |
53 |
| - <property name="ignoreComments" value="true" /> |
54 |
| - </module> |
55 |
| - |
56 |
| - <!-- Do not use sync blocks on objects --> |
57 |
| - <module name="RegexpSinglelineJava"> |
58 |
| - <property name="format" value="synchronized\s*\(\s*(?!this\b)\w+" /> |
59 |
| - <!-- The last sentence of the message is a keyword to trigger exclusion: see ExcludeTestPackages --> |
60 |
| - <property name="message" value="Do not use `synchronized (someObject)` blocks. Instead use the `java.util.concurrent.locks.Lock`s. See HSEARCH-4712. [not required for tests]" /> |
61 |
| - <property name="ignoreComments" value="true" /> |
62 |
| - </module> |
63 |
| - |
64 |
| - <!-- Keep Tck Runners clean from local changes --> |
65 |
| - <module name="RegexpSinglelineJava"> |
66 |
| - <property name="format" value="@IncludeClassNamePatterns\(\{ "(?!\.\*Test", "\.\*IT).*" \}\)" /> |
67 |
| - <property name="message" value="Do not commit updated Tck Runner filter patterns!" /> |
68 |
| - <property name="ignoreComments" value="true" /> |
69 |
| - </module> |
70 |
| - |
71 |
| - <!-- Checks for imports --> |
72 |
| - <module name="AvoidStarImport" /> |
73 |
| - |
74 |
| - <!-- Checks for common coding problems --> |
75 |
| - <module name="EqualsHashCode" /> |
76 |
| - <module name="IllegalInstantiation" /> |
77 |
| - |
78 |
| - <!-- Miscellaneous other checks. --> |
79 |
| - <module name="ModifierOrder" /> |
80 |
| - <module name="PackageAnnotation" /> |
81 |
| - <module name="CovariantEquals" /> |
82 |
| - <module name="ModifiedControlVariable" /> |
83 |
| - <module name="NeedBraces" /> |
84 |
| - <module name="OneStatementPerLine" /> |
85 |
| - <module name="EmptyStatement" /> |
86 |
| - <module name="DefaultComesLast" /> |
87 |
| - <module name="TypecastParenPad" /> |
88 |
| - <module name="HideUtilityClassConstructor"/> |
89 |
| - <module name="MutableException"/> |
90 |
| - <module name="CovariantEquals" /> |
91 |
| - <module name="EqualsAvoidNull" /> |
92 |
| - <module name="UpperEll"/> |
93 |
| - |
94 |
| - <!-- <module name="DeclarationOrder" /> --> |
95 |
| - <!-- not checking for Constructor here: --> |
96 |
| - <module name="RedundantModifier"> |
97 |
| - <property name="tokens" |
98 |
| - value="METHOD_DEF, VARIABLE_DEF, ANNOTATION_FIELD_DEF, INTERFACE_DEF, CLASS_DEF, ENUM_DEF"/> |
99 |
| - </module> |
100 |
| - <module name="MissingOverride" /> |
101 |
| - |
102 |
| - <module name="MethodParamPad"> |
103 |
| - <property name="option" value="nospace" /> |
104 |
| - <property name="allowLineBreaks" value="false" /> |
105 |
| - </module> |
106 |
| - |
107 |
| - <module name="ParenPad"> |
108 |
| - <property name="tokens" value="CTOR_CALL, SUPER_CTOR_CALL, LITERAL_FOR, LITERAL_IF, |
109 |
| - LITERAL_WHILE, LITERAL_SWITCH, LITERAL_NEW, METHOD_CALL, RESOURCE_SPECIFICATION"/> |
110 |
| - <property name="option" value="space"/> |
111 |
| - </module> |
112 |
| - |
113 |
| - <!-- WARN, ERROR and INFO Logging severity levels should be used exclusively via the methods which allow i18 --> |
114 |
| - <module name="RegexpSinglelineJava"> |
115 |
| - <property name="format" value="log\.((error)|(warn)|(info))\(" /> |
116 |
| - <!-- The last sentence of the message is a keyword to trigger exclusion: see ExcludeTestPackages --> |
117 |
| - <property name="message" value="'log.error()', warn() and info() should never be used. [not required for tests]" /> |
118 |
| - <property name="ignoreComments" value="true" /> |
119 |
| - </module> |
120 |
| - |
121 |
| - <module name="RegexpSinglelineJava"> |
122 |
| - <property name="format" value="System\.(out)|(err)\.print(ln)?\(" /> |
123 |
| - <!-- The last sentence of the message is a keyword to trigger exclusion: see ExcludeTestPackages --> |
124 |
| - <property name="message" value="Not allowed to print to System.out: if you're damn sure you want it, disable Checkstyle on this line. [not required for tests]" /> |
125 |
| - <property name="ignoreComments" value="true" /> |
126 |
| - </module> |
127 |
| - |
128 |
| - <!-- Loggers should follow conventions and best practices --> |
129 |
| - <module name="RegexpSinglelineJava"> |
130 |
| - <property name="format" value="(?<!\bstatic final) Log \w+ =" /> |
131 |
| - <property name="message" value="Loggers must be static final" /> |
132 |
| - </module> |
133 |
| - <module name="RegexpSinglelineJava"> |
134 |
| - <property name="format" value="\bLog (?!log |\w+Log |INSTANCE )\w+ =" /> |
135 |
| - <property name="message" value="Loggers must be named exactly `log` (or in some specific cases `INSTANCE` or `<something>Log`)" /> |
136 |
| - </module> |
137 |
| - </module> |
138 |
| - |
139 |
| - <module name="org.hibernate.checkstyle.filters.ExcludeTestPackages" /> |
140 |
| - |
141 |
| - <module name="RegexpSingleline"> |
142 |
| - <!-- not using an "illegal import" rule as the java.lang package doesn't need to be imported --> |
143 |
| - <property name="format" value="\s+throw new AssertionError\(" /> |
144 |
| - <property name="message" value="Avoid throwing 'AssertionError': use org.hibernate.search.util.common.AssertionFailure" /> |
145 |
| - </module> |
146 |
| - |
147 |
| - <module name="SuppressionFilter"> |
148 |
| - <property name="file" value="/suppressions.xml" /> |
149 |
| - </module> |
| 12 | + <property name="cacheFile" value="${checkstyle.cache.file}" /> |
| 13 | + |
| 14 | + <module name="Header"> |
| 15 | + <property name="headerFile" value="classpath:/org/hibernate/search/headers/java.header"/> |
| 16 | + <property name="fileExtensions" value="java"/> |
| 17 | + </module> |
| 18 | + |
| 19 | + <module name="Header"> |
| 20 | + <property name="headerFile" value="classpath:/org/hibernate/search/headers/xml.header"/> |
| 21 | + <property name="fileExtensions" value="xml"/> |
| 22 | + </module> |
| 23 | + |
| 24 | + <module name="Header"> |
| 25 | + <property name="headerFile" value="classpath:/org/hibernate/search/headers/properties.header"/> |
| 26 | + <property name="fileExtensions" value="properties"/> |
| 27 | + </module> |
| 28 | + |
| 29 | + <module name="Header"> |
| 30 | + <property name="headerFile" value="classpath:/org/hibernate/search/headers/adoc.header"/> |
| 31 | + <property name="fileExtensions" value="adoc,asciidoc"/> |
| 32 | + </module> |
| 33 | + |
| 34 | + <module name="TreeWalker"> |
| 35 | + |
| 36 | + <module name="SuppressionCommentFilter" /> |
| 37 | + |
| 38 | + <module name="RegexpSinglelineJava"> |
| 39 | + <property name="format" value="(?<!^import static)\s[\w\.]*\b([A-Z]\w*)?Assert(ions?)?\.[a-z]\w*\(" /> |
| 40 | + <property name="message" value="Always use static imports for assertions" /> |
| 41 | + <property name="ignoreComments" value="true" /> |
| 42 | + </module> |
| 43 | + |
| 44 | + <module name="RegexpSinglelineJava"> |
| 45 | + <property name="format" value="(?<!^import static)\s[\w\.]*\b([A-Z]\w*)?(Assume|Assumptions?)\.[a-z]\w*\(" /> |
| 46 | + <property name="message" value="Always use static imports for assumptions" /> |
| 47 | + <property name="ignoreComments" value="true" /> |
| 48 | + </module> |
| 49 | + |
| 50 | + <module name="RegexpSinglelineJava"> |
| 51 | + <property name="format" value="(?<!^import static)\s[\w\.]*\bOrmUtils\.[a-z]\w*\(" /> |
| 52 | + <property name="message" value="Always use static imports for OrmUtils" /> |
| 53 | + <property name="ignoreComments" value="true" /> |
| 54 | + </module> |
| 55 | + |
| 56 | + <!-- Do not use sync blocks on objects --> |
| 57 | + <module name="RegexpSinglelineJava"> |
| 58 | + <property name="format" value="synchronized\s*\(\s*(?!this\b)\w+" /> |
| 59 | + <!-- The last sentence of the message is a keyword to trigger exclusion: see ExcludeTestPackages --> |
| 60 | + <property name="message" value="Do not use `synchronized (someObject)` blocks. Instead use the `java.util.concurrent.locks.Lock`s. See HSEARCH-4712. [not required for tests]" /> |
| 61 | + <property name="ignoreComments" value="true" /> |
| 62 | + </module> |
| 63 | + |
| 64 | + <!-- Keep Tck Runners clean from local changes --> |
| 65 | + <module name="RegexpSinglelineJava"> |
| 66 | + <property name="format" value="@IncludeClassNamePatterns\(\{ "(?!\.\*Test", "\.\*IT).*" \}\)" /> |
| 67 | + <property name="message" value="Do not commit updated Tck Runner filter patterns!" /> |
| 68 | + <property name="ignoreComments" value="true" /> |
| 69 | + </module> |
| 70 | + |
| 71 | + <!-- Checks for imports --> |
| 72 | + <module name="AvoidStarImport" /> |
| 73 | + |
| 74 | + <!-- Checks for common coding problems --> |
| 75 | + <module name="EqualsHashCode" /> |
| 76 | + <module name="IllegalInstantiation" /> |
| 77 | + |
| 78 | + <!-- Miscellaneous other checks. --> |
| 79 | + <module name="ModifierOrder" /> |
| 80 | + <module name="PackageAnnotation" /> |
| 81 | + <module name="CovariantEquals" /> |
| 82 | + <module name="ModifiedControlVariable" /> |
| 83 | + <module name="NeedBraces" /> |
| 84 | + <module name="OneStatementPerLine" /> |
| 85 | + <module name="EmptyStatement" /> |
| 86 | + <module name="DefaultComesLast" /> |
| 87 | + <module name="TypecastParenPad" /> |
| 88 | + <module name="HideUtilityClassConstructor"/> |
| 89 | + <module name="MutableException"/> |
| 90 | + <module name="CovariantEquals" /> |
| 91 | + <module name="EqualsAvoidNull" /> |
| 92 | + <module name="UpperEll"/> |
| 93 | + |
| 94 | + <!-- <module name="DeclarationOrder" /> --> |
| 95 | + <!-- not checking for Constructor here: --> |
| 96 | + <module name="RedundantModifier"> |
| 97 | + <property name="tokens" |
| 98 | + value="METHOD_DEF, VARIABLE_DEF, ANNOTATION_FIELD_DEF, INTERFACE_DEF, CLASS_DEF, ENUM_DEF"/> |
| 99 | + </module> |
| 100 | + <module name="MissingOverride" /> |
| 101 | + |
| 102 | + <module name="MethodParamPad"> |
| 103 | + <property name="option" value="nospace" /> |
| 104 | + <property name="allowLineBreaks" value="false" /> |
| 105 | + </module> |
| 106 | + |
| 107 | + <module name="ParenPad"> |
| 108 | + <property name="tokens" value="CTOR_CALL, SUPER_CTOR_CALL, LITERAL_FOR, LITERAL_IF, |
| 109 | + LITERAL_WHILE, LITERAL_SWITCH, LITERAL_NEW, METHOD_CALL, RESOURCE_SPECIFICATION"/> |
| 110 | + <property name="option" value="space"/> |
| 111 | + </module> |
| 112 | + |
| 113 | + <!-- WARN, ERROR and INFO Logging severity levels should be used exclusively via the methods which allow i18 --> |
| 114 | + <module name="RegexpSinglelineJava"> |
| 115 | + <property name="format" value="log\.((error)|(warn)|(info))\(" /> |
| 116 | + <!-- The last sentence of the message is a keyword to trigger exclusion: see ExcludeTestPackages --> |
| 117 | + <property name="message" value="'log.error()', warn() and info() should never be used. [not required for tests]" /> |
| 118 | + <property name="ignoreComments" value="true" /> |
| 119 | + </module> |
| 120 | + |
| 121 | + <module name="RegexpSinglelineJava"> |
| 122 | + <property name="format" value="System\.(out)|(err)\.print(ln)?\(" /> |
| 123 | + <!-- The last sentence of the message is a keyword to trigger exclusion: see ExcludeTestPackages --> |
| 124 | + <property name="message" value="Not allowed to print to System.out: if you're damn sure you want it, disable Checkstyle on this line. [not required for tests]" /> |
| 125 | + <property name="ignoreComments" value="true" /> |
| 126 | + </module> |
| 127 | + |
| 128 | + <!-- Loggers should follow conventions and best practices --> |
| 129 | + <module name="RegexpSinglelineJava"> |
| 130 | + <property name="format" value="(?<!\bstatic final) Log \w+ =" /> |
| 131 | + <property name="message" value="Loggers must be static final" /> |
| 132 | + </module> |
| 133 | + <module name="RegexpSinglelineJava"> |
| 134 | + <property name="format" value="\bLog (?!log |\w+Log |INSTANCE )\w+ =" /> |
| 135 | + <property name="message" value="Loggers must be named exactly `log` (or in some specific cases `INSTANCE` or `<something>Log`)" /> |
| 136 | + </module> |
| 137 | + </module> |
| 138 | + |
| 139 | + <module name="org.hibernate.checkstyle.filters.ExcludeTestPackages" /> |
| 140 | + |
| 141 | + <module name="RegexpSingleline"> |
| 142 | + <!-- not using an "illegal import" rule as the java.lang package doesn't need to be imported --> |
| 143 | + <property name="format" value="\s+throw new AssertionError\(" /> |
| 144 | + <property name="message" value="Avoid throwing 'AssertionError': use org.hibernate.search.util.common.AssertionFailure" /> |
| 145 | + </module> |
| 146 | + |
| 147 | + <module name="SuppressionFilter"> |
| 148 | + <property name="file" value="/suppressions.xml" /> |
| 149 | + </module> |
150 | 150 |
|
151 | 151 | </module>
|
0 commit comments