style guide - sshome-25/safeRent-Backend GitHub Wiki

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <property name="charset" value="UTF-8"/>
    <property name="severity" value="warning"/>
    <property name="fileExtensions" value="java, properties, xml"/>
    
    <!-- 모듈 정보 파일 제외 -->
    <module name="BeforeExecutionExclusionFileFilter">
        <property name="fileNamePattern" value="module\-info\.java$"/>
    </module>
    
    <!-- 탭 문자 사용 금지 -->
    <module name="FileTabCharacter">
        <property name="eachLine" value="true"/>
    </module>
    
    <!-- 라인 길이 제한 -->
    <module name="LineLength">
        <property name="fileExtensions" value="java"/>
        <property name="max" value="100"/>
        <property name="ignorePattern" value="^package.*|^import.*|href\s*=\s*&quot;[^&quot;]*&quot;|http://|https://|ftp://"/>
    </module>
    
    <module name="TreeWalker">
        <!-- 기본 코드 스타일 검사 -->
        <module name="AvoidStarImport"/>
        <module name="NeedBraces"/>
        <module name="LeftCurly"/>
        <module name="RightCurly"/>
        <module name="OneStatementPerLine"/>
        
        <!-- 명명 규칙 -->
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
        </module>
        <module name="TypeName"/>
        <module name="MemberName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <module name="ParameterName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <module name="LocalVariableName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        
        <!-- 코드 형식 규칙 -->
        <module name="WhitespaceAround">
            <property name="allowEmptyConstructors" value="true"/>
            <property name="allowEmptyMethods" value="true"/>
            <property name="allowEmptyTypes" value="true"/>
            <property name="allowEmptyLoops" value="true"/>
            <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, 
                    BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND, 
                    LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, 
                    LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, 
                    LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, 
                    NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, 
                    SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT"/>
        </module>
        <module name="WhitespaceAfter"/>
        <module name="EmptyBlock">
            <property name="option" value="TEXT"/>
        </module>
        <module name="EmptyLineSeparator">
            <property name="allowNoEmptyLineBetweenFields" value="true"/>
        </module>
        <module name="MultipleVariableDeclarations"/>
        <module name="ArrayTypeStyle"/>
        
        <!-- 코드 품질 규칙 -->
        <module name="MissingSwitchDefault"/>
        <module name="FallThrough"/>
        <module name="UpperEll"/>
        <module name="ModifierOrder"/>
        <module name="EmptyCatchBlock">
            <property name="exceptionVariableName" value="expected"/>
        </module>
        
        <!-- Import 관련 규칙 -->
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>
        <module name="IllegalImport"/>
        
        <!-- Google 스타일 가이드에서 추가적인 중요 규칙 -->
        
        <!-- 클래스 및 인터페이스 설계 -->
        <module name="OneTopLevelClass"/> <!-- 파일당 하나의 최상위 클래스만 허용 -->
        <module name="InterfaceTypeParameterName"/> <!-- 인터페이스 타입 파라미터 이름 규칙 -->
        <module name="NoFinalizer"/> <!-- finalizer 메서드 사용 금지 -->
        
        <!-- 포맷팅 -->
        <module name="GenericWhitespace"/> <!-- 제네릭 관련 공백 규칙 -->
        <module name="Indentation"> <!-- 들여쓰기 규칙 -->
            <property name="basicOffset" value="2"/>
            <property name="braceAdjustment" value="0"/>
            <property name="caseIndent" value="2"/>
            <property name="throwsIndent" value="4"/>
            <property name="lineWrappingIndentation" value="4"/>
            <property name="arrayInitIndent" value="2"/>
        </module>
        <module name="NoLineWrap"/> <!-- 패키지, import 문의 줄바꿈 금지 -->
        <module name="OperatorWrap"> <!-- 연산자 줄바꿈 규칙 -->
            <property name="option" value="NL"/>
            <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, 
                    LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR"/>
        </module>
        
        <!-- 자바독(Javadoc) -->
        <module name="NonEmptyAtclauseDescription"/> <!-- Javadoc @절이 비어있지 않아야 함 -->
        
        <!-- 블록 관련 -->
        <module name="AvoidNestedBlocks"/> <!-- 중첩 블록 회피 -->
        
        <!-- 코딩 -->
        <module name="EqualsHashCode"/> <!-- equals와 hashCode 함께 정의 -->
        <module name="SimplifyBooleanExpression"/> <!-- 불필요하게 복잡한 boolean 표현식 간소화 -->
        <module name="SimplifyBooleanReturn"/> <!-- boolean 반환 간소화 -->
        
        <!-- 기타 중요 검사 -->
        <module name="OuterTypeFilename"/> <!-- 파일 이름과 클래스 이름 일치 확인 -->
        <module name="IllegalTokenText"> <!-- 특정 문자열 리터럴 제한 -->
            <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
            <property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
            <property name="message" value="특수 이스케이프 시퀀스 대신 유니코드 값이나 8진수 값을 사용하세요."/>
        </module>
        <module name="AvoidEscapedUnicodeCharacters"> <!-- 유니코드 이스케이프 제한 -->
            <property name="allowEscapesForControlCharacters" value="true"/>
            <property name="allowByTailComment" value="true"/>
            <property name="allowNonPrintableEscapes" value="true"/>
        </module>
        
        <!-- 약어 제한 -->
        <module name="AbbreviationAsWordInName">
            <property name="ignoreFinal" value="false"/>
            <property name="allowedAbbreviationLength" value="1"/>
        </module>
        
        <!-- case 구문 공백 제한 -->
        <module name="NoWhitespaceBeforeCaseDefaultColon"/>
        
        <!-- 변수 선언과 사용 거리 제한 -->
        <module name="VariableDeclarationUsageDistance"/>
        
        <!-- import 순서 -->
        <module name="CustomImportOrder">
            <property name="sortImportsInGroupAlphabetically" value="true"/>
            <property name="separateLineBetweenGroups" value="true"/>
            <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
        </module>
        
        <!-- 메서드 파라미터 패딩 -->
        <module name="MethodParamPad"/>
        
        <!-- 특정 문자 앞에 공백 제한 -->
        <module name="NoWhitespaceBefore">
            <property name="tokens" value="COMMA, SEMI, POST_INC, POST_DEC, DOT"/>
            <property name="allowLineBreaks" value="true"/>
        </module>
        
        <!-- 괄호 패딩 -->
        <module name="ParenPad"/>
        
        <!-- 구분자 줄바꿈 -->
        <module name="SeparatorWrap">
            <property name="tokens" value="DOT"/>
            <property name="option" value="nl"/>
        </module>
        <module name="SeparatorWrap">
            <property name="tokens" value="COMMA"/>
            <property name="option" value="EOL"/>
        </module>
        
        <!-- 애노테이션 위치 -->
        <module name="AnnotationLocation">
            <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
        </module>
        
        <!-- 주석 들여쓰기 -->
        <module name="CommentsIndentation"/>
    </module>
</module>