Prices-IDE (VS Code Extension)
Proyek ini berisikan sebuah extension yang dapat digunakan untuk IDE VS Code. Extension PRICES-IDE berguna untuk mengakses dan menggunakan seluruh fitur yang terdapat pada proyek PRICES-WEB dengan lebih terintegrasi dengan development environment yang digunakan oleh pengembang, serta beberapa fungsi tambahan khusus sehingga pengembang dapat mengotomasi proses deployment dari proyek yang sudah di-generate dari proyek PRICES-WEB.
Untuk pemahaman lebih lanjut terkait proyek PRICES-WEB dapat ditemukan pada repositori berikut:
Prerequisites
- Node.js 20.x (LTS)
- Disarankan untuk menggunakan Node 20 untuk menyesuaikan dengan versi yang digunakan oleh CI.
- Yarn 1.x
- Repo ini menggunakan Yarn classic sebagai package manager (lihat
packageManager di package.json).
- Visual Studio Code & Extension Development Host
- Pastikan sudah menginstall VS Code dan memiliki akses ke Extension Development Host untuk menjalankan dan menguji extension.
- Backend Service PRICES-WEB
- Extension ini membutuhkan backend service untuk berfungsi dengan baik. Pastikan backend service PRICES-WEB sudah berjalan dan dapat diakses. Jika service production dari PRICES-WEB sedang tidak tersedia, anda dapat menjalankan instance lokal dari PRICES-WEB untuk development dan testing. Pastikan untuk merubah konfigurasi
BACKEND_SERVICE_URL di src/extension.ts sesuai dengan alamat backend yang digunakan (misalnya http://localhost:8080 jika menjalankan secara lokal).
First Time Setup
Jalankan dari root project:
yarn install
Build & Type Check
yarn run check-types
yarn run lint
yarn run compile
Run extension (development mode)
- Buka project ini di VS Code sebagai sebuah workspace.
- Run extension dengan menekan
F5 atau tombol Start pada opsi Run & Debug.
- VS Code akan melakukan compile dan membuka Extension Development Host baru.
- Di window baru itu, buka Command Palette (
Ctrl+Shift+P) dan jalankan command dengan prefix PRICES-IDE: ....
Watch mode (aktif saat development)
yarn run watch
Testing
yarn run test
Script test akan menjalankan:
- compile tests
- compile extension
- lint
- vscode-test
Backend Configuration
Extension membutuhkan BACKEND_SERVICE_URL di secret storage.
Saat ini src/extension.ts memiliki default value:
Gunakan proyek PRICES-WEB sebagai backend dan pastikan web berfungsi. Jika web pada alamat default sedang tidak aktif, sesuaikan endpoint dengan proyek backend yang dihost sendiri.
Contoh: http://localhost:8080
Cara Menggunakan Extension
Setelah Extension Development Host aktif, harus terdapat workspace yang terbuka sehingga extension