Mac용 Visual Studio 사용자 지정 EditorConfig 파일 만들기 및 편집

아티클
09/03/2023

Important

Mac용 Visual Studio Microsoft 에 따라 2024년 8월 31일에 사용 중지될 예정입니다. 최신 수명 주기 정책입니다. Mac용 Visual Studio 계속 사용할 수 있지만 Mac의 개발자를 위한 몇 가지 다른 옵션(예: VS Code용 새 C# Dev Kit 확장의 미리 보기 버전)이 있습니다.

지원 타임라인 및 대안에 대해 자세히 알아봅니다.

Mac용 Visual Studio에서는 프로젝트 또는 솔루션에 EditorConfig 파일을 추가하여 코드베이스에서 작업하는 모든 사람들의 코딩 스타일을 일관적으로 유지할 수 있습니다. EditorConfig 파일에 선언된 설정은 글로벌 Mac용 Visual Studio 텍스트 편집기 설정에 우선합니다. 프로젝트 또는 코드베이스 내에서 EditorConfig 파일을 사용하여 프로젝트의 코딩 스타일, 기본 설정 및 경고를 지정할 수 있습니다. 파일은 코드베이스의 일부이기 때문에 사용하는 IDE 또는 코드 편집기에 관계없이 모든 사용자가 프로젝트의 코딩 방법을 쉽게 준수할 수 있습니다.

EditorConfig 파일은 Visual Studio를 비롯한 여러 IDE 및 코드 편집기에서 지원됩니다.

지원되는 설정

Mac용 Visual Studio의 편집기는 다음과 같은 EditorConfig 속성의 핵심 집합을 지원합니다.

indent_style
indent_size
tab_width
end_of_line
charset
trim_trailing_whitespace
insert_final_newline
root

EditorConfig는 C#에서 코딩 규칙도 지원합니다.

프로젝트에 EditorConfig 파일 추가

새 EditorConfig 파일 추가

Mac용 Visual Studio에서 프로젝트를 엽니다. EditorConfig 파일을 추가할 솔루션 또는 프로젝트 노드를 선택합니다. 솔루션 디렉터리에 파일을 추가하면 솔루션의 모든 프로젝트에 .editorconfig 설정이 적용됩니다.
노드를 마우스 오른쪽 단추로 클릭하고 추가 > 새 파일을 선택하여 새 파일 대화 상자를 엽니다.
기타 > 빈 텍스트 파일을 선택하고 이름.editorconfig을 지정합니다. 새로 만들기를 눌러 파일을 만들고 편집기에서 엽니다.

솔루션 수준에서 항목을 추가하면 해당 항목이 자동으로 생성되고 솔루션 항목 폴더에 중첩됩니다.

파일을 편집합니다. 예시:

# This file is the top-most EditorConfig file
root = true

# All Files
[*]
indent_style = space
indent_size = 8
insert_final_newline = false
trim_trailing_whitespace = false

[*.cs]
csharp_new_line_before_open_brace = none

.editorconfig 파일의 설정은 작성하는 모든 새 코드에 적용되지만 기존 코드를 새 설정과 일치하도록 다시 포맷해야 할 수 있습니다. .editorconfig 파일의 설정을 기존 원본 파일에 적용하려면 파일을 열고 메뉴 모음에서 편집 > 서식 > 문서 서식을 선택합니다.

기존 EditorConfig 파일 추가

.editorconfig 파일이 이미 포함된 프로젝트 또는 솔루션으로 작업 중인 경우 설정을 적용하기 위해 해야 할 일이 없습니다. 새로운 코드 줄은 EditorConfig 설정에 따라 서식이 지정됩니다.

기존의 .editorconfig 파일을 프로젝트에서 재사용하는 것이 좋습니다. 기존 파일을 추가하려면 다음을 수행합니다.

기존 파일을 추가하려는 폴더를 마우스 오른쪽 단추로 클릭하고 추가 > 파일 추가를 선택합니다.
필요한 파일의 디렉터리로 이동합니다.
.(예: .editorconfig)로 시작하는 파일은 macOS의 숨겨진 파일이므로 Command + Shift +.를 눌러 .editorconfig 파일이 표시되도록 합니다.
.editorconfig 파일을 선택하고 열기를 클릭합니다.
다음 대화 상자가 표시되면 디렉터리에 파일 복사 옵션을 선택하고 확인을 선택합니다.

.editorconfig 설정 반영

EditorConfig 파일을 코드베이스에 추가하면 추가된 모든 새 코드가 지정된 설정에 따라 자동으로 포맷됩니다. 코드베이스를 포맷하지 않으면 기존 코드는 자동으로 설정을 반영하지 않습니다.

.editorconfig 파일의 설정을 반영하려면 솔루션 노드를 선택하고 메뉴 모음에서 편집 > 서식 > 문서 서식을 선택합니다.

Format document from the menu bar

EditorConfig 파일 편집

EditorConfig 파일은 직관적인 파일 레이아웃을 사용하여 설정을 지정합니다. 이전 예를 사용한 이에 대한 설명이 아래에 나와 있습니다.

# This file is the top-most EditorConfig file
root = true

# All Files
[*]
indent_style = space
indent_size = 4
insert_final_newline = false
trim_trailing_whitespace = false

[*.cs]
csharp_new_line_before_open_brace = none

root를 true로 설정하면 EditorConfig 설정 재정의 섹션에 설명된 대로 이 파일을 코드베이스의 최상위 파일 플래그로 지정하고, 프로젝트의 모든 상위 .editorconfig 파일을 무시합니다.

각 섹션은 꺾쇠 괄호([ ])로 표시되며, 다음 속성과 관련된 파일 형식에 대한 정보를 나타냅니다.

위의 예에서 일부 설정은 프로젝트의 모든 파일에 적용되며, 다른 설정은 C# 파일에만 추가됩니다. 아래 스크린샷은 .editorconfig 설정 적용 전후를 보여줍니다.

이전:

Before editorconfig settings have been applied

이후:

after editorconfig settings have been applied

사용 가능한 EditorConfig 설정에 대한 자세한 내용은 EditorConfig에 대한 .NET 코딩 규칙 설정 아티클과 공식 문서의 지원되는 속성 섹션을 참조하세요.

EditorConfig 설정 재정의

각 솔루션에는 .editorconfig 파일이 여러 개 있을 수 있습니다. Mac용 visual Studio는 .editorconfig 파일을 솔루션의 위쪽에서 아래쪽으로 읽으며 진행 중인 설정을 추가하고 재정의합니다. 즉, 편집 중인 파일에 가장 가까운.editorconfig의 설정이 우선합니다. 설정은 .editorconfig 파일에서 동일한 폴더(있는 경우)로 가져온 다음, 부모 폴더의 .editorconfig(있는 경우) 등에서 가져옵니다. 찾을 때까지 root=true입니다.

모든 상위 수준 .editorconfig 파일에서 이 코드베이스 부분에 적용된 설정이 없음을 확인하려면 root=true 속성을 하위 수준 .editorconfig 파일의 최상위에 추가합니다.

# top-most EditorConfig file
root = true

참고 항목

EditorConfig를 사용하여 사용자 지정 편집기 설정 만들기(Windows의 Visual Studio)