Skip to content

Commit 5d52e0b

Browse files
eregoneregon
committed
[GR-17457] Update CheckStyle
PullRequest: truffleruby/3783
2 parents 2ed408d + 6a92d32 commit 5d52e0b

23 files changed

+135
-133
lines changed

‎mx.truffleruby/suite.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@
247247
],
248248
"jacoco": "include",
249249
"javaCompliance": "17+",
250+
"checkstyleVersion": "10.7.0",
250251
"checkstyle": "org.truffleruby",
251252
"workingSets": "TruffleRuby",
252253
"findbugsIgnoresGenerated": True,

‎src/main/.checkstyle_checks.xml

Lines changed: 72 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
2+
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
33

4-
<!--
5-
Checkstyle-Configuration: Checks
6-
Description: none
7-
-->
84
<module name="Checker">
95
<property name="severity" value="error"/>
106
<module name="TreeWalker">
@@ -13,7 +9,6 @@
139
<property name="allowStaticMemberImports" value="false"/>
1410
</module>
1511
<property name="tabWidth" value="4"/>
16-
<module name="FileContentsHolder"/>
1712
<!--<module name="JavadocStyle">-->
1813
<!--<property name="checkHtml" value="false"/>-->
1914
<!--</module>-->
@@ -67,7 +62,7 @@
6762
<property name="ignoreConstructorParameter" value="true"/>
6863
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
6964
</module>
70-
<!--<module name="FinalClass"/>-->
65+
<module name="FinalClass"/>
7166
<module name="HideUtilityClassConstructor">
7267
<property name="severity" value="ignore"/>
7368
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
@@ -112,6 +107,9 @@
112107
<property name="severity" value="ignore"/>
113108
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
114109
</module>
110+
<!--<module name="RegexpSingleline">-->
111+
<!--<property name="format" value="System\.(out|err)\.print"/>-->
112+
<!--</module>-->
115113
<!--<module name="RegexpSinglelineJava">-->
116114
<!--<metadata name="net.sf.eclipsecs.core.comment" value="Illegal trailing whitespace(s) at the end of the line."/>-->
117115
<!--<property name="format" value="\s$"/>-->
@@ -261,7 +259,73 @@
261259
</module>
262260
<module name="IllegalType">
263261
<!-- Use PrintStream instead of PrintWriter, PrintWriter does not consistently flush, even when writing \n.-->
264-
<property name="illegalClassNames" value="TruffleObject,DynamicObject,PrintWriter"/>
262+
<property name="illegalClassNames" value="PrintWriter"/>
263+
</module>
264+
<module name="IllegalType">
265+
<!-- Allow to `MyClass extends/implements` these but nowhere else, by removing CLASS_DEF from the list at https://checkstyle.sourceforge.io/version/10.7.0/config_coding.html#IllegalType -->
266+
<property name="illegalClassNames" value="DynamicObject,TruffleObject"/>
267+
<property name="tokens" value="ANNOTATION_FIELD_DEF,INTERFACE_DEF,METHOD_CALL,METHOD_DEF,METHOD_REF,PARAMETER_DEF,VARIABLE_DEF,PATTERN_VARIABLE_DEF,RECORD_DEF,RECORD_COMPONENT_DEF"/>
268+
</module>
269+
270+
<module name="SuppressionCommentFilter">
271+
<property name="offCommentFormat" value="Checkstyle: stop constant name check"/>
272+
<property name="onCommentFormat" value="Checkstyle: resume constant name check"/>
273+
<property name="checkFormat" value="ConstantNameCheck"/>
274+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Allow non-conforming constant names"/>
275+
</module>
276+
<module name="SuppressionCommentFilter">
277+
<property name="offCommentFormat" value="Checkstyle: stop method name check"/>
278+
<property name="onCommentFormat" value="Checkstyle: resume method name check"/>
279+
<property name="checkFormat" value="MethodName"/>
280+
<property name="checkC" value="false"/>
281+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable method name checks"/>
282+
</module>
283+
<module name="SuppressionCommentFilter">
284+
<property name="offCommentFormat" value="CheckStyle: stop parameter assignment check"/>
285+
<property name="onCommentFormat" value="CheckStyle: resume parameter assignment check"/>
286+
<property name="checkFormat" value="ParameterAssignment"/>
287+
<property name="checkC" value="false"/>
288+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable Parameter Assignment"/>
289+
</module>
290+
<module name="SuppressionCommentFilter">
291+
<property name="offCommentFormat" value="Checkstyle: stop final variable check"/>
292+
<property name="onCommentFormat" value="Checkstyle: resume final variable check"/>
293+
<property name="checkFormat" value="FinalLocalVariable"/>
294+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable final variable checks"/>
295+
</module>
296+
<module name="SuppressionCommentFilter">
297+
<property name="offCommentFormat" value="Checkstyle: stop"/>
298+
<property name="onCommentFormat" value="Checkstyle: resume"/>
299+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable all checks"/>
300+
</module>
301+
<module name="SuppressionCommentFilter">
302+
<property name="offCommentFormat" value="CheckStyle: stop inner assignment check"/>
303+
<property name="onCommentFormat" value="CheckStyle: resume inner assignment check"/>
304+
<property name="checkFormat" value="InnerAssignment"/>
305+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable inner assignment checks"/>
306+
</module>
307+
<module name="SuppressionCommentFilter">
308+
<property name="offCommentFormat" value="Checkstyle: stop field name check"/>
309+
<property name="onCommentFormat" value="Checkstyle: resume field name check"/>
310+
<property name="checkFormat" value="MemberName"/>
311+
<property name="checkC" value="false"/>
312+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable field name checks"/>
313+
</module>
314+
<module name="SuppressionCommentFilter">
315+
<property name="offCommentFormat" value="CheckStyle: stop system..print check"/>
316+
<property name="onCommentFormat" value="CheckStyle: resume system..print check"/>
317+
<property name="checkFormat" value="RegexpSingleline"/>
318+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable System.(out|err).print checks"/>
319+
</module>
320+
<module name="SuppressionCommentFilter">
321+
<property name="offCommentFormat" value="CheckStyle: stop header check"/>
322+
<property name="onCommentFormat" value="CheckStyle: resume header check"/>
323+
<property name="checkFormat" value=".*Header"/>
324+
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable header checks"/>
325+
</module>
326+
<module name="SuppressionCommentFilter">
327+
<property name="offCommentFormat" value="CheckStyle: start generated"/>
328+
<property name="onCommentFormat" value="CheckStyle: stop generated"/>
265329
</module>
266330
</module>
267331
<module name="RegexpMultiline">
@@ -291,67 +355,4 @@
291355
<property name="lineSeparator" value="lf"/>
292356
</module>
293357
<module name="Translation"/>
294-
<module name="SuppressionCommentFilter">
295-
<property name="offCommentFormat" value="Checkstyle: stop constant name check"/>
296-
<property name="onCommentFormat" value="Checkstyle: resume constant name check"/>
297-
<property name="checkFormat" value="ConstantNameCheck"/>
298-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Allow non-conforming constant names"/>
299-
</module>
300-
<module name="SuppressionCommentFilter">
301-
<property name="offCommentFormat" value="Checkstyle: stop method name check"/>
302-
<property name="onCommentFormat" value="Checkstyle: resume method name check"/>
303-
<property name="checkFormat" value="MethodName"/>
304-
<property name="checkC" value="false"/>
305-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable method name checks"/>
306-
</module>
307-
<module name="SuppressionCommentFilter">
308-
<property name="offCommentFormat" value="CheckStyle: stop parameter assignment check"/>
309-
<property name="onCommentFormat" value="CheckStyle: resume parameter assignment check"/>
310-
<property name="checkFormat" value="ParameterAssignment"/>
311-
<property name="checkC" value="false"/>
312-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable Parameter Assignment"/>
313-
</module>
314-
<module name="SuppressionCommentFilter">
315-
<property name="offCommentFormat" value="Checkstyle: stop final variable check"/>
316-
<property name="onCommentFormat" value="Checkstyle: resume final variable check"/>
317-
<property name="checkFormat" value="FinalLocalVariable"/>
318-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable final variable checks"/>
319-
</module>
320-
<module name="SuppressionCommentFilter">
321-
<property name="offCommentFormat" value="Checkstyle: stop"/>
322-
<property name="onCommentFormat" value="Checkstyle: resume"/>
323-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable all checks"/>
324-
</module>
325-
<module name="SuppressionCommentFilter">
326-
<property name="offCommentFormat" value="CheckStyle: stop inner assignment check"/>
327-
<property name="onCommentFormat" value="CheckStyle: resume inner assignment check"/>
328-
<property name="checkFormat" value="InnerAssignment"/>
329-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable inner assignment checks"/>
330-
</module>
331-
<module name="SuppressionCommentFilter">
332-
<property name="offCommentFormat" value="Checkstyle: stop field name check"/>
333-
<property name="onCommentFormat" value="Checkstyle: resume field name check"/>
334-
<property name="checkFormat" value="MemberName"/>
335-
<property name="checkC" value="false"/>
336-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable field name checks"/>
337-
</module>
338-
<module name="SuppressionCommentFilter">
339-
<property name="offCommentFormat" value="CheckStyle: stop system..print check"/>
340-
<property name="onCommentFormat" value="CheckStyle: resume system..print check"/>
341-
<property name="checkFormat" value="RegexpSingleline"/>
342-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable System.(out|err).print checks"/>
343-
</module>
344-
<module name="SuppressionCommentFilter">
345-
<property name="offCommentFormat" value="CheckStyle: stop header check"/>
346-
<property name="onCommentFormat" value="CheckStyle: resume header check"/>
347-
<property name="checkFormat" value=".*Header"/>
348-
<metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable header checks"/>
349-
</module>
350-
<module name="SuppressionCommentFilter">
351-
<property name="offCommentFormat" value="CheckStyle: start generated"/>
352-
<property name="onCommentFormat" value="CheckStyle: stop generated"/>
353-
</module>
354-
<!--<module name="RegexpSingleline">-->
355-
<!--<property name="format" value="System\.(out|err)\.print"/>-->
356-
<!--</module>-->
357358
</module>

