Use o bíceps linter

O linter do Bicep verifica os arquivos do Bicep em busca de erros de sintaxe e violações de práticas recomendadas. O linter ajuda a aplicar os padrões de codificação, fornecendo orientação durante o desenvolvimento. Você pode personalizar as práticas recomendadas a serem usadas para verificar o arquivo.

Requisitos de forro

O linter é integrado à CLI do Bicep e à extensão Bicep para Visual Studio Code. Para usá-lo, você deve ter a versão 0.4 ou posterior.

Regras predefinidas

O conjunto padrão de regras linter é mínimo e retirado de casos de teste arm-ttk. A extensão e a CLI do Bíceps verificam as seguintes regras, que são definidas para o nível de aviso.

• adminusername-should-not-be-literal
• artefatos-parâmetros
• limpeza do descompilador
• valores-explícitos-para-loc-params
• max-asserts
• max-saídas
• max-params
• max-recursos
• max-variáveis
• nested-deployment-template-scoping
• Metadados sem conflito
• não-implantações-recursos
• não-hardcoded-env-urls
• localização sem codificação
• no-loc-expr-fora-params
• não-desnecessário-dependente
• recursos não existentes não utilizados
• params sem uso
• VARs sem uso
• saídas-devem-não-conter-segredos
• interpolação preferencial
• prefer-unquoted-property-names
• secure-parameter-default
• secure-params-in-nested-deploy
• segredos-seguros em parâmetros
• simplificar-interpolação
• simplify-json-null
• uso-propriedade-pai
• use-protectedsettings-for-commandtoexecute-secrets
• use-recent-api-versions
• use-resource-id-functions
• use-resource-symbol-reference
• identificadores use-stable-resource-identifiers
• use-stable-vm-image

Você pode personalizar como as regras linter são aplicadas. Para substituir as configurações padrão, adicione um arquivo bicepconfig.json e aplique configurações personalizadas. Para obter mais informações sobre como aplicar essas configurações, consulte Adicionar configurações personalizadas no arquivo de configuração do Bicep.

Uso no Visual Studio Code

A captura de tela a seguir mostra o linter no Visual Studio Code:

No painel PROBLEMAS, há quatro erros, um aviso e uma mensagem informativa mostrada na captura de tela. A mensagem info mostra o arquivo de configuração do Bicep que é usado. Ele só mostra essa informação quando você define verbose como true no arquivo de configuração.

Passe o cursor do mouse sobre uma das áreas problemáticas. Linter dá os detalhes sobre o erro ou aviso. Selecione a área, ele também mostra uma lâmpada azul:

Selecione a lâmpada ou o link Correção rápida para ver a solução:

Selecione a solução para corrigir o problema automaticamente.

Utilização na CLI do Bíceps

A captura de tela a seguir mostra o linter na linha de comando. A saída do comando lint e do comando build mostra quaisquer violações de regras.

Você pode integrar essas verificações como parte de seus pipelines de CI/CD. Você pode usar uma ação do GitHub para tentar uma compilação bicep. Os erros falharão nos pipelines.

Silenciar falsos positivos

Às vezes, uma regra pode ter falsos positivos. Por exemplo, talvez seja necessário incluir um link para um armazenamento de blob diretamente sem usar a função environment( ). Nesse caso, você pode desativar o aviso apenas para uma linha, não para o documento inteiro, adicionando #disable-next-line <rule name> antes da linha com o aviso.

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

É uma boa prática adicionar um comentário explicando por que a regra não se aplica a essa linha.

Se você quiser suprimir uma regra linter, você pode alterar o nível da regra para Off em bicepconfig.json. Por exemplo, no exemplo a seguir, a no-deployments-reesources regra é suprimida:

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

Próximos passos

• Para obter mais informações sobre como personalizar as regras linter, consulte Adicionar configurações personalizadas no arquivo de configuração do Bicep.
• Para obter mais informações sobre como usar o Visual Studio Code e a extensão Bicep, consulte Guia de início rápido: criar arquivos Bicep com o Visual Studio Code.