Azure Static Web Apps CLI を構成する

Azure Static Web Apps (SWA) CLI は、次の 2 つの方法のいずれかで静的 Web アプリの構成情報を取得します。

• CLI オプション (実行時に渡されます)
• swa-cli.config.json という名前の CLI 構成ファイル

構成ファイルには複数の構成を含めることができ、それぞれが一意の構成名で識別されます。

• swa-cli.config.json ファイルに 1 つの構成のみが存在する場合は、swa start は既定でそれを使用します。

• オプションが構成ファイルから読み込まれる場合、コマンド ライン オプションは無視されます。

構成 ファイルの例

次のコード スニペットは、構成ファイルの形状を示しています。

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

この例で示すように構成セクションが 1 つのみの場合、swa start コマンドは自動的にこれらの値を使用します。

構成ファイルを初期化する

swa init コマンドを使用して構成ファイルを初期化することができます。 既存のプロジェクトに対して swa init コマンドを実行すると、このコマンドは自動的に構成設定の推測を試みます。

既定では、プロセスは、プロジェクトの現在の作業ディレクトリにある swa-cli.config.json 内にこれらの設定を作成します。 このディレクトリは、プロジェクトの構成値を検索するときに swa によって使用される既定のファイル名と場所です。

swa --config <PATH>

ファイルに名前付きの構成が 1 つだけ含まれている場合は、既定でそれが使用されます。 複数の構成が定義されている場合は、必要な構成名をオプションとして渡します。

swa --<CONFIG_NAME>

構成ファイル オプションを使用すると、設定は JSON 形式で格納されます。 作成された後は、ファイルを手動で編集して設定を更新したり、swa init を使用して更新したりできます。

構成の表示

Static Webs CLI には --print-config オプションが用意されているため、現在の構成を確認することができます。

既定の設定を使用して新しいプロジェクトで実行した場合の出力の例を次に示します。

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

swa --print-config を実行すると、現在の構成の既定値が提供されます。

構成を検証する

swa-cli.config.json ファイルをスキーマ https://aka.ms/azure/static-web-apps-cli/schema に対して検証することができます。