EditorConfig 생성기

.editorconfig가 하는 일

프로젝트 루트에 둔 .editorconfig라는 파일은 형식 규약을 선언합니다. EditorConfig를 지원하는 편집기(모든 주요 IDE와 대부분의 최신 텍스트 편집기)는 파일을 열 때 그 규칙을 적용합니다. 탐색은 편집 중인 파일에서 디렉터리 트리를 위로 거슬러 올라가다가 root = true라고 적힌 첫 파일에서 멈춥니다.

출력 예시

기본 설정(스페이스, 들여쓰기 크기 4, LF, utf-8)과 미리 체크돼 있는 두 섹션을 쓰면 생성기는 다음을 출력합니다:

root = true

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

[*.{md,markdown}]
trim_trailing_whitespace = false

[{Makefile,makefile,GNUmakefile,*.mk}]
indent_style = tab

Python이나 Go, YAML을 체크하면 해당 섹션이 아래에 나타나며, 그 생태계의 포매터가 강제하는 관례를 이미 담고 있습니다.

주요 디렉티브

스타일 가이드가 아니라 빌드를 깨뜨리는 세 가지 규칙

대부분의 .editorconfig 항목은 취향의 문제입니다. 다음 세 가지는 그렇지 않으며, 언어별 섹션을 둘 가치가 있는 이유가 바로 이것입니다:

• YAML은 들여쓰기에 탭 문자를 허용하지 않습니다. 린트 경고가 아니라 파싱 오류입니다. 프로젝트를 탭으로 들여쓰면서 GitHub Actions 워크플로나 Docker Compose 파일, Kubernetes 매니페스트를 두고 있다면, YAML 섹션이 스페이스를 다시 강제해야 합니다.
• make는 모든 레시피 줄 맨 앞에 진짜 탭 문자를 요구합니다. 스페이스를 쓰면 missing separator. Stop.이 출력되면서 빌드가 멈춥니다. [{Makefile,makefile,GNUmakefile,*.mk}]이 여러 철자를 나열하는 이유가 이것입니다. EditorConfig는 파일 이름을 대소문자를 구분해 매칭하는데, 리포지토리에는 Makefile과 makefile이 둘 다 있기 때문입니다.
• CRLF로 저장한 셸 스크립트는 실행되지 않습니다. 커널이 캐리지 리턴을 인터프리터 경로의 일부로 읽어 /bin/bash^M: bad interpreter: No such file or directory 같은 메시지를 냅니다. Windows 배치 파일에는 정반대의 문제가 있습니다. cmd.exe는 goto와 call :label을 바이트 오프셋으로 찾아가기 때문에, LF만 쓴 .bat 파일은 엉뚱한 줄로 점프하거나 아무 오류 없이 중간에 멈출 수 있습니다.

이 중 둘은 전역 블록이 고쳐 주는 문제가 아니라 오히려 전역 블록이 일으킬 수 있는 문제라서, 이 생성기가 그 상황을 지켜봅니다. 탭을 고르고 YAML 섹션을 넣지 않거나 CRLF를 고르고 셸 섹션을 넣지 않으면, 생성된 파일에 그 파일들이 한 번도 언급되지 않았더라도 결국 그 파일들을 깨뜨립니다. 생성기는 파이프라인이 실패한 뒤에야 알게 두지 않고 출력 위에서 그 사실을 알려 줍니다. utf-16 문자 인코딩도 마찬가지입니다. 프로젝트의 모든 파일에 적용되는데 make와 셸 인터프리터, Python은 그렇게 저장한 소스를 읽지 못합니다.

이 생성기가 써 주는 언어별 관례

그 표에 없는 것을 눈여겨보세요. 줄 길이입니다. PEP 8은 79자, Black은 88자, PSR-12는 권고 수준의 120자, rustfmt는 100자를 말합니다. 그중 어느 값이든 언어 섹션에 써 넣으면 프로젝트 전체에 대해 고른 제한을 조용히 덮어써 버립니다. 그래서 생성기는 max_line_length를 [*] 블록에만 남기고, 그 숫자들은 직접 판단해 적용할 수 있도록 여기에 적어 둡니다.

내 편집기가 지원하나요?

기본 지원: VS Code, JetBrains의 IntelliJ 계열, Visual Studio, Sublime Text, Xcode, Notepad++. Vim과 Emacs, Neovim을 비롯한 몇몇은 작은 플러그인이 필요합니다. 파일 형식이 평범한 INI라서 린터와 포매터도 읽을 수 있고, Prettier와 일부 랭귀지 서버가 이 파일과 보조를 맞추는 것도 그 덕분입니다.