format dotnet

Artikel ini berlaku untuk: ✔️ .NET 6 SDK dan versi yang lebih baru

Nama

dotnet format - Memformat kode untuk mencocokkan editorconfig pengaturan.

Sinopsis

dotnet format [<PROJECT | SOLUTION>]
  [--binarylog <BINARY-LOG-PATH>] [--diagnostics <DIAGNOSTICS>]
  [--exclude <EXCLUDE>] [--exclude-diagnostics <EXCLUDE-DIAGNOSTICS>]
  [--include <INCLUDE>] [--include-generated]
  [--no-restore] [--report <REPORT-PATH>] [--severity <LEVEL>]
  [-v|--verbosity <LEVEL>] [--verify-no-changes] [--version]

dotnet format -h|--help

Deskripsi

dotnet format adalah pemformat kode yang menerapkan preferensi gaya dan rekomendasi analisis statis ke proyek atau solusi. Preferensi akan dibaca dari file .editorconfig , jika ada, jika tidak, sekumpulan preferensi default akan digunakan. Untuk informasi selengkapnya, lihat dokumentasi EditorConfig.

Argumen

PROJECT | SOLUTION

Proyek atau solusi MSBuild untuk menjalankan pemformatan kode. Jika file proyek atau solusi tidak ditentukan, MSBuild mencari direktori kerja saat ini untuk file yang memiliki ekstensi file yang berakhiran proj atau sln, dan menggunakan file tersebut.

Perhatian

format dotnet dapat memulihkan, mengkompilasi, dan menjalankan penganalisis dari proyek atau solusi yang ditentukan. Hanya panggil alat terhadap kode tepercaya.

Opsi

Tidak ada opsi di bawah ini yang diperlukan agar dotnet format perintah berhasil, tetapi Anda dapat menggunakannya untuk menyesuaikan lebih lanjut apa yang diformat dan oleh aturan mana.

• --binarylog <BINARY-LOG-PATH>

  Mencatat semua informasi beban proyek atau solusi ke file log biner.

• --diagnostics <DIAGNOSTICS>

  Daftar ID diagnostik yang dipisahkan spasi untuk digunakan sebagai filter saat memperbaiki gaya kode atau masalah pihak ketiga. Nilai default adalah ID mana pun yang tercantum dalam file .editorconfig . Untuk daftar ID aturan penganalisis bawaan yang dapat Anda tentukan, lihat daftar ID untuk aturan gaya analisis kode.

• --exclude <EXCLUDE>

  Daftar jalur file atau folder relatif yang dipisahkan spasi untuk dikecualikan dari pemformatan. Defaultnya adalah tidak ada.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  Daftar ID diagnostik yang dipisahkan spasi untuk dikecualikan saat memperbaiki gaya kode atau masalah pihak ketiga. Nilai default tidak ada. Untuk daftar ID aturan penganalisis bawaan yang dapat Anda tentukan, lihat daftar ID untuk aturan gaya analisis kode.

• --include <INCLUDE>

  Daftar jalur file atau folder relatif yang dipisahkan spasi untuk disertakan dalam pemformatan. Defaultnya adalah semua file dalam solusi atau proyek.

• --include-generated

  Memformat file yang dihasilkan oleh SDK.

• --no-restore

  Tidak menjalankan pemulihan implisit sebelum memformat. Defaultnya adalah melakukan pemulihan implisit.

• --report <REPORT-PATH>

  Menghasilkan laporan JSON dalam direktori yang ditentukan oleh <REPORT_PATH>.

• --severity <LEVEL>

  Tingkat keparahan minimum diagnostik untuk diperbaiki. Nilai yang diizinkan adalah info, warn, dan error. Nilai defaultnya adalah warn.

• --verify-no-changes

  Memverifikasi bahwa tidak ada perubahan pemformatan yang akan dilakukan. Dihentikan dengan kode keluar bukan nol jika ada file yang akan diformat.

• --version

  Menampilkan informasi versi.

