Configurar a CLI dos Aplicativos Web Estáticos do Azure

Artigo
02/09/2024

A CLI dos Aplicativos Web Estáticos (SWA) do Azure obtém informações de configuração para seu aplicativo Web estático de duas maneiras:

Opções da CLI (passadas em tempo de execução)
Um arquivo de configuração da CLI chamado swa-cli.config.json

Observação

Por padrão, a CLI do SWA procura um arquivo de configuração chamado swa-cli.config.json no diretório atual.

O arquivo de configuração pode conter várias configurações, cada uma identificada por um nome de configuração exclusivo.

Se apenas uma única configuração estiver presente no arquivo swa-cli.config.json, swa start use-a por padrão.
Se as opções forem carregadas a partir de um arquivo de configuração, as opções de linha de comando serão ignoradas.

Arquivo de configuração de exemplo

O trecho de código a seguir mostra a forma do arquivo de configuração.

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

Quando você tem apenas uma seção de configuração, como mostrado por este exemplo, o swa start comando usa automaticamente esses valores.

Inicializar um arquivo de configuração

Você pode inicializar o arquivo de configuração com o swa init comando. Se você executar o comando em um projeto existente, tente swa init adivinhar as definições de configuração para você.

Por padrão, o processo cria essas configurações em um swa-cli.config.json no diretório de trabalho atual do seu projeto. Esse diretório é o nome de arquivo padrão e o local usado ao swa pesquisar valores de configuração do projeto.

swa --config <PATH>

Se o arquivo contiver apenas uma configuração nomeada, essa configuração será usada por padrão. Se várias configurações forem definidas, você passará o nome da configuração desejada como uma opção.

swa --<CONFIG_NAME>

Quando a opção de arquivo de configuração é usada, as configurações são armazenadas no formato JSON. Depois de criado, você pode editar manualmente o arquivo para atualizar as configurações ou usar swa init para fazer atualizações.

Exibir configuração

A CLI de Webs Estáticas fornece uma --print-config opção para que você possa revisar sua configuração atual.

Aqui está um exemplo de como essa saída se parece quando executada em um novo projeto com configurações padrão.

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

A execução swa --print-config fornece os padrões de configuração atuais.

Observação

Se o projeto ainda não tiver definido um arquivo de configuração, isso acionará automaticamente o swa init fluxo de trabalho para ajudá-lo a criar um.

Validar a configuração

Você pode validar o arquivo swa-cli.config.json em relação ao seguinte esquema:https://aka.ms/azure/static-web-apps-cli/schema

Compartilhar via