Editor Config
1. 사용목적
- 일관된 코딩 스타일을 유지
- 팀원 간의 코드 스타일 통일
- 코드 리뷰 시 스타일 관련 논의 최소화
이 프로젝트에서 특히 중요한 이유
스타일 취향 문제가 아니라 동작에 영향을 주는 설정이 들어 있습니다.
SQL DSL 코드는 키워드를 우측정렬해 가독성을 확보하는데, IDE 자동 포맷이 이를 뭉갭니다. 그래서 .editorconfig 가 포맷터 마커(//@formatter:off … on)를 활성화합니다.
이 설정이 없으면 DSL 블록이 저장할 때마다 흐트러지고, 그 diff 가 실제 변경을 덮습니다 → MyBatis Dynamic SQL · 코드 포맷 규칙
IntelliJ 설정 확인
Preferences → Editor → Code Style → Enable formatter markers in comments 가 켜져 있어야 마커가 동작합니다.
2. 구성요소
2-1. 설정파일
.editorconfig: 프로젝트 루트에 위치- 다양한 IDE와 에디터에서 지원
- 언어별, 파일 타입별 설정 가능
2-2. IDE or Editor 플러그인
- IntelliJ IDEA
- Eclipse
- VS Code
- Sublime Text
- Atom 등
3. 설정파일 위치
프로젝트 루트 디렉토리에 .editorconfig 파일을 생성:
프로젝트/
├── .editorconfig
├── src/
└── ...4. IntelliJ
4-1. 설정 on/off
- Preferences > Editor > Code Style > Enable EditorConfig support
.editorconfig파일이 있는 경우 자동으로 적용
4-2. 기본 설정 예시
ini
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
[*.{js,jsx,ts,tsx}]
indent_size = 2
[*.{java,kt}]
indent_size = 4
[*.{yml,yaml}]
indent_size = 25. Eclipse
- Eclipse Marketplace에서 "EditorConfig" 플러그인 설치
- 설치 후 프로젝트 재시작
.editorconfig파일 자동 인식 및 적용