Mengonfigurasi Azure Static Web Apps CLI

Penting

Untuk meningkatkan keamanan penyebaran dari CLI Static Web Apps, perubahan yang melanggar diperkenalkan yang mengharuskan Anda untuk meningkatkan ke versi terbaru (2.0.2) dari CLI Static Web Apps pada 15 Jan 2025.

Azure Static Web Apps (SWA) CLI mendapatkan informasi konfigurasi untuk aplikasi web statis Anda dengan salah satu dari dua cara:

• Opsi CLI (diteruskan saat runtime)
• File konfigurasi CLI bernama swa-cli.config.json

Catatan

Secara default, SWA CLI mencari file konfigurasi bernama swa-cli.config.json di direktori saat ini.

File konfigurasi dapat berisi beberapa konfigurasi, masing-masing diidentifikasi dengan nama konfigurasi unik.

• Jika hanya satu konfigurasi yang ada dalam file swa-cli.config.json , swa start gunakan secara default.

• Jika opsi dimuat dari file konfigurasi, maka opsi baris perintah diabaikan.

Contoh file konfigurasi

Cuplikan kode berikut menunjukkan bentuk file konfigurasi.

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

Ketika Anda hanya memiliki satu bagian konfigurasi, seperti yang ditunjukkan swa start oleh contoh ini, maka perintah secara otomatis menggunakan nilai-nilai ini.

Menginisialisasi file konfigurasi

Anda dapat menginisialisasi file konfigurasi Anda dengan swa init perintah . Jika Anda menjalankan perintah terhadap proyek yang ada, maka swa init coba tebak pengaturan konfigurasi untuk Anda.

Secara default, proses membuat pengaturan ini dalam swa-cli.config.json di direktori kerja proyek Anda saat ini. Direktori ini adalah nama file default dan lokasi yang digunakan saat swa mencari nilai konfigurasi proyek.

swa --config <PATH>

Jika file hanya berisi satu konfigurasi bernama, konfigurasi tersebut digunakan secara default. Jika beberapa konfigurasi ditentukan, maka Anda meneruskan nama konfigurasi yang diinginkan sebagai opsi.

swa --<CONFIG_NAME>

Saat opsi file konfigurasi digunakan, pengaturan disimpan dalam format JSON. Setelah dibuat, Anda dapat mengedit file secara manual untuk memperbarui pengaturan atau menggunakan swa init untuk membuat pembaruan.

Tampilkan konfigurasi

CLI Web Statis menyediakan --print-config opsi sehingga Anda dapat meninjau konfigurasi Anda saat ini.

Berikut adalah contoh tampilan output tersebut saat dijalankan pada proyek baru dengan pengaturan default.

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

Menjalankan swa --print-config menyediakan default konfigurasi saat ini.

Catatan

Jika proyek belum menentukan file konfigurasi, ini secara otomatis memicu swa init alur kerja untuk membantu Anda membuatnya.

Memvalidasi konfigurasi

Anda dapat memvalidasi file swa-cli.config.json terhadap skema berikut: https://aka.ms/azure/static-web-apps-cli/schema