Konfigurera Azure Static Web Apps CLI

Viktigt!

För att förbättra säkerheten för distributioner från Static Web Apps CLI infördes en icke-bakåtkompatibel ändring som kräver att du uppgraderar till den senaste versionen (2.0.2) av Static Web Apps CLI senast den 15 januari 2025.

Azure Static Web Apps (SWA) CLI hämtar konfigurationsinformation för din statiska webbapp på något av två sätt:

• CLI-alternativ (som skickades in vid körning)
• En CLI-konfigurationsfil med namnet swa-cli.config.json

Kommentar

Som standard letar SWA CLI efter en konfigurationsfil med namnet swa-cli.config.json i den aktuella katalogen.

Konfigurationsfilen kan innehålla flera konfigurationer som var och en identifieras med ett unikt konfigurationsnamn.

• Om det bara finns en enda konfiguration i filen swa-cli.config.jsonswa start använder du den som standard.

• Om alternativ läses in från en konfigurationsfil ignoreras kommandoradsalternativen.

Exempelkonfigurationsfil

Följande kodfragment visar konfigurationsfilens form.

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

När du bara har ett konfigurationsavsnitt, som visas i det här exemplet, swa start använder kommandot automatiskt dessa värden.

Initiera en konfigurationsfil

Du kan initiera konfigurationsfilen med swa init kommandot . Om du kör kommandot mot ett befintligt projekt försöker du swa init gissa konfigurationsinställningarna åt dig.

Som standard skapar processen dessa inställningar i en swa-cli.config.json i projektets aktuella arbetskatalog. Den här katalogen är standardfilnamnet och platsen som används vid swa sökning efter projektkonfigurationsvärden.

swa --config <PATH>

Om filen bara innehåller en namngiven konfiguration används den konfigurationen som standard. Om flera konfigurationer har definierats skickar du önskat konfigurationsnamn som ett alternativ.

swa --<CONFIG_NAME>

När konfigurationsfilalternativet används lagras inställningarna i JSON-format. När du har skapat den kan du redigera filen manuellt för att uppdatera inställningarna eller använda swa init för att göra uppdateringar.

Visa konfiguration

Static Webs CLI innehåller ett --print-config alternativ så att du kan granska den aktuella konfigurationen.

Här är ett exempel på hur utdata ser ut när de körs i ett nytt projekt med standardinställningar.

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

Att köra swa --print-config tillhandahåller är de aktuella konfigurationsstandarderna.

Kommentar

Om projektet ännu inte har definierat en konfigurationsfil utlöser swa init detta automatiskt arbetsflödet för att hjälpa dig att skapa en.

Verifiera konfigurationen

Du kan verifiera swa-cli.config.json-filen mot följande schema:https://aka.ms/azure/static-web-apps-cli/schema