[TIL] editorconfig

Eden·2025년 8월 8일

.editorconfig는 여러 개발자가 동일한 코드 스타일을 유지할 수 있도록 도와주는 설정 파일입니다.
에디터나 IDE가 이 파일을 읽어 해당 프로젝트에 맞는 코드 스타일을 자동으로 적용합니다.

  • 텍스트 편집기와 IDE 간의 일관된 코드 스타일 보장
  • 다양한 언어 및 환경에서 적용 가능
  • 개발 생산성 향상 및 코드 품질 유지에 도움

2. 기본 구조

.editorconfig 파일은 여러 섹션으로 구성됩니다.

# 주석은 # 또는 ; 로 시작합니다

[섹션명]        # 파일 경로나 와일드카드 패턴 지정
속성=값         # 해당 섹션에 적용할 설정들

예시

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

3. 주요 설정 항목

속성명설명예시
root최상위 .editorconfig 파일 지정. true이면 하위 탐색 중단.root = true
indent_style들여쓰기 스타일 지정space 또는 tab
indent_size들여쓰기 크기 지정 (스페이스 개수)2, 4
tab_width탭 문자의 시각적 너비 지정 (들여쓰기와 별개)4
end_of_line줄바꿈 문자 지정lf (Unix), crlf (Windows), cr
charset문자 인코딩utf-8, utf-16be, latin1
trim_trailing_whitespace행 끝의 불필요한 공백 제거 여부true 또는 false
insert_final_newline파일 마지막에 줄바꿈 삽입 여부true 또는 false

4. 섹션별 파일 지정

  • [*.js] : 확장자가 .js인 모든 파일에 적용
  • [src/*.c] : src 폴더 내 .c 파일에 적용
  • [README.md] : 특정 파일에만 적용

5. 동작 원리

  1. 에디터가 현재 작업 중인 파일 경로를 기준으로 .editorconfig 파일을 상위 디렉토리부터 탐색
  2. 가장 가까운(또는 root=true가 설정된) .editorconfig 파일을 찾으면 해당 파일 읽음
  3. 해당 파일에서 작업 중인 파일에 맞는 섹션의 설정 적용

6. 활용 팁

  • root = true를 최상위 .editorconfig에 지정해 하위 디렉토리 설정 중복 방지
  • 파일별, 폴더별 세분화된 규칙 설정 가능
  • 팀 프로젝트 시 반드시 .editorconfig 파일을 저장소에 포함해 일관된 스타일 유지
  • IDE 별 플러그인이나 기본 지원 여부 확인 필요 (예: VSCode, IntelliJ, Sublime Text 등)

7. 요약

.editorconfig 파일은 협업 환경에서 코드 스타일 일관성을 유지하는 데 필수적입니다.
간단한 문법으로 에디터 설정을 제어하며, 다양한 에디터에서 지원되어 범용적으로 활용됩니다.


profile
iOS Dev

0개의 댓글