• -v|--verbosity <LEVEL>

  Mengatur tingkat verbositas perintah. Nilai yang diizinkan adalah q[uiet], m[inimal], n[ormal], d[etailed], dan diag[nostic]. Untuk informasi selengkapnya, lihat LoggerVerbosity .

• -?|-h|--help

  Mencetak deskripsi cara menggunakan perintah.

Subperintah

Whitespace

dotnet format whitespace - Memformat kode untuk mencocokkan editorconfig pengaturan untuk spasi kosong.

Deskripsi

dotnet format whitespace Subperintah hanya menjalankan aturan pemformatan yang terkait dengan pemformatan spasi kosong. Untuk daftar lengkap opsi pemformatan yang mungkin dapat Anda tentukan dalam file .editorconfig Anda, lihat opsi pemformatan C#.

Opsi

• --folder

  <PROJECT | SOLUTION> Perlakukan argumen sebagai jalur ke folder sederhana file kode.

Gaya

dotnet format style - Format kode untuk mencocokkan pengaturan EditorConfig untuk gaya kode.

Deskripsi

dotnet format style Subperintah hanya menjalankan aturan pemformatan yang terkait dengan pemformatan gaya kode. Untuk daftar lengkap opsi pemformatan yang bisa Anda tentukan dalam file Anda editorconfig , lihat Aturan gaya kode.

Opsi

• --diagnostics <DIAGNOSTICS>

  Daftar ID diagnostik yang dipisahkan spasi untuk digunakan sebagai filter saat memperbaiki masalah gaya kode. Nilai default adalah ID mana pun yang tercantum dalam file .editorconfig . Untuk daftar ID aturan penganalisis gaya kode bawaan yang dapat Anda tentukan, lihat daftar ID untuk aturan gaya analisis kode.

• --severity <LEVEL>

  Tingkat keparahan minimum diagnostik untuk diperbaiki. Nilai yang diizinkan adalah info, warn, dan error. Nilai defaultnya adalah warn

Penganalisis

dotnet format analyzers - Memformat kode untuk mencocokkan editorconfig pengaturan untuk penganalisis (tidak termasuk aturan gaya kode).

Deskripsi

dotnet format analyzers Subperintah hanya menjalankan aturan pemformatan yang terkait dengan penganalisis. Untuk daftar aturan penganalisis yang dapat Anda tentukan dalam file Anda editorconfig , lihat Aturan kualitas.

Opsi

• --diagnostics <DIAGNOSTICS>

  Daftar ID diagnostik yang dipisahkan spasi untuk digunakan sebagai filter saat memperbaiki masalah gaya non-kode. Nilai default adalah ID mana pun yang tercantum dalam file .editorconfig . Untuk daftar ID aturan penganalisis bawaan yang dapat Anda tentukan, lihat daftar ID untuk aturan kualitas. Untuk penganalisis pihak ketiga, lihat dokumentasi mereka.

• --severity <LEVEL>

  Tingkat keparahan minimum diagnostik untuk diperbaiki. Nilai yang diizinkan adalah info, warn, dan error. Nilai defaultnya adalah warn.

Contoh

• Format semua kode dalam solusi:

  dotnet format ./solution.sln
  

• Bersihkan semua kode dalam proyek aplikasi:

  dotnet format ./src/application.csproj
  

• Verifikasi bahwa semua kode diformat dengan benar:

  dotnet format --verify-no-changes
  

• Bersihkan semua kode di direktori src dan uji tetapi tidak di src/submodule-a:

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

• Perbaiki masalah gaya kode tertentu:

  dotnet format style --diagnostics IDE0005 --severity info
  

• Perbaiki semua masalah gaya kode yang memiliki tingkat keparahan info, warning atau error:

  dotnet format style --severity info
  

• Perbaiki masalah penganalisis (bukan gaya kode) tertentu:

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Perbaiki semua masalah gaya non-kode yang memiliki tingkat keparahan info, warning atau error:

  dotnet format analyzers --severity info