#EditorConfig 활용법

install editorconfig first

[2023-09-16 Sat 18:05] https://editorconfig.org/

툴을 설치한다.

sudo apt-get install editorconfig

[SYS]: You are a helpful assistant. Please write in Korean language. @user editorconfig에 대해서 알려줘

@assistant EditorConfig는 여러 코드 편집기와 IDE에서 일관된 코딩 스타일을 유지할 수 있도록 도와주는 도구입니다. 이 도구는 프로젝트마다 다른 스타일 규칙을 정의하고, 이를 코드 편집기가 자동으로 적용할 수 있게 합니다.

EditorConfig 파일(`.editorconfig`)은 프로젝트 루트 디렉토리에 위치하며, 파일의 포맷은 INI 형식으로 작성됩니다. 이 파일에는 여러 가지 설정 옵션을 포함할 수 있습니다. 예를 들어, 들여쓰기 방식, 문자 인코딩, 줄 끝 스타일 등을 정의할 수 있습니다.

다음은 일반적인 `.editorconfig` 파일의 예입니다:

```ini 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 ```

이 예제의 설명은 다음과 같습니다:

• `root = true`: 이 설정은 해당 `.editorconfig` 파일이 최상위 수준(root level) 파일임을 의미합니다. 이 파일보다 상위 디렉토리에 있는 다른 `.editorconfig` 파일을 무시합니다.
• `[*]`: 모든 파일에 적용되는 설정을 의미합니다.
  • `indent_style = space`: 들여쓰기를 공백으로 합니다.
  • `indent_size = 4`: 들여쓰기 크기를 4로 설정합니다.
  • `end_of_line = lf`: 줄 끝 스타일을 LF(Line Feed)로 설정합니다.
  • `charset = utf-8`: 파일의 문자 인코딩을 UTF-8로 설정합니다.
  • `trim_trailing_whitespace = true`: 줄 끝의 공백을 제거합니다.
  • `insert_final_newline = true`: 파일 끝에 새 줄을 하나 추가합니다.
• `[*.md]`: 마크다운 파일 (*.md)에만 적용되는 설정을 의미합니다.
  • `trim_trailing_whitespace = false`: 마크다운 파일의 경우, 줄 끝의 공백을 제거하지 않습니다.

이렇게 `.editorconfig` 파일을 설정하면, 다양한 편집기와 IDE에서 자동으로 일관된 코딩 스타일을 적용하여 작업할 수 있습니다. EditorConfig는 Visual Studio Code, IntelliJ IDEA와 같은 많은 인기 있는 편집기에서도 플러그인 형태로 지원됩니다.

@user

Related-Notes

BIBLIOGRAPHY