Configurer l’interface CLI Azure Static Web Apps

Article
02/08/2024

L’interface CLI Azure Static Web Apps (SWA) obtient des informations de configuration pour votre application web statique de deux façons :

Options CLI (transmises au moment de l’exécution)
Un fichier de configuration CLI nommé swa-cli.config.json

Remarque

Par défaut, l’interface CLI SWA recherche un fichier de configuration nommé swa-cli.config.json dans le répertoire actif.

Le fichier de configuration peut contenir plusieurs configurations, chacune identifiée par un nom de configuration unique.

Si une seule configuration est présente dans le fichier swa-cli.config.json , swa start l’utilise par défaut.
Si les options sont chargées à partir d’un fichier de configuration, les options de ligne de commande sont ignorées.

Exemple de fichier de configuration

L’extrait de code suivant montre la forme du fichier de configuration.

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

Lorsque vous n’avez qu’une seule section de configuration, comme illustré par cet exemple, la swa start commande utilise automatiquement ces valeurs.

Initialiser un fichier de configuration

Vous pouvez initialiser votre fichier de configuration avec la swa init commande. Si vous exécutez la commande sur un projet existant, swa init tente de deviner les paramètres de configuration pour vous.

Par défaut, le processus crée ces paramètres dans un swa-cli.config.json dans le répertoire de travail actuel de votre projet. Ce répertoire est le nom de fichier et l’emplacement par défaut utilisés swa lors de la recherche de valeurs de configuration de projet.

swa --config <PATH>

Si le fichier contient une seule configuration nommée, cette configuration est utilisée par défaut. Si plusieurs configurations sont définies, vous passez le nom de configuration souhaité en tant qu’option.

swa --<CONFIG_NAME>

Lorsque l’option de fichier de configuration est utilisée, les paramètres sont stockés au format JSON. Une fois créé, vous pouvez modifier manuellement le fichier pour mettre à jour les paramètres ou l’utiliser swa init pour effectuer des mises à jour.

Afficher la configuration

L’interface CLI Static Webs fournit une option qui vous permet de --print-config passer en revue votre configuration actuelle.

Voici un exemple de ce à quoi ressemble cette sortie lors de l’exécution sur un nouveau projet avec les paramètres par défaut.

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

L’exécution swa --print-config fournit les valeurs par défaut de configuration actuelles.

Remarque

Si le projet n’a pas encore défini de fichier de configuration, cela déclenche automatiquement le swa init flux de travail pour vous aider à en créer un.

Valider la configuration

Vous pouvez valider le fichier swa-cli.config.json par rapport au schéma suivant : https://aka.ms/azure/static-web-apps-cli/schema

Partager via