checker

Documentation

Index

• func CheckBinaryFiles(cfg *config.Config) ([]string, error)
• func CheckDiff(cfg *config.Config) ([]string, error)
• func CheckDiffCustomRules(cfg *config.Config) ([]string, error)
• func CheckEditorConfig(cfg *config.Config) ([]string, error)
• func CheckEncoding(cfg *config.Config) ([]string, error)
• func CheckLint(cfg *config.Config) ([]string, error)
• func CheckMsg(cfg *config.Config, content string) []string
• func CheckMsgCustomRules(content string, rules []config.CustomRule) []string
• func CheckUnicode(cfg *config.Config) ([]string, error)
• func IsAllUppercaseASCII(s string) bool
• func IsPathLikeString(s string) bool
• func IsTechnicalString(s string) bool
• func RunBinaryFiles(cfg *config.Config) ([]string, error)
• func RunCommentLanguage(cfg *config.Config) ([]string, error)
• func RunEditorConfig(cfg *config.Config) ([]string, error)
• func RunEncoding(cfg *config.Config) ([]string, error)
• func RunLint(cfg *config.Config) ([]string, error)
• func RunUnicode(cfg *config.Config) ([]string, error)
• type FixResult
  • func FixFileContent(cfg *config.Config, content string) FixResult
  • func FixMsg(cfg *config.Config, content string) FixResult
  • func (r FixResult) NeedsFixing() bool

Functions

func CheckBinaryFiles

func CheckBinaryFiles(cfg *config.Config) ([]string, error)

CheckBinaryFiles: 스테이지된 diff에서 바이너리 파일을 검사. 위반 없으면 빈 슬라이스 반환.

func CheckDiff

func CheckDiff(cfg *config.Config) ([]string, error)

CheckDiff 는 스테이지된 diff 에서 주석 언어 위반을 검사합니다. 사람이 읽을 수 있는 오류 문자열 목록을 반환합니다 (빈 목록 = 위반 없음).

func CheckDiffCustomRules

func CheckDiffCustomRules(cfg *config.Config) ([]string, error)

CheckDiffCustomRules: 스테이지된 diff의 추가된 줄에 커스텀 정규식 규칙을 적용합니다. forbidden 규칙만 지원하며, 추가된 줄에서 패턴을 찾으면 오류를 반환합니다.

func CheckEditorConfig

func CheckEditorConfig(cfg *config.Config) ([]string, error)

CheckEditorConfig: 스테이지된 파일을 .editorconfig 규칙에 따라 검증. editorconfig-core-go/v2 패키지를 사용하여 정확한 규칙 매칭을 수행.

func CheckEncoding

func CheckEncoding(cfg *config.Config) ([]string, error)

CheckEncoding: 스테이지된 텍스트 파일의 UTF-8 인코딩 유효성 검사. chardet으로 인코딩을 감지하며, .editorconfig의 charset 설정이 latin1 등이면 건너뜀.

func CheckLint

func CheckLint(cfg *config.Config) ([]string, error)

CheckLint: 스테이지된 데이터 파일(YAML, JSON, XML)의 구문 오류를 검사.

func CheckMsg

func CheckMsg(cfg *config.Config, content string) []string

CheckMsg: 설정된 모든 정책 위반 여부를 커밋 메시지에서 검사. content는 커밋 메시지 파일(예: .git/COMMIT_EDITMSG)의 원시 텍스트.

func CheckMsgCustomRules

func CheckMsgCustomRules(content string, rules []config.CustomRule) []string

CheckMsgCustomRules: 커밋 메시지에 커스텀 정규식 규칙을 적용합니다. required 규칙은 전체 메시지에서 패턴을 찾지 못하면 오류. forbidden(기본) 규칙은 각 줄에서 패턴을 찾으면 오류.

func CheckUnicode

func CheckUnicode(cfg *config.Config) ([]string, error)

CheckUnicode: 스테이지된 파일에서 비가시/모호한 유니코드 문자를 검사.

func IsAllUppercaseASCII

func IsAllUppercaseASCII(s string) bool

IsAllUppercaseASCII: 소문자와 비ASCII 문자 없는 순수 대문자 ASCII 문자열은 상수 식별자로 판단. 예: "ERR_TOKEN", "MAX_RETRY_COUNT", "STATUS_OK"

func IsPathLikeString

func IsPathLikeString(s string) bool

IsPathLikeString: 슬래시(/) 포함 문자열은 경로 또는 MIME 타입으로 판단. 예: "/api/v1/users", "application/json", "text/html; charset=utf-8"

func IsTechnicalString

func IsTechnicalString(s string) bool

IsTechnicalString: 언어 검사 대상에서 제외할 기술적 문자열인지 판단. IsPathLikeString 또는 IsAllUppercaseASCII 조건 중 하나라도 해당하면 true.

func RunBinaryFiles

func RunBinaryFiles(cfg *config.Config) ([]string, error)

RunBinaryFiles: 추적된 모든 파일에서 바이너리 파일을 검사. 스테이지 상태에 관계없이 워킹 트리의 파일을 직접 읽어 검사.

func RunCommentLanguage

func RunCommentLanguage(cfg *config.Config) ([]string, error)

RunCommentLanguage: 추적된 모든 소스 파일의 주석 언어를 검사. check_mode 설정에 관계없이 항상 파일 전체를 검사.

func RunEditorConfig

func RunEditorConfig(cfg *config.Config) ([]string, error)

RunEditorConfig: 추적된 모든 파일의 .editorconfig 규칙 준수 여부를 검사.

func RunEncoding

func RunEncoding(cfg *config.Config) ([]string, error)

RunEncoding: 추적된 모든 파일의 UTF-8 인코딩 유효성을 검사.

func RunLint

func RunLint(cfg *config.Config) ([]string, error)

RunLint: 추적된 모든 데이터 파일(YAML, JSON, XML)의 구문 오류를 검사.

func RunUnicode

func RunUnicode(cfg *config.Config) ([]string, error)

RunUnicode: 추적된 모든 파일에서 비가시/모호한 유니코드 문자를 검사.

Types

type FixResult

type FixResult struct {
	Original string
	Fixed    string
	Changes  []string
}

FixResult 는 수정된 커밋 메시지와 변경 사항 설명 목록을 담습니다.

func FixFileContent

func FixFileContent(cfg *config.Config, content string) FixResult

FixFileContent 는 소스 파일 내용에서 자동 수정 가능한 유니코드 이슈를 수정합니다. EncodingConfig 설정에 따라 비가시 문자, 모호한 문자, 잘못된 UTF-8 바이트를 수정합니다.

func FixMsg

func FixMsg(cfg *config.Config, content string) FixResult

FixMsg 는 커밋 메시지에 자동 수정 가능한 모든 교정을 적용합니다. 구조적 위반(공동 작성자, 비가시 문자, 모호한 문자, 잘못된 룬)만 수정합니다. 본문의 언어 위반은 자동 수정되지 않습니다.

func (FixResult) NeedsFixing

func (r FixResult) NeedsFixing() bool

NeedsFixing 는 커밋 메시지에 자동 수정 가능한 위반이 있는지 확인합니다.