10분 이내에 Visual Studio에서 EditorConfig

소개: EditorConfig가 중요한 이유

팀은 EditorConfig 프로젝트를 소개하며, 프로젝트별 설정을 이제 그 어느 때보다 쉽게 ​​구현할 수 있다고 설명합니다. 이제 Visual Studio에 저장된 개인 설정이나 편집기 설정에 의존하는 대신, 모든 참여자가 일관된 코딩 스타일을 유지하도록 프로젝트를 구성할 수 있습니다.

프로젝트 생성

EditorConfig 파일의 기능을 보여주기 위해 Tim은 Visual Studio에서 새로운 Blazor Server 프로젝트를 생성합니다. 그는 해당 앱의 이름을 BlazorDemoApp으로 지정하고 기본 설정을 사용합니다. 이 간단한 .NET 프로젝트는 EditorConfig 설정을 구성하고 적용하는 테스트 환경으로 사용됩니다.

팀이 설명했듯이, 이 프로젝트는 복잡한 논리나 기능이 필요하지 않습니다. 코드 스타일 규칙을 다루는 데 있어 편리한 예시일 뿐입니다.

프로젝트 선호도 및 코딩 스타일 이해하기

여기서 Tim은 프로젝트 수준 구성이 중요한 이유에 대해 설명합니다. Visual Studio에서는 각 사용자가 다음과 같은 사항에 대한 기본 설정을 지정할 수 있습니다.

• 탭을 사용할지, 공백을 사용할지 여부

• 들여쓰기 크기 (예: 3칸 또는 4칸)

중괄호 {}의 위치 (같은 줄 또는 새 줄)

• 네임스페이스 선언 유형(블록 범위 또는 파일 범위)

이러한 기본 설정은 일반적으로 Visual Studio에서 프로젝트별이 아닌 사용자별로 저장됩니다. 팀은 팀으로 일할 때 구성원 각자의 지역적 환경이 다를 수 있다는 점을 강조합니다. 이로 인해 코드 형식이 일관되지 않고, 버전 관리 시스템에서 불필요한 차이점이 발생하며, 설정을 수동으로 조정하는 데 시간이 낭비될 수 있습니다.

바로 이런 점에서 EditorConfig 파일 형식이 도움이 됩니다. 이 형식은 모든 개발자의 에디터가 자동으로 준수할 수 있는 공통된 EditorConfig 속성 세트를 정의합니다.

EditorConfig 파일 생성 및 열기

Tim은 솔루션에 새 EditorConfig 파일을 추가하는 방법을 보여줍니다.

그는 솔루션을 마우스 오른쪽 버튼으로 클릭하고 추가 → 새 EditorConfig를 선택합니다. Visual Studio에서 파일을 처음 로드할 때 작은 오류가 발생할 수 있지만, Tim은 이는 무해한 오류이므로 파일을 닫았다가 다시 열면 된다고 설명합니다.

이 새 파일은 일반적으로 .editorconfig라는 이름으로 저장되며, Visual Studio는 이를 구성 문서로 즉시 인식합니다. 참고로, Visual Studio는 이 파일을 기본적으로 지원하며, Visual Studio Code나 Sublime Text와 같은 다른 텍스트 편집기들도 텍스트 편집기 플러그인을 통해 지원합니다.

Tim은 EditorConfig가 마이크로소프트 전용 도구가 아니라고 명확히 밝혔습니다. 이는 업계 전반의 표준으로, 다양한 편집자들이 동일한 코딩 규칙을 이해하고 적용하여 여러 환경에서 일관된 형식을 유지할 수 있도록 도와줍니다.

EditorConfig 파일 설정 구성

Tim은 EditorConfig 파일이 열리면 현재 Visual Studio 구성에서 기본 설정을 가져온다고 설명합니다. 하지만 필요에 따라 이러한 사항들을 수정할 수 있습니다.

그는 공백 섹션으로 이동하여 설정 방법을 보여줍니다.

• 공백 대신 탭을 사용하세요

• 탭 너비 = 3

다음은 코드 서식 지정 동작 방식을 정의하는 EditorConfig 속성의 예입니다. 이 구성은 저장되면 솔루션 전체에 적용되지만 솔루션 외부에는 적용되지 않습니다.

Tim은 이 EditorConfig 파일을 Git과 같은 버전 관리 시스템에 추가하여 저장소를 복제하는 모든 개발자가 동일한 규칙을 상속받도록 할 수 있다고 언급합니다. 이렇게 하면 누가 코드를 작성하든 일관된 형식을 유지할 수 있습니다.

코드 스타일 및 네임스페이스 규칙 작업

