다음을 통해 공유

dotnet format

  • 아티클

이 문서의 적용 대상: ✔️ .NET 6.x SDK 이상 버전

이름

dotnet format - editorconfig 설정과 일치하도록 코드의 서식을 지정합니다.

개요

dotnet format [<PROJECT | SOLUTION>] [command] [options]

dotnet format -h|--help

설명

dotnet format 는 프로젝트 또는 솔루션에 스타일 기본 설정 및 정적 분석 권장 사항을 적용하는 코드 포맷터입니다. 기본 설정은 .editorconfig 파일(있는 경우)에서 읽습니다. 그렇지 않으면 기본 설정의 기본값 집합이 사용됩니다. 자세한 내용은 EditorConfig 설명서를 참조하세요.

인수

PROJECT | SOLUTION

코드 서식 지정을 실행할 MSBuild 프로젝트 또는 솔루션입니다. 프로젝트 또는 솔루션 파일을 지정하지 않으면 MSBuild는 현재 작업 디렉터리에서 proj 또는 sln으로 끝나는 파일 확장명이 있는 파일을 검색하고 해당 파일을 사용합니다.

옵션

dotnet format 명령이 성공하는 데는 아래 옵션이 필요하지 않지만, 이 옵션을 사용하여 서식 지정 대상과 사용되는 규칙을 추가로 사용자 지정할 수 있습니다.

  • --diagnostics <DIAGNOSTICS>

    코드 스타일 또는 타사 문제를 수정할 때 필터로 사용할 진단 ID의 공백으로 구분된 목록입니다. 기본값은 .editorconfig 파일에 나열되는 ID입니다. 지정할 수 있는 기본 제공 분석기 규칙 ID 목록은 코드 분석 스타일 규칙에 대한 ID 목록을 참조하세요.

  • --severity

    수정할 진단의 최소 심각도입니다. 허용되는 값은 info, warn 및 error입니다. 기본값은 warn입니다.

  • --no-restore

    서식 지정 전에 암시적 복원을 실행하지 않습니다. 기본값은 암시적 복원을 수행하는 것입니다.

  • --verify-no-changes

    서식 변경이 수행되지 않는지 확인합니다. 파일 서식이 지정되었다면 0이 아닌 종료 코드를 사용하여 종료합니다.

  • --include <INCLUDE>

    서식 지정에 포함할 상대 파일 또는 폴더 경로의 공백으로 구분된 목록입니다. 기본값은 솔루션 또는 프로젝트의 모든 파일입니다.

  • --exclude <EXCLUDE>

    서식 지정에서 제외할 상대 파일 또는 폴더 경로의 공백으로 구분된 목록입니다. 기본값은 none입니다.

  • --include-generated

    SDK에서 생성된 파일의 서식을 지정합니다.

  • -v|--verbosity <LEVEL>

    자세한 표시 수준을 설정합니다. 허용되는 값은 q[uiet], m[inimal], n[ormal], d[etailed], diag[nostic]입니다. 기본값은 m[inimal]여야 합니다.

  • --binarylog <BINARY-LOG-PATH>

    모든 프로젝트 또는 솔루션 로드 정보를 이진 로그 파일에 기록합니다.

  • --report <REPORT-PATH>

    <REPORT_PATH>에서 지정한 디렉터리에 JSON 보고서를 생성합니다.

  • -h|--help

    도움말 및 사용 정보를 표시합니다.

하위 명령

공백

dotnet format whitespace - editorconfig공백 설정과 일치하도록 코드의 서식을 지정합니다.

설명

dotnet format whitespace 하위 명령은 공백 서식 지정과 관련된 서식 규칙만 실행합니다. .editorconfig 파일에서 지정할 수 있는 서식 지정 옵션의 전체 목록은 C# 서식 지정 옵션을 참조하세요.

옵션

  • --folder

    <PROJECT | SOLUTION> 인수를 코드 파일의 단순 폴더에 대한 경로로 처리합니다.

스타일

dotnet format style - 코드 스타일에 대한 EditorConfig 설정과 일치하도록 코드의 서식을 지정합니다.

설명

dotnet format style 하위 명령은 코드 스타일 서식 지정과 관련된 서식 규칙만 실행합니다. editorconfig 파일에서 지정할 수 있는 서식 지정 옵션의 전체 목록은 코드 스타일 규칙을 참조하세요.

옵션

  • --diagnostics <DIAGNOSTICS>

    코드 스타일 문제를 해결할 때 필터로 사용할 진단 ID의 공백으로 구분된 목록입니다. 기본값은 .editorconfig 파일에 나열되는 ID입니다. 지정할 수 있는 기본 제공 코드 스타일 분석기 규칙 ID 목록은 코드 분석 스타일 규칙에 대한 ID 목록을 참조하세요.

  • --severity

    수정할 진단의 최소 심각도입니다. 허용되는 값은 info, warn 및 error입니다. 기본값은 warn입니다.

분석기

dotnet format analyzers - 분석기의 설정과 일치 editorconfig 하도록 코드 서식을 지정합니다(코드 스타일 규칙 제외).

설명

dotnet format analyzers 하위 명령은 분석기와 연결된 서식 규칙만 실행합니다. 파일에서 지정할 수 있는 분석기 규칙 목록은 품질 규칙을 참조하세요editorconfig.

옵션

  • --diagnostics <DIAGNOSTICS>

    비 코드 스타일 문제를 해결할 때 필터로 사용할 진단 ID의 공백으로 구분된 목록입니다. 기본값은 .editorconfig 파일에 나열되는 ID입니다. 지정할 수 있는 기본 제공 분석기 규칙 ID 목록은 품질 규칙에 대한 ID 목록을 참조하세요. 타사 분석기의 경우 해당 설명서를 참조하세요.

  • --severity

    수정할 진단의 최소 심각도입니다. 허용되는 값은 info, warn 및 error입니다. 기본값은 warn입니다.

예제

  • 솔루션의 모든 코드 서식 지정:

    dotnet format ./solution.sln

  • 애플리케이션 프로젝트의 모든 코드를 정리합니다.

    dotnet format ./src/application.csproj

  • 모든 코드의 서식이 올바르게 지정되었는지 확인합니다.

    dotnet format --verify-no-changes

  • src/submodule-a가 아닌 src 및 tests 디렉터리의 모든 코드를 정리합니다.

    dotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/

  • 특정 코드 스타일 문제를 해결합니다.

    dotnet format style --diagnostics IDE0005 --severity info

  • 심각도가 있는 모든 코드 스타일 문제를 해결하거나 error다음을 수행합니다infowarning.

    dotnet format style --severity info

  • 특정(비 코드 스타일) 분석기 문제를 해결합니다.

    dotnet format analyzers --diagnostics CA1831 --severity warn

  • 심각도가 있는 코드 스타일이 아닌 모든 문제를 해결하거나 error다음을 수행합니다.infowarning

    dotnet format analyzers --severity info