Bicep リンターは、Bicep ファイルに構文エラーとベスト プラクティス違反がないかチェックします。 リンターを使用すると、開発時のガイダンスが提供され、コーディング標準を適用できます。 ファイルのチェックに使用するベスト プラクティスをカスタマイズできます。
リンターの要件
リンターは、Bicep CLI と、Visual Studio Code 用の Bicep 拡張機能に統合されています。 これを使用するには、 Bicep CLI バージョン 0.4 以降が必要です。
既定のルール
既定のリンター ルールのセットは最小限であり、arm-ttk テスト ケースから取得されます。 拡張機能と Bicep CLI では、警告レベルに設定されている次のルールがチェックされます。
すべてのリンター ルールを有効または無効にし、構成ファイルを使用して適用方法を制御できます。 既定の動作をオーバーライドするには、カスタム設定で bicepconfig.json ファイルを作成します。 これらの設定の適用方法の詳細については、「Bicep 構成ファイルにカスタム設定を追加する」を参照してください。
Visual Studio Code での使用
次のスクリーンショットは、Visual Studio Code でのリンターを示しています。
[ 問題 ] ウィンドウのスクリーンショットには、4 つのエラー、1 つの警告、1 つの情報メッセージが表示されます。 情報メッセージには、使用されている Bicep 構成ファイルが示されています。 この情報は、構成ファイルで verbose を true に設定した場合にのみ表示されます。
問題のある領域の 1 つにマウス カーソルを置きます。 リンターは、エラーまたは警告に関する詳細を提供します。 領域を選択すると、青い電球も表示されます。
電球または Quick fix のリンクを選択し、解決方法を表示します。
解決方法を選択して問題を自動的に修正します。
Bicep CLI での使用
次のスクリーンショットは、コマンド ラインでのリンターを示しています。 lint コマンドと build コマンドからの出力には、規則違反が表示されています。
これらのチェックは、CI/CD パイプラインの一部として統合できます。 GitHub アクションを使用して、bicep ビルドを試みることができます。 エラーがあると、パイプラインは失敗します。
偽陽性の抑制
ルールに誤検知がある場合があります。 たとえば、environment() 関数を使用せずに BLOB ストレージへのリンクを直接含める必要がある場合があります。
disable-next-lineとdisable-diagnosticsを使用して、Bicep リンターのルールを無効化することができます。
ディレクティブを参照してください。 リンター ルールを抑制する場合は、ルールのレベルを bicepconfig.jsonでOffするように変更します。 次の例では、 no-deployments-resources ルールは抑制されています。
{
"analyzers": {
"core": {
"rules": {
"no-deployments-resources": {
"level": "off"
}
}
}
}
}
次のステップ
- リンター ルールのカスタマイズ方法の詳細については、「Bicep 構成ファイルにカスタム設定を追加する」を参照してください。
- Visual Studio Code と Bicep 拡張機能の使用方法の詳細については、「クイック スタート: Visual Studio Code を使用して Bicep ファイルを作成する」を参照してください。