Share via

Konfigurowanie interfejsu wiersza polecenia usługi Azure Static Web Apps

  • Artykuł

Interfejs wiersza polecenia usługi Azure Static Web Apps (SWA) pobiera informacje o konfiguracji statycznej aplikacji internetowej na jeden z dwóch sposobów:

  • Opcje interfejsu wiersza polecenia (przekazywane w czasie wykonywania)
  • Plik konfiguracji interfejsu wiersza polecenia o nazwie swa-cli.config.json

Uwaga

Domyślnie interfejs wiersza polecenia swa szuka pliku konfiguracji o nazwie swa-cli.config.json w bieżącym katalogu.

Plik konfiguracji może zawierać wiele konfiguracji, z których każda jest identyfikowana przez unikatową nazwę konfiguracji.

  • Jeśli w pliku swa-cli.config.json znajduje się tylko jedna konfiguracja, swa start używa jej domyślnie.

  • Jeśli opcje są ładowane z pliku konfiguracji, opcje wiersza polecenia są ignorowane.

Przykładowa konfiguracja pliku

Poniższy fragment kodu przedstawia kształt pliku konfiguracji.

{
  "configurations": {
    "app": {
      "appDevserverUrl": "http://localhost:3000",
      "apiLocation": "api",
      "run": "npm run start",
      "swaConfigLocation": "./my-app-source"
    }
  }
}

Jeśli masz tylko jedną sekcję konfiguracji, jak pokazano w tym przykładzie, swa start polecenie automatycznie używa tych wartości.

Inicjowanie pliku konfiguracji

Plik konfiguracji można zainicjować za swa init pomocą polecenia . Jeśli uruchomisz polecenie względem istniejącego projektu, swa init spróbuje odgadnąć ustawienia konfiguracji.

Domyślnie proces tworzy te ustawienia w swa-cli.config.json w bieżącym katalogu roboczym projektu. Ten katalog jest domyślną nazwą pliku i lokalizacją używaną podczas swa wyszukiwania wartości konfiguracji projektu.

swa --config <PATH>

Jeśli plik zawiera tylko jedną nazwaną konfigurację, ta konfiguracja jest używana domyślnie. Jeśli zdefiniowano wiele konfiguracji, należy przekazać żądaną nazwę konfiguracji jako opcję.

swa --<CONFIG_NAME>

Gdy jest używana opcja pliku konfiguracji, ustawienia są przechowywane w formacie JSON. Po utworzeniu można ręcznie edytować plik, aby zaktualizować ustawienia lub użyć swa init go do wprowadzania aktualizacji.

Wyświetlanie konfiguracji

Interfejs wiersza polecenia statycznych sieci Web udostępnia --print-config opcję umożliwiającą przejrzenie bieżącej konfiguracji.

Oto przykład tego, jak te dane wyjściowe wyglądają po uruchomieniu w nowym projekcie z ustawieniami domyślnymi.

swa --print-config

Options:
 - port: 4280
 - host: localhost
 - apiPort: 7071
 - appLocation: .
 - apiLocation: <undefined>
 - outputLocation: .
 - swaConfigLocation: <undefined>
 - ssl: false
 - sslCert: <undefined>
 - sslKey: <undefined>
 - appBuildCommand: <undefined>
 - apiBuildCommand: <undefined>
 - run: <undefined>
 - verbose: log
 - serverTimeout: 60
 - open: false
 - githubActionWorkflowLocation: <undefined>
 - env: preview
 - appName: <undefined>
 - dryRun: false
 - subscriptionId: <undefined>
 - resourceGroupName: <undefined>
 - tenantId: <undefined>
 - clientId: <undefined>
 - clientSecret: <undefined>
 - useKeychain: true
 - clearCredentials: false
 - config: swa-cli.config.json
 - printConfig: true

Uruchomienie swa --print-config polecenia zapewnia bieżące wartości domyślne konfiguracji.

Uwaga

Jeśli projekt nie zdefiniował jeszcze pliku konfiguracji, spowoduje to automatyczne wyzwolenie swa init przepływu pracy w celu ułatwienia jego utworzenia.

Weryfikowanie konfiguracji

Plik swa-cli.config.json można zweryfikować pod kątem następującego schematu:https://aka.ms/azure/static-web-apps-cli/schema