Sdílet prostřednictvím

Konfigurace rozhraní příkazového řádku Azure Static Web Apps

  • Článek

Důležité

Kvůli zlepšení zabezpečení nasazení z rozhraní příkazového řádku Static Web Apps jsme zavedli zásadní změnu, která vyžaduje upgrade na nejnovější verzi rozhraní příkazového řádku Static Web Apps (2.0.2) od 15. ledna 2025.

Rozhraní příkazového řádku Azure Static Web Apps (SWA) získá informace o konfiguraci pro vaši statickou webovou aplikaci jedním ze dvou způsobů:

  • Možnosti rozhraní příkazového řádku (předané za běhu)
  • Konfigurační soubor rozhraní příkazového řádku s názvem swa-cli.config.json

Poznámka:

Rozhraní příkazového řádku SWA ve výchozím nastavení hledá konfigurační soubor s názvem swa-cli.config.json v aktuálním adresáři.

Konfigurační soubor může obsahovat více konfigurací, z nichž každý je identifikován jedinečným názvem konfigurace.

  • Pokud v souboru swa-cli.config.json existuje jenom jedna konfigurace, swa start použije se ve výchozím nastavení.

  • Pokud se možnosti načtou z konfiguračního souboru, budou možnosti příkazového řádku ignorovány.

Vzorový konfigurační soubor

Následující fragment kódu ukazuje obrazec konfiguračního souboru.

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

Pokud máte jenom jednu část konfigurace, jak je znázorněno v tomto příkladu, swa start příkaz tyto hodnoty automaticky použije.

Inicializace konfiguračního souboru

Konfigurační soubor můžete inicializovat pomocí swa init příkazu. Pokud spustíte příkaz proti existujícímu projektu, pokusíte swa init se odhadnout nastavení konfigurace za vás.

Ve výchozím nastavení proces vytvoří tato nastavení v swa-cli.config.json v aktuálním pracovním adresáři projektu. Tento adresář je výchozí název souboru a umístění používané swa při hledání hodnot konfigurace projektu.

swa --config <PATH>

Pokud soubor obsahuje pouze jednu pojmenovanou konfiguraci, použije se tato konfigurace ve výchozím nastavení. Pokud je definováno více konfigurací, předáte požadovaný název konfigurace jako možnost.

swa --<CONFIG_NAME>

Pokud se použije možnost konfiguračního souboru, nastavení se uloží ve formátu JSON. Po vytvoření můžete soubor ručně upravit a aktualizovat nastavení nebo ho použít swa init k aktualizaci.

Zobrazení konfigurace

Rozhraní příkazového řádku statického webu nabízí --print-config možnost, abyste mohli zkontrolovat aktuální konfiguraci.

Tady je příklad toho, jak tento výstup vypadá při spuštění v novém projektu s výchozím nastavením.

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

Spuštěním swa --print-config příkazu zadejte aktuální výchozí hodnoty konfigurace.

Poznámka:

Pokud projekt ještě nenadefinoval konfigurační soubor, automaticky aktivuje swa init pracovní postup, který vám pomůže ho vytvořit.

Ověření konfigurace

Soubor swa-cli.config.json můžete ověřit pomocí následujícího schématu:https://aka.ms/azure/static-web-apps-cli/schema