Menggunakan Bicep linter

Linter Bicep memeriksa file Bicep untuk kesalahan sintaksis dan pelanggaran praktik terbaik. Linter mempermudah pemberlakuan standar pengkodean dengan memberikan panduan selama pengembangan. Anda dapat menyesuaikan praktik terbaik untuk digunakan dalam memeriksa file.

Persyaratan Linter

Linter diintegrasikan ke dalam Bicep CLI dan ekstensi Bicep untuk Visual Studio Code. Untuk menggunakannya, Anda harus memiliki versi 0.4 atau yang lebih baru.

Aturan default

Kumpulan aturan linter default minimal dan diambil dari kasus uji arm-ttk. Ekstensi dan Bicep CLI memeriksa aturan berikut, yang ditetapkan ke tingkat peringatan.

• adminusername-should-not-be-literal
• artifacts-parameters
• decompiler-cleanup
• explicit-values-for-loc-params
• max-asserts
• max-outputs
• max-params
• max-resources
• max-variables
• nested-deployment-template-scoping
• no-conflicting-metadata
• no-deployments-resources
• no-hardcoded-env-urls
• no-hardcoded-location
• no-loc-expr-outside-params
• no-unnecessary-dependson
• no-unused-existing-resources
• no-unused-params
• no-unused-vars
• outputs-should-not-contain-secrets
• prefer-interpolation
• prefer-unquoted-property-names
• secure-parameter-default
• secure-params-in-nested-deploy
• secure-secrets-in-params
• simplify-interpolation
• simplify-json-null
• use-parent-property
• use-protectedsettings-for-commandtoexecute-secrets
• use-recent-api-versions
• use-resource-id-functions
• use-resource-symbol-reference
• use-secure-value-for-secure-inputs
• use-stable-resource-identifiers
• use-stable-vm-image

Anda dapat menyesuaikan bagaimana aturan linter diterapkan. Untuk menimpa pengaturan default, tambahkan file bicepconfig.json dan terapkan pengaturan kustom. Untuk informasi selengkapnya tentang menerapkan pengaturan tersebut, lihat Menambahkan pengaturan kustom di file konfigurasi Bicep.

Penggunaan di Visual Studio Code

Cuplikan layar berikut menunjukkan linter di Visual Studio Code:

Di panel MASALAH, terdapat empat kesalahan, satu peringatan, dan satu pesan info yang ditampilkan dalam cuplikan layar. Pesan info menunjukkan file konfigurasi Bicep yang digunakan. Ini hanya menampilkan sekilas informasi saat Anda menetapkan verbose ke true di file konfigurasi.

Arahkan kursor mouse Anda ke salah satu area masalah. Linter memberikan rincian tentang kesalahan atau peringatan. Klik area, ini juga menampilkan bola lampu biru:

Pilih bola lampu atau tautan Quick fix untuk melihat solusinya:

Pilih solusi untuk memperbaiki masalah secara otomatis.

Gunakan dalam Bicep CLI

Cuplikan layar berikut menunjukkan linter di baris perintah. Output dari perintah lint dan perintah build menunjukkan pelanggaran aturan apa pun.

Anda dapat mengintegrasikan pemeriksaan ini sebagai bagian dari alur CI/CD Anda. Anda dapat menggunakan tindakan GitHub untuk mencoba membangun bicep. Kesalahan akan menggagalkan alur.

Membisukan positif palsu

Terkadang sebuah aturan dapat memiliki hasil positif yang salah. Misalnya, Anda mungkin perlu menyertakan tautan ke penyimpanan blob secara langsung tanpa menggunakan fungsi environment(). Dalam hal ini Anda dapat menonaktifkan peringatan untuk satu baris saja, bukan seluruh dokumen, dengan menambahkan #disable-next-line <rule name> sebelum baris dengan peringatan tersebut.

#disable-next-line no-hardcoded-env-urls //Direct download link to my toolset
scriptDownloadUrl: 'https://mytools.blob.core.windows.net/...'

Sebaiknya tambahkan komentar yang menjelaskan mengapa aturan tidak berlaku untuk baris ini.

Jika Anda ingin menekan aturan linter, Anda dapat mengubah tingkat aturan menjadi Off di bicepconfig.json. Misalnya, dalam contoh berikut, aturan ditekan no-deployments-reesources :

{
  "analyzers": {
    "core": {
      "rules": {
        "no-deployments-resources": {
          "level": "off"
        }
      }
    }
  }
}

Langkah berikutnya

• Untuk informasi selengkapnya tentang menerapkan pengaturan linter tersebut, lihat Menambahkan pengaturan kustom di file konfigurasi Bicep.
• Untuk informasi selengkapnya tentang penggunaan Visual Studio Code dan ekstensi Bicep, lihat Mulai Cepat: Membuat file Bicep dengan Visual Studio Code.