‎src/main/java/org/truffleruby/core/array/ArrayBuilderNode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* by another usage (e.g. recursive) of this ArrayBuilderNode. */
3535
public abstract class ArrayBuilderNode extends RubyBaseNode {
3636

37-
public static class BuilderState {
37+
public static final class BuilderState {
3838
protected int capacity;
3939
protected int nextIndex = 0;
4040
protected Object store;

‎src/main/java/org/truffleruby/core/array/ArrayNodes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2367,7 +2367,7 @@ protected Object markNativeStore(RubyArray array) {
23672367
@Primitive(name = "array_flatten_helper", lowerFixnum = 2)
23682368
public abstract static class FlattenHelperNode extends PrimitiveArrayArgumentsNode {
23692369

2370-
static class Entry {
2370+
static final class Entry {
23712371
final RubyArray array;
23722372
final int index;
23732373

‎src/main/java/org/truffleruby/core/array/library/ZeroLengthArrayStore.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
@ExportLibrary(ArrayStoreLibrary.class)
2929
@GenerateUncached
30-
public class ZeroLengthArrayStore {
30+
public final class ZeroLengthArrayStore {
3131

3232
private ZeroLengthArrayStore() {
3333
}

‎src/main/java/org/truffleruby/core/basicobject/BasicObjectNodes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ protected Object methodMissing(Object self, Object name, Object[] args, Object b
524524
throw new RaiseException(getContext(), buildMethodMissingException(self, name, args, block));
525525
}
526526

527-
private static class FrameAndCallNode {
527+
private static final class FrameAndCallNode {
528528
final Frame frame;
529529
final Node callNode;
530530

‎src/main/java/org/truffleruby/core/fiber/FiberManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ public DescriptorAndArgs getDescriptorAndArgs() {
493493
}
494494
}
495495

496-
private static class FiberSafepointMessage implements FiberMessage {
496+
private static final class FiberSafepointMessage implements FiberMessage {
497497
private final RubyFiber sendingFiber;
498498
private final SafepointAction action;
499499

‎src/main/java/org/truffleruby/core/format/MissingValue.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
*/
1010
package org.truffleruby.core.format;
1111

12-
public class MissingValue {
12+
public final class MissingValue {
1313

1414
public static final MissingValue INSTANCE = new MissingValue();
1515

‎src/main/java/org/truffleruby/core/hash/HashNodes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ public abstract static class MapNode extends PrimitiveArrayArgumentsNode impleme
447447
@Child HashStoreLibrary.YieldPairNode yieldPair = HashStoreLibrary.YieldPairNode.create();
448448
@Child ArrayBuilderNode arrayBuilder = ArrayBuilderNode.create();
449449

450-
private static class MapState {
450+
private static final class MapState {
451451
final BuilderState builderState;
452452
final RubyProc block;
453453

‎src/main/java/org/truffleruby/core/hash/library/EmptyHashStore.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
@ExportLibrary(value = HashStoreLibrary.class)
3131
@GenerateUncached
32-
public class EmptyHashStore {
32+
public final class EmptyHashStore {
3333

3434
public static final EmptyHashStore NULL_HASH_STORE = new EmptyHashStore();
3535

0 commit comments

Comments
 (0)