Skip to content

Commit

Permalink
Format XML
Browse files Browse the repository at this point in the history
  • Loading branch information
@garydgregory
garydgregory committed Oct 9, 2023
1 parent 4c9131e commit d9cb811
Showing 1 changed file with 37 additions and 51 deletions.
88 changes: 37 additions & 51 deletions src/conf/checkstyle.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,41 +38,32 @@
-->
<module name="Checker">

<module name="TreeWalker">
<module name="TreeWalker">

<!-- Item 4 - Avoid creating duplicate objects -->
<module name="IllegalInstantiation">
<property name="classes" value="java.lang.Boolean, java.lang.String"/>
<property name="classes" value="java.lang.Boolean, java.lang.String" />
</module>

<!-- Item 8 - Always override hashCode when you override equals -->
<module name="EqualsHashCode"/>
<module name="EqualsHashCode" />

<!-- Item 12 - Make all fields private -->
<!--
<module name="VisibilityModifier"/>
-->
<!-- <module name="VisibilityModifier"/> -->

<!-- Item 15 - Design and document for inheritance or else prohibit it -->
<!-- the module actually implements a very strict rule, it would be
interesting to know whether Joshua meant what checkstyle implements.
We feel this implementation is well suited as a warning,
i.e. if you get error messages from this check you should be
able to name a good reason to implement your code the way you do it,
especially if you are designing a library and not an application. -->
<!--
<module name="DesignForExtension">
<property name="severity" value="warning"/>
</module>
-->
<!-- the module actually implements a very strict rule, it would be interesting to know whether Joshua meant what checkstyle implements. We feel this implementation
is well suited as a warning, i.e. if you get error messages from this check you should be able to name a good reason to implement your code the way you do it, especially
if you are designing a library and not an application. -->
<!-- <module name="DesignForExtension"> <property name="severity" value="warning"/> </module> -->

<!-- Item 17 - Use interfaces only to define types -->
<module name="InterfaceIsType"/>
<module name="InterfaceIsType" />

<!-- Item 25 - Design method signatures carefully -->
<!-- Avoid long parameter lists -->
<module name="ParameterNumber">
<property name="max" value="4"/>
<property name="max" value="4" />
</module>

<!-- Item 26 - Use overloading judiciously -->
Expand All @@ -83,38 +74,37 @@

<!-- Item 28 - Write doc comments for all exposed API elements -->
<module name="JavadocType">
<property name="scope" value="protected"/>
<property name="scope" value="protected" />
</module>
<module name="JavadocMethod"> <!-- also covers Item 44 -->
<property name="accessModifiers" value="protected"/>
<property name="accessModifiers" value="protected" />
</module>
<module name="JavadocVariable">
<property name="scope" value="protected"/>
<property name="scope" value="protected" />
</module>

<!-- Item 29 - Minimize the scope of local variables -->
<!-- no rfe yet -->


<!-- Item 38 - Adhere to generally accepted naming conventions -->
<module name="PackageName">
<!-- no uppercase letters, between 2 and 10 characters -->
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,9})*$"/>
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,9})*$" />
</module>
<module name="TypeName"/>
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName" />
<module name="ConstantName" />
<module name="LocalFinalVariableName" />
<module name="LocalVariableName" />
<module name="MemberName" />
<module name="MethodName" />
<module name="ParameterName" />
<module name="StaticVariableName" />

<!-- Item 47 - Don't ignore exceptions -->
<module name="EmptyBlock">
<property name="tokens" value="LITERAL_CATCH"/>
<property name="tokens" value="LITERAL_CATCH" />
<!-- require a comment, change to stmt to require a statement -->
<property name="option" value="text"/>
<property name="option" value="text" />
</module>

<!-- Item 50 - Never invoke wait outside a loop -->
Expand All @@ -123,43 +113,39 @@
<!-- Item 57 - Provide a readResolve method when necessary -->
<!-- no rfe yet -->

<module name="MagicNumber"/>
<module name="MagicNumber" />

<module name="SuppressionCommentFilter"/>
<module name="SuppressionCommentFilter" />

<!--
Allow comment to suppress checkstyle for a single line
e.g. // CHECKSTYLE IGNORE MagicNumber
-->
<!-- Allow comment to suppress checkstyle for a single line e.g. // CHECKSTYLE IGNORE MagicNumber -->
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="CHECKSTYLE IGNORE (\w+)"/>
<property name="checkFormat" value="$1"/>
<property name="commentFormat" value="CHECKSTYLE IGNORE (\w+)" />
<property name="checkFormat" value="$1" />
</module>

</module>
</module>

<!-- enforce package documentation -->
<module name="JavadocPackage">
<!-- setting allowLegacy means it will check for package.html instead of just package-info.java -->
<property name="allowLegacy" value="true"/>
<property name="allowLegacy" value="true" />
</module>

<!-- Item 6 - Avoid finalizers -->
<!-- this will not find violations that contain linebreaks -->
<module name="RegexpSingleline">
<property name="format" value="((public)|(protected))\s+void\s+finalize\(\s*\)"/>
<property name="message" value="Avoid finalizers."/>
<property name="format" value="((public)|(protected))\s+void\s+finalize\(\s*\)" />
<property name="message" value="Avoid finalizers." />
</module>

<!-- don't allow tabs -->
<module name="FileTabCharacter">
<property name="fileExtensions" value="java,xml"/>
<property name="fileExtensions" value="java,xml" />
</module>

<module name="SuppressionFilter">
<!-- config_loc is used by Eclipse plugin -->
<property name="file" value="${config_loc}/checkstyle-suppressions.xml"/>
<property name="file" value="${config_loc}/checkstyle-suppressions.xml" />
</module>


</module>

0 comments on commit d9cb811

Please sign in to comment.