이어서 Tim은 코드 스타일 설정, 특히 네임스페이스 선언 스타일에 대해 자세히 살펴봅니다.

기본적으로 C#은 중괄호로 네임스페이스를 정의하는 블록 범위 네임스페이스를 사용합니다. Tim은 이 형식을 보여주기 위해 Data 폴더 아래에 클래스를 만듭니다.

그런 다음 그는 EditorConfig 파일 설정을 파일 범위 네임스페이스를 사용하도록 변경합니다. 그가 새 클래스를 추가하면 Visual Studio는 자동으로 업데이트된 스타일을 적용하여 네임스페이스를 중괄호 대신 세미콜론(;)으로 표시합니다.

이는 EditorConfig 설정이 Visual Studio의 기본 코드 생성 템플릿에 어떤 영향을 미치는지, 그리고 정의된 프로젝트 규칙에 따라 자동으로 어떻게 정렬되는지를 보여줍니다.

Tim은 또한 코드 정리 기능을 사용하여 기존 파일의 형식을 다시 지정함으로써 모든 코드가 최신 EditorConfig 규칙을 준수하도록 할 수 있다고 지적합니다.

엄격도 설정 및 규칙 시행

이 섹션에서 Tim은 EditorConfig 파일의 심각도 수준을 사용하여 규칙 적용을 제어하는 ​​방법에 중점을 둡니다.

각 규칙은 없음, 제안, 경고 또는 오류와 같은 값을 가질 수 있습니다. Tim은 네임스페이스 규칙의 심각도를 오류로 설정했고, 그러자 Visual Studio는 선호하는 형식과 일치하지 않는 모든 파일을 오류 목록 창에 즉시 표시했습니다.

이를 통해 개발자는 정의된 스타일을 준수하고 현재 파일이나 전체 프로젝트에서 원치 않는 스타일 변경을 방지할 수 있습니다.

일부 불일치나 Visual Studio 버그(예: 잘못된 제안 메시지)가 나타날 수 있지만, Tim은 이러한 문제들이 시간이 지남에 따라 개선될 것이라고 언급합니다. 중요한 것은 규칙이 일관되게 적용되어 코드가 읽기 쉽고 통일성을 갖게 된다는 점입니다.

여러 개의 EditorConfig 파일 및 디렉터리 범위

Tim은 하나의 솔루션에 여러 개의 EditorConfig 파일을 가질 수 있다고 설명합니다.

예를 들어:

• 솔루션 수준의 루트 EditorConfig 파일은 모든 프로젝트에 대한 일반 설정을 정의합니다.

• /Data와 같은 하위 폴더에 있는 중첩된 EditorConfig 파일은 일부 속성(예: 명명 규칙, 탭 너비 또는 줄 바꿈)을 재정의할 수 있습니다.

각 EditorConfig 프로젝트는 계층적으로 동작합니다. 즉, 명시적으로 재정의하지 않는 한 하위 디렉터리의 파일은 상위 디렉터리의 설정을 상속합니다.

설정의 루트를 정의하려면 최상위 파일에서 root = true 속성을 설정하면 됩니다. 이렇게 하면 에디터가 상위 디렉터리에서 추가 EditorConfig 파일을 검색하지 않도록 지시합니다.

이 구조는 개발자에게 프로젝트 수준의 서식 규칙을 세밀하게 제어할 수 있는 권한을 제공하는 동시에, 다른 서식이 필요한 특수한 경우도 허용합니다.

결론: EditorConfig를 통한 일관성 확보

마지막으로 Tim은 개발자들이 .NET 프로젝트에서 EditorConfig를 적극적으로 활용할 것을 권장했습니다.

그는 이러한 접근 방식을 통해 팀이 개인 편집기 설정을 변경할 필요 없이 일관된 서식 규칙, 명명 규칙 및 레이아웃 스타일을 유지할 수 있다고 강조합니다. 열린 각 파일은 프로젝트의 .editorconfig 파일에 설정된 스타일을 자동으로 따릅니다.

이러한 EditorConfig 파일을 버전 관리 시스템에 커밋함으로써 팀은 사용하는 편집기나 환경에 관계없이 모든 사람이 동일한 코드 형식 지정 규칙을 준수하도록 보장할 수 있습니다.

팀은 영상 말미 에서 EditorConfig 파일 형식이 간단하고 유연하며 널리 지원된다는 점을 강조합니다. Visual Studio, Visual Studio Code 또는 다른 텍스트 편집기를 사용하든 상관없이, 이 기능은 일관된 코딩 스타일을 유지하고 프로젝트를 깔끔하고 전문적이며 읽기 쉽게 만드는 데 매우 유용합니다.