Použití linteru Bicep

Nástroj Bicep linter kontroluje chyby syntaxe a porušení osvědčených postupů v souborech Bicep. Linter pomáhá vynucovat standardy kódování tím, že poskytuje pokyny během vývoje. Osvědčené postupy pro kontrolu souboru můžete přizpůsobit.

Požadavky na Linter

Linter je integrovaný do rozhraní příkazového řádku Bicep a rozšíření Bicep pro Visual Studio Code. Pokud ho chcete použít, musíte mít verzi 0.4 nebo novější.

Výchozí pravidla

Výchozí sada pravidel linteru je minimální a přijímána z testovacích případů arm-ttk. Rozšíření a rozhraní příkazového řádku Bicep zkontrolují následující pravidla, která jsou nastavená na úroveň upozornění.

• adminusername-should-not-be-literal
• artifacts-parameters
• decompiler-cleanup
• explicit-values-for-loc-params
• max-asserts
• max-outputs
• max-params
• max-resources
• max-variables
• vnořeno-deployment-template-scoping
• žádná konfliktní metadata
• no-deployments-resources
• no-hardcoded-env-urls
• no-hardcoded-location
• no-loc-expr-outside-params
• bez zbytečných závislostí
• žádné nepoužívané existující prostředky
• nepoužívané parametry
• no-unused-vars
• outputs-should-not-contain-secrets
• preferovat interpolaci
• prefer-unquoted-property-names
• secure-parameter-default
• secure-params-in-nested-deploy
• secure-secrets-in-params
• zjednodušení interpolace
• zjednodušení-json-null
• use-parent-property
• use-protectedsettings-for-commandtoexecute-secrets
• use-recent-api-versions
• use-recent-module-versions
• use-resource-id-functions
• use-resource-symbol-reference
• use-safe-access
• use-secure-value-for-secure-inputs
• use-stable-resource-identifiers
• use-stable-vm-image
• citlivostní zkratování

Způsob použití pravidel linteru můžete přizpůsobit. Pokud chcete přepsat výchozí nastavení, přidejte soubor bicepconfig.json a použijte vlastní nastavení. Další informace o použití těchto nastavení naleznete v tématu Přidání vlastních nastavení v konfiguračním souboru Bicep.

Použití v editoru Visual Studio Code

Následující snímek obrazovky ukazuje linter v editoru Visual Studio Code:

V podokně PROBLÉMY jsou čtyři chyby, jedno upozornění a jedna informační zpráva zobrazená na snímku obrazovky. Informační zpráva zobrazuje použitý konfigurační soubor Bicep. Tato část informací se zobrazí pouze při nastavení podrobné hodnoty true v konfiguračním souboru.

Najeďte kurzorem myši na jednu z problémových oblastí. Linter poskytuje podrobnosti o chybě nebo upozornění. Vyberte oblast, zobrazí se také modrá žárovka:

Výběrem žárovky nebo odkazu Rychlá oprava zobrazíte řešení:

Výběrem řešení problém opravte automaticky.

Použití v rozhraní příkazového řádku Bicep

Následující snímek obrazovky ukazuje linter v příkazovém řádku. Výstup z příkazu lint a příkazu sestavení zobrazuje porušení pravidel.

Tyto kontroly můžete integrovat jako součást kanálů CI/CD. K pokusu o sestavení bicep můžete použít akci GitHubu. Chyby selžou kanály.

Šetření falešně pozitivních výsledků

Někdy může pravidlo obsahovat falešně pozitivní výsledky. Můžete například potřebovat zahrnout odkaz na úložiště objektů blob přímo bez použití funkce environment(). V takovém případě můžete upozornění zakázat pouze pro jeden řádek, ne pro celý dokument, a to přidáním #disable-next-line <rule name> před řádek s upozorněním.

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

Doporučujeme přidat komentář vysvětlující, proč se pravidlo na tento řádek nevztahuje.

Pokud chcete potlačit pravidlo linteru, můžete změnit úroveň pravidla na Off bicepconfig.json. Například v následujícím příkladu no-deployments-reesources je pravidlo potlačeno:

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

Další kroky

• Další informace o přizpůsobení pravidel linter naleznete v tématu Přidání vlastních nastavení v konfiguračním souboru Bicep.
• Další informace o používání editoru Visual Studio Code a rozšíření Bicep najdete v tématu Rychlý start: Vytváření souborů Bicep pomocí editoru Visual Studio Code.