Checkstyle Miscellaneous, Naming Conventions and HEA Naming Convention Rules Based on Alibaba Code Guide
Meeting Info ¶
| Date | 2023-1-12 |
|---|---|
| Topic | Checkstyle Miscellaneous, Naming Conventions and HEA Naming Convention Rules Based on Alibaba Code Guide |
| Attendee | Calvin Yan, Selly Huang, Rocky Chi, Daniel Zhou, Ted Zhao, Jackson Liu |
| Note Taker | Daniel Zhou |
| Timer | Ted Zhao |
| Duration | 60 minutes |
Meeting Agenda ¶
- Continue go through Checkstyle rules - Miscellaneous, Naming Conventions and HEA Naming Convention Rules Based on Alibaba Code Guide
- Go through the status for last meeting minutes' action items
Meeting Minutes ¶
Miscellaneous, Naming Conventions and HEA Naming Convention Rules Based on Alibaba Code Guide ¶
<module name="NoCodeInFile">
<property name="severity" value="error"/>
</module>
<module name="OuterTypeFilename">
<property name="severity" value="error"/>
</module>
<module name="TodoComment">
<property name="severity" value="info"/>
<property name="format" value="(TODO)|(todo)"/>
</module>
<module name="UncommentedMain">
<property name="severity" value="warning"/>
<property name="excludedClasses" value=".*Application.*"/>
</module>
<module name="UniqueProperties">
<property name="severity" value="error"/>
<property name="fileExtensions" value="properties,cfg,yaml,yml"/>
</module>
<module name="UpperEll">
<property name="severity" value="warning"/>
</module>
<module name="RegexpSingleline">
<property name="severity" value="error"/>
<property name="format" value=".*[\u3400-\u4DB5\u4E00-\u9FA5\u9FA6-\u9FBB\uF900-\uFA2D\uFA30-\uFA6A\uFA70-\uFAD9\uFF00-\uFFEF\u2E80-\u2EFF\u3000-\u303F\u31C0-\u31EF]+.*"/>
<property name="message" value="Not allow chinese character!"/>
</module>
<!-- Uncommon abbreviations should be avoided for the sake of legibility. -->
<module name="AbbreviationAsWordInName">
<property name="severity" value="warning"/>
<property name="ignoreStaticFinal" value="true"/>
<property name="allowedAbbreviationLength" value="8"/>
<property name="allowedAbbreviations" value="MCT,EMS,UAS"/>
</module>
<!-- Abstract class names must start with Abstract or Base. -->
<module name="AbstractClassName">
<property name="severity" value="error"/>
<property name="format" value="^(Abstract|Base).+$"/>
</module>
<!-- Constant variable names should be written in upper characters separated by underscores -->
<module name="ConstantName">
<property name="severity" value="error"/>
<property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
</module>
<!-- Names should not start or end with an underline or a dollar sign. -->
<!-- Method names, parameter names, member variable names, and local variable names should be written in lowerCamelCase. -->
<module name="LocalFinalVariableName">
<property name="severity" value="error"/>
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
<module name="LocalVariableName">
<property name="severity" value="error"/>
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
<module name="MemberName">
<property name="severity" value="error"/>
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
<module name="MethodName">
<property name="severity" value="error"/>
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
<module name="StaticVariableName">
<property name="severity" value="error"/>
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
<module name="LambdaParameterName">
<property name="severity" value="error"/>
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
<!-- A package should be named in lowercase characters. There should be only one English word after each dot. -->
<module name="PackageName">
<property name="severity" value="error"/>
<property name="format" value="^[a-z]+(\.[a-z][a-z]*)*$"/>
</module>
<!-- Class names should be nouns in UpperCamelCase. -->
<module name="TypeName">
<property name="severity" value="error"/>
<property name="format" value="^[A-Z][a-zA-Z0-9]*$"/>
</module>
Reference ¶
check style HEA_Naming_Convention rules_Based_on_Alibaba_Code _Guide
check style Naming Conventions rules
check style Miscellaneous rules
Action Items ¶
- Fix Frontend HEA ESLint report issues - Jackson
- Need to create one Epic - improve code quality at each quarter and need to think how to define the goal - Service Leader
- HEA month release demo sharing at 1/18 - Rocky
- Vue - folder name (lower camel)? vue files (lower camel), pic files (all lowercase separated by underscores), css files (lower camel) - Jackson & Scarlett
- Prepare next HEA meeting's proposal about how to better write our documents - Rocky