Compartir a través de

Configuración de la CLI de Azure Static Web Apps

  • Artículo

Importante

Para mejorar la seguridad de las implementaciones de la CLI de Static Web Apps, se introdujo un cambio importante que requiere que actualice a la versión más reciente (2.0.2) de la CLI de Static Web Apps antes del 15 de enero de 2025.

La CLI de Azure Static Web Apps (SWA) obtiene la información de configuración de la aplicación web estática de una de estas dos maneras:

  • Opciones de la CLI (pasadas en tiempo de ejecución)
  • Un archivo de configuración de la CLI denominado swa-cli.config.json

Nota:

De forma predeterminada, la CLI de SWA busca un archivo de configuración denominado swa-cli.config.json en el directorio actual.

El archivo de configuración puede contener varias configuraciones, cada una identificada por un nombre de configuración único.

  • Si solo hay una configuración en el archivo swa-cli.config.json, swa start la usa de forma predeterminada.

  • Si las opciones se cargan desde un archivo de configuración, se omiten las opciones de la línea de comandos.

Ejemplo de archivo de configuración

El siguiente fragmento de código muestra la forma del archivo de configuración.

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

Cuando solo tiene una sección de configuración, como se muestra en este ejemplo, el comando swa start usa automáticamente estos valores.

Inicialización de un archivo de configuración

Puede inicializar el archivo de configuración con el comando swa init. Si ejecuta el comando en un proyecto existente, swa init intenta adivinar los valores de configuración automáticamente.

De forma predeterminada, el proceso crea esta configuración en un swa-cli.config.json en el directorio de trabajo actual del proyecto. Este directorio es el nombre de archivo y la ubicación predeterminados que usa swa al buscar valores de configuración del proyecto.

swa --config <PATH>

Si el archivo contiene solo una configuración con nombre, se usa dicha configuración de forma predeterminada. Si se definen varias configuraciones, hay que pasar el nombre de configuración deseado como opción.

swa --<CONFIG_NAME>

Cuando se usa la opción de archivo de configuración, la configuración se almacena en formato JSON. Una vez creado, puede editar manualmente el archivo para actualizar la configuración o usar swa init para realizar actualizaciones.

Ver configuración

La CLI de Static Webs proporciona una opción de --print-config para que pueda revisar la configuración actual.

Este es un ejemplo del aspecto que tiene esa salida cuando se ejecuta en un nuevo proyecto con la configuración predeterminada.

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

La ejecución de swa --print-config proporciona los valores predeterminados de configuración actuales.

Nota:

Si el proyecto aún no ha definido un archivo de configuración, se desencadena automáticamente el flujo de trabajo de swa init para ayudarle a crear uno.

Validación de la configuración

Puede validar el archivo swa-cli.config.json con el esquema siguiente: https://aka.ms/azure/static-web-apps-cli/schema