Penyesuaian Build

Ikhtisar

Sistem build Wails adalah alat fleksibel dan andal yang dirancang untuk menyederhanakan proses build aplikasi Wails Anda. Sistem ini memanfaatkan Task, sebuah task runner yang memungkinkan Anda mendefinisikan dan menjalankan tugas dengan mudah. Meskipun sistem build v3 digunakan secara default, Wails mendorong pendekatan “gunakan alat Anda sendiri”, sehingga pengembang dapat menyesuaikan proses build sesuai kebutuhan.

Pelajari lebih lanjut cara menggunakan Task dalam dokumentasi resmi.

Task: Inti Sistem Build

Task adalah alternatif modern untuk Make yang ditulis dalam Go. Task menggunakan berkas YAML untuk mendefinisikan tugas dan dependensinya. Dalam sistem build Wails, Task berperan penting dalam mengatur proses build.

Taskfile.yml utama terletak di root proyek, sedangkan tugas khusus platform didefinisikan dalam berkas build/<platform>/Taskfile.yml. Berkas Taskfile.yml umum dalam direktori build berisi tugas bersama yang digunakan di berbagai platform.

Taskfile.yml

Berkas Taskfile.yml di root proyek merupakan titik masuk utama sistem build. Berkas ini mendefinisikan tugas beserta dependensinya. Berikut adalah berkas Taskfile.yml default:

version: '3'

includes:
  common: ./build/Taskfile.yml
  windows: ./build/windows/Taskfile.yml
  darwin: ./build/darwin/Taskfile.yml
  linux: ./build/linux/Taskfile.yml

vars:
  APP_NAME: "myproject"
  BIN_DIR: "bin"
  VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}'

tasks:
  build:
    summary: Builds the application
    cmds:
      - task: "{{OS}}:build"

  package:
    summary: Packages a production build of the application
    cmds:
      - task: "{{OS}}:package"

  run:
    summary: Runs the application
    cmds:
      - task: "{{OS}}:run"

  dev:
    summary: Runs the application in development mode
    cmds:
      - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}}

Taskfile Khusus Platform

Setiap platform memiliki Taskfile sendiri yang terletak di direktori platform di bawah direktori build. Berkas-berkas ini mendefinisikan tugas inti untuk platform tersebut. Setiap Taskfile menyertakan tugas bersama dari berkas build/Taskfile.yml.

Windows

Lokasi: build/windows/Taskfile.yml

Taskfile khusus Windows mencakup tugas untuk melakukan build, mengemas, dan menjalankan aplikasi di Windows. Fitur utamanya meliputi:

• Melakukan build dengan flag produksi opsional
• Menghasilkan berkas ikon .ico
• Menghasilkan berkas .syso Windows
• Membuat penginstal NSIS untuk pengemasan

Linux

Lokasi: build/linux/Taskfile.yml

Taskfile khusus Linux mencakup tugas untuk melakukan build, mengemas, dan menjalankan aplikasi di Linux. Fitur utamanya meliputi:

• Melakukan build dengan flag produksi opsional
• Membuat paket AppImage, deb, rpm, dan Arch Linux
• Menghasilkan berkas .desktop untuk aplikasi Linux

macOS

Lokasi: build/darwin/Taskfile.yml

Taskfile khusus macOS mencakup tugas untuk melakukan build, mengemas, dan menjalankan aplikasi di macOS. Fitur utamanya meliputi:

• Melakukan build biner untuk arsitektur amd64, arm64, dan universal (keduanya)
• Menghasilkan berkas ikon .icns
• Membuat bundel .app untuk distribusi
• Menandatangani bundel .app secara ad hoc
• Mengatur flag build dan variabel lingkungan khusus macOS

Eksekusi Tugas dan Alias Perintah

Perintah wails3 task merupakan versi tertanam dari Taskfile yang menjalankan tugas-tugas yang didefinisikan dalam Taskfile.yml Anda.

Perintah wails3 build dan wails3 package masing-masing merupakan alias untuk wails3 task build dan wails3 task package. Saat Anda menjalankan perintah ini, Wails secara internal menerjemahkannya menjadi eksekusi tugas yang sesuai:

• wails3 build → wails3 task build
• wails3 package → wails3 task package

Meneruskan Parameter ke Tugas

Anda dapat meneruskan variabel CLI ke tugas menggunakan format KEY=VALUE. Variabel ini diteruskan melalui perintah alias:

# These are equivalent:
wails3 build PLATFORM=linux CONFIG=production
wails3 task build PLATFORM=linux CONFIG=production

# Package with custom version:
wails3 package VERSION=2.0.0 OUTPUT=myapp.pkg

Dalam Taskfile.yml, Anda dapat mengakses variabel tersebut menggunakan sintaks templat Go:

tasks:
  build:
    cmds:
      - echo "Building for {{.PLATFORM | default "darwin"}}"
      - go build -tags {{.CONFIG | default "debug"}} -o myapp

Proses Build Umum

Di semua platform, proses build biasanya mencakup langkah-langkah berikut:

1. Merapikan modul Go
2. Melakukan build frontend
3. Menghasilkan ikon
4. Mengompilasi kode Go dengan flag khusus platform
5. Mengemas aplikasi (khusus platform)

Menyesuaikan Proses Build

Meskipun sistem build v3 menyediakan konfigurasi default yang andal, Anda dapat dengan mudah menyesuaikannya dengan kebutuhan proyek. Dengan mengubah Taskfile.yml dan Taskfile khusus platform, Anda dapat:

• Menambahkan tugas baru
• Mengubah tugas yang sudah ada
• Mengubah urutan eksekusi tugas
• Mengintegrasikan alat dan skrip lain

Fleksibilitas ini memungkinkan Anda menyesuaikan proses build dengan kebutuhan spesifik sekaligus tetap memperoleh manfaat dari struktur yang disediakan oleh sistem build Wails.

Mode Pengembangan

Sistem build Wails menyertakan mode pengembangan andal yang meningkatkan pengalaman pengembang dengan menyediakan pemuatan ulang langsung dan penggantian modul secara hot. Mode ini diaktifkan menggunakan perintah wails3 dev.

Cara Kerjanya

Saat Anda menjalankan wails3 dev, proses berikut akan berlangsung:

1. Perintah tersebut memeriksa port yang tersedia dan menggunakan 9245 secara default jika port tidak ditentukan.
2. Perintah tersebut menyiapkan variabel lingkungan untuk server pengembangan frontend (Vite).
3. Perintah tersebut memulai pemantau berkas menggunakan pustaka refresh.

Pustaka refresh bertugas memantau perubahan berkas dan memicu build ulang. Pustaka ini menggunakan konfigurasi yang ditetapkan pada kunci dev_mode dalam berkas ./build/config.yml. Pustaka ini dapat dikonfigurasi untuk mengabaikan direktori dan berkas tertentu, menentukan berkas yang akan dipantau, serta menentukan tindakan yang harus dilakukan ketika perubahan terdeteksi. Konfigurasi default sudah berfungsi cukup baik, tetapi Anda dapat menyesuaikannya sesuai kebutuhan.

Konfigurasi

Berikut adalah contoh strukturnya:

dev_mode:
  root_path: .
  log_level: warn
  debounce: 1000
  ignore:
    dir:
      - .git
      - node_modules
      - frontend
      - bin
    file:
      - .DS_Store
      - .gitignore
      - .gitkeep
    watched_extension:
      - "*.go"
    git_ignore: true
  executes:
    - cmd: wails3 task common:install:frontend:deps
      type: once
    - cmd: wails3 task common:dev:frontend
      type: background
    - cmd: go mod tidy
      type: blocking
    - cmd: wails3 task build
      type: blocking
    - cmd: wails3 task run
      type: primary

Berkas konfigurasi ini memungkinkan Anda untuk:

• Menetapkan jalur akar untuk pemantauan berkas
• Mengonfigurasi tingkat pencatatan log
• Menetapkan waktu debounce untuk peristiwa perubahan berkas
• Mengabaikan direktori, berkas, atau ekstensi berkas tertentu
• Menentukan perintah yang akan dijalankan saat berkas berubah

Menyesuaikan Mode Pengembangan

Anda dapat menyesuaikan pengalaman mode pengembangan dengan mengubah nilai-nilai ini dalam berkas config.yml.

Beberapa penyesuaian yang dapat dilakukan meliputi:

1. Mengubah direktori atau berkas yang dipantau
2. Menyesuaikan waktu debounce untuk mengatur seberapa cepat sistem merespons perubahan
3. Menambahkan atau mengubah perintah eksekusi agar sesuai dengan kebutuhan proyek Anda

Menggunakan browser untuk pengembangan

Meskipun Wails v2 sepenuhnya mendukung penggunaan browser untuk pengembangan, hal tersebut menimbulkan banyak kebingungan. Aplikasi yang berfungsi di browser belum tentu berfungsi sebagai aplikasi desktop karena tidak semua API browser tersedia di webview.

Untuk pekerjaan pengembangan yang berfokus pada UI, di v3 Anda tetap dapat menggunakan browser dengan mengakses URL Vite di http://localhost:9245 dalam mode pengembangan. Dengan demikian, Anda dapat menggunakan alat pengembangan browser yang canggih saat mengerjakan gaya dan tata letak. Perlu diketahui bahwa binding Go tidak akan berfungsi dalam mode ini. Saat siap menguji fungsionalitas seperti binding dan peristiwa, cukup beralih ke tampilan desktop untuk memastikan semuanya berfungsi sempurna di lingkungan produksi.