Skip to content

Checkstyle Design and block rule

Meeting Info

Date 2022-12-29
Topic Checkstyle Design and block rule
Attendee Calvin Yan, Selly Huang, Rocky Chi, Daniel Zhou, Ted Zhao, Jackson Liu
Note Taker Rocky Chi
Timer Jackson Liu
Duration 30 minutes

Meeting Agenda

  1. Go through Checkstyle Design and block rule

Meeting Minutes

Block Rules

<module name="AvoidNestedBlocks">
    <property name="severity" value="error"/>
    <property name="allowInSwitchCase" value="false"/>
</module>
<module name="EmptyBlock">
    <property name="severity" value="warning"/>
    <property name="option" value="text"/>
    <property name="tokens" value="LITERAL_WHILE , LITERAL_TRY , LITERAL_CATCH , LITERAL_FINALLY , LITERAL_DO , LITERAL_IF , LITERAL_ELSE , LITERAL_FOR , INSTANCE_INIT , STATIC_INIT , LITERAL_SWITCH , LITERAL_SYNCHRONIZED , LITERAL_CASE , LITERAL_DEFAULT , ARRAY_INIT"/>
</module>
<module name="LeftCurly">
    <property name="severity" value="info"/>
    <property name="option" value="eol"/>
    <property name="ignoreEnums" value="false"/>
</module>
<module name="NeedBraces">
    <property name="severity" value="warning"/>
    <property name="allowSingleLineStatement" value="true"/>
</module>

Design Rules

<module name="FinalClass">
    <property name="severity" value="warning"/>
</module>
<module name="HideUtilityClassConstructor">
    <property name="severity" value="warning"/>
</module>
<module name="InterfaceIsType">
    <property name="severity" value="warning"/>
</module>
<module name="MutableException">
    <property name="severity" value="warning"/>
</module>
<module name="OneTopLevelClass">
    <property name="severity" value="error"/>
</module>
<module name="ThrowsCount">
    <property name="severity" value="warning"/>
    <property name="max" value="4"/>
    <property name="ignorePrivateMethods" value="true"/>
</module>

Reference

check style design rules
check style block rules