Korzystanie z lintera Bicep

Linter Bicep sprawdza pliki Bicep pod kątem błędów składni i naruszeń najlepszych rozwiązań. Linter pomaga wymuszać standardy kodowania, zapewniając wskazówki podczas opracowywania. Najlepsze rozwiązania można dostosować do sprawdzania pliku.

Wymagania dotyczące lintera

Linter jest zintegrowany z interfejsem wiersza polecenia Bicep i rozszerzeniem Bicep dla programu Visual Studio Code. Aby go używać, musisz mieć wersję 0.4 lub nowszą.

Reguły domyślne

Domyślny zestaw reguł linter jest minimalny i pobierany z przypadków testowych arm-ttk. Rozszerzenie i interfejs wiersza polecenia Bicep sprawdzają następujące reguły, które są ustawione na poziom ostrzeżenia.

• adminusername-should-not-be-literal
• artifacts-parameters
• dekompiler-cleanup
• explicit-values-for-loc-params
• max-asserts
• max-outputs
• parametrów max
• max-resources
• max-variables
• zagnieżdżone wdrożenie—szablon — określanie zakresu
• brak konfliktów metadanych
• brak wdrożeń — zasoby
• no-hardcoded-env-urls
• brak zakodowanej lokalizacji
• no-loc-expr-outside-params
• no-unnecessary-dependson
• brak nieużywanych zasobów istniejących
• brak nieużywanych parametrów
• brak nieużywanych vars
• outputs-should-not-contain-secrets
• interpolacja preferowania
• prefer-unquoted-property-names
• secure-parameter-default
• secure-params-in-nested-deploy
• secure-secrets-in-params
• upraszczanie interpolacji
• simplify-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
• korzystanie z bezpiecznego dostępu
• use-secure-value-for-secure-inputs
• use-stable-resource-identifiers
• use-stable-vm-image
• what-if-short-circuiting

Możesz dostosować sposób stosowania reguł linter. Aby zastąpić ustawienia domyślne, dodaj plik bicepconfig.json i zastosuj ustawienia niestandardowe. Aby uzyskać więcej informacji na temat stosowania tych ustawień, zobacz Dodawanie ustawień niestandardowych w pliku konfiguracji Bicep.

Używanie w programie Visual Studio Code

Poniższy zrzut ekranu przedstawia linter w programie Visual Studio Code:

W okienku PROBLEMY istnieją cztery błędy, jedno ostrzeżenie i jeden komunikat informacyjny wyświetlany na zrzucie ekranu. Komunikat informacyjny zawiera używany plik konfiguracji Bicep. Pokazuje tylko ten fragment informacji po ustawieniu pełnej wartości true w pliku konfiguracji.

Umieść kursor myszy na jednym z obszarów problemu. Linter udostępnia szczegółowe informacje o błędzie lub ostrzeżeniu. Wybierz obszar, w tym również jest wyświetlana niebieska żarówka:

Wybierz żarówkę lub link Szybka poprawka , aby wyświetlić rozwiązanie:

Wybierz rozwiązanie, aby rozwiązać problem automatycznie.

Używanie w interfejsie wiersza polecenia aplikacji Bicep

Poniższy zrzut ekranu przedstawia linter w wierszu polecenia. Dane wyjściowe polecenia lint i polecenia kompilacji pokazują wszelkie naruszenia reguły.

Te testy można zintegrować w ramach potoków ciągłej integracji/ciągłego wdrażania. Możesz użyć akcji usługi GitHub, aby spróbować skompilować bicep. Błędy spowodują niepowodzenie potoków.

Wyciszanie wyników fałszywie dodatnich

Czasami reguła może mieć wyniki fałszywie dodatnie. Na przykład może być konieczne dołączenie linku do magazynu obiektów blob bezpośrednio bez użycia funkcji environment(). W takim przypadku można wyłączyć ostrzeżenie tylko dla jednego wiersza, a nie całego dokumentu, dodając #disable-next-line <rule name> przed wierszem z ostrzeżeniem.

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

Dobrym rozwiązaniem jest dodanie komentarza wyjaśniającego, dlaczego reguła nie ma zastosowania do tego wiersza.

Jeśli chcesz pominąć regułę linter, możesz zmienić poziom reguły na Off w bicepconfig.json. Na przykład w poniższym przykładzie reguła no-deployments-reesources jest pomijana:

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

Następne kroki

• Aby uzyskać więcej informacji na temat dostosowywania reguł linter, zobacz Dodawanie ustawień niestandardowych w pliku konfiguracji Bicep.
• Aby uzyskać więcej informacji na temat korzystania z programu Visual Studio Code i rozszerzenia Bicep, zobacz Szybki start: tworzenie plików Bicep za pomocą programu Visual Studio Code.