Использование анализатора кода Bicep

Анализатор кода Bicep проверяет файлы Bicep на наличие синтаксических ошибок и нарушений рекомендаций. Анализатор кода упрощает применение стандартов программирования, предоставляя полезные рекомендации на этапе разработки. Вы можете подобрать лучшие методики для проверки файла.

Требования для анализатора кода

Анализатор кода интегрирован в CLI Bicep и расширение Bicep для Visual Studio Code. Чтобы использовать его, необходимо использовать Bicep CLI версии 0.4 или более поздней.

Правила по умолчанию

Для анализатора кода используется минимальный набор правил по умолчанию, взятый из тестовых случаев arm-ttk. Расширение и CLI Bicep проверяют следующие правила, для которых установлен уровень предупреждения.

Вы можете включить или отключить все правила linter и управлять их применением с помощью файла конфигурации. Чтобы переопределить поведение по умолчанию, создайте файлbicepconfig.json с пользовательскими параметрами. Дополнительные сведения о применении этих параметров см. в разделе Добавление пользовательских параметров в файл конфигурации Bicep.

Использование в Visual Studio Code

На снимке экрана ниже показан анализатор кода в Visual Studio Code:

На этом снимке экрана представлена область PROBLEMS (Проблемы), где отображаются четыре ошибки, одно предупреждение и одно информационное сообщение. В информационном сообщении есть имя файла конфигурации Bicep, который сейчас используется. Эта информация отображается, только если для параметра verbose в файле конфигурации задано значение true.

Наведите курсор мыши на любой из проблемных элементов. Анализатор кода предоставит вам подробные сведения об этой ошибке или предупреждении. Выберите область со значком синей лампочки:

Щелкните эту лампочку или ссылку Quick fix (Быстрое исправление), чтобы увидеть решение:

Щелкните решение, чтобы автоматически решить проблему.

Использование в Bicep CLI

На снимке экрана ниже показан анализатор кода в командной строке. Выходные данные команды lint и команды сборки показывают нарушения правил.

Вы можете интегрировать такие проверки в свои конвейеры CI/CD. Вы можете использовать GitHub Actions, чтобы попытаться выполнить сборку Bicep. В случае возникновения ошибок конвейер завершится сбоем.

Устранение ложноположительных результатов

Иногда правило имеет ложные срабатывания. Например, может потребоваться включить ссылку на хранилище BLOB-объектов напрямую, не используя функцию environment().

Вы можете отключить правила Bicep linter с помощью disable-next-line и disable-diagnostics. См. директивы. Если вы хотите отключить правило linter, измените уровень правила Off на bicepconfig.json. В следующем примере правило no-deployments-resources отключается.

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

Следующие шаги

• Дополнительные сведения о настройке правил анализатора кода см. в разделе Добавление пользовательских параметров в файл конфигурации Bicep.
• Дополнительные сведения об использовании Visual Studio Code и расширения Bicep см. в кратком руководстве по созданию файлов Bicep с помощью Visual Studio Code.