Menggunakan Bicep linter

Bicep linter dapat digunakan untuk menganalisis file Bicep. Ini memeriksa kesalahan sintaks, dan menangkap satu set praktik terbaik penulisan yang dapat disesuaikan sebelum Anda membangun atau menyebarkan file Bicep Anda. Linter mempermudah pemberlakuan standar pengkodean dengan memberikan panduan selama pengembangan.

Memasang linter

Linter dapat digunakan dengan kode Visual Studio dan Bicep CLI. Ini memerlukan:

  • Bicep CLI, versi 0.4 atau yang lebih baru.
  • Ekstensi Bicep untuk Visual Studio Code versi 0.4 atau yang lebih baru.

Menyesuaikan linter

Dengan bicepconfig.js, Anda dapat mengaktifkan atau menonaktifkan linter, memberikan nilai-nilai khusus aturan, serta menetapkan tingkat aturan. Berikut ini adalah bicepconfig.json default:

{
  "analyzers": {
    "core": {
      "verbose": false,
      "enabled": true,
      "rules": {
        "no-hardcoded-env-urls": {
          "level": "warning",
          "disallowedhosts": [
            "management.core.windows.net",
            "gallery.azure.com",
            "management.core.windows.net",
            "management.azure.com",
            "database.windows.net",
            "core.windows.net",
            "login.microsoftonline.com",
            "graph.windows.net",
            "trafficmanager.net",
            "vault.azure.net",
            "datalake.azure.net",
            "azuredatalakestore.net",
            "azuredatalakeanalytics.net",
            "vault.azure.net",
            "api.loganalytics.io",
            "api.loganalytics.iov1",
            "asazure.windows.net",
            "region.asazure.windows.net",
            "api.loganalytics.iov1",
            "api.loganalytics.io",
            "asazure.windows.net",
            "region.asazure.windows.net",
            "batch.core.windows.net"
          ],
          "excludedhosts": [
            "schema.management.azure.com"
          ]
        }
      }
    }
  }
}

bicepconfig.json yang disesuaikan dapat ditempatkan bersama templat Anda di direktori yang sama. File konfigurasi terdekat yang menemukan pohon folder akan digunakan.

Json berikut adalah bicepconfig.json sampel:

{
  "analyzers": {
    "core": {
      "enabled": true,
      "verbose": true,
      "rules": {
        "no-hardcoded-env-urls": {
          "level": "warning"
        },
        "no-unused-params": {
          "level": "error"
        },
        "no-unused-vars": {
          "level": "error"
        },
        "prefer-interpolation": {
          "level": "warning"
        },
        "secure-parameter-default": {
          "level": "error"
        },
        "simplify-interpolation": {
          "level": "warning"
        }
      }
    }
  }
}
  • enabled: masukkan true untuk mengaktifkan linter, masukkan false untuk menonaktifkan linter.
  • verbose: masukkan true untuk menampilkan file bicepconfig.json yang digunakan oleh Visual Studio Code.
  • rules: masukkan nilai khusus aturan. Setiap aturan memiliki setidaknya satu properti, dan tingkat. Properti ini memerintahkan perilaku Bicep jika terjadi jika ditemukan dalam file Bicep.

Anda dapat menggunakan beberapa nilai untuk tingkat aturan:

tingkat Perilaku waktu-build Perilaku editor
Error Pelanggaran muncul sebagai Kesalahan dalam output build baris perintah, dan menyebabkan build gagal. Kode yang menyinggung digarisbawahi dengan garis bawah bergelombang warna merah dan muncul di tab Masalah.
Warning Pelanggaran muncul sebagai Peringatan dalam output build baris perintah, tetapi tidak menyebabkan build gagal. Kode yang menyinggung digarisbawahi dengan garis bawah bergelombang warna kuning dan muncul di tab Masalah.
Info Pelanggaran tidak muncul dalam output build baris perintah. Kode yang menyinggung digarisbawahi dengan garis bawah bergelombang warna biru dan muncul di tab Masalah.
Off Ditahan sepenuhnya. Ditahan sepenuhnya.

Set aturan linter saat ini sangat minim dan diambil dari kasus uji arm-ttk. Ekstensi Visual Studio Code dan Bicep CLI memeriksa semua aturan yang tersedia secara default dan semua aturan ditetapkan pada tingkat peringatan. Berdasarkan tingkat aturan, Anda melihat kesalahan atau peringatan atau pesan informasi dalam editor.

Ekstensi Bicep Visual Studio Code menyediakan intellisense untuk mengedit file konfigurasi Bicep:

Dukungan intellisense dalam mengkonfigurasi bicepconfig.json.

Gunakan dalam Visual Studio Code

Pasang ekstensi Bicep 0.4 atau yang lebih baru untuk menggunakan linter. Cuplikan layar berikut menampilkan linter dalam penggunaan:

Penggunaan bicep linter dalam 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:

Penggunaan bicep linter dalam Visual Studio Code - menampilkan quickfix.

Pilih bola lampu atau tautan Quick fix untuk melihat solusinya:

Penggunaan bicep linter dalam Visual Studio Code - menampilkan solusi quickfix.

Pilih solusi untuk memperbaiki masalah secara otomatis.

Gunakan dalam Bicep CLI

Pasang Bicep CLI 0.4 atau yang lebih baru untuk menggunakan linter. Cuplikan layar berikut menampilkan linter dalam penggunaan. File Bicep sama dengan yang digunakan dalam Gunakan dalam Visual Studio code.

Penggunaan bicep linter di baris perintah.

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.

Langkah berikutnya

Untuk informasi selengkapnya tentang penggunaan Visual Studio Code dan ekstensi Bicep, lihat Mulai Cepat: Membuat file Bicep dengan Visual Studio Code.