Cara menambahkan script di package.json cukup buka file tersebut di folder proyek, tambahkan properti ke objek scripts, simpan, lalu jalankan dengan npm run nama-script. Langkah yang sering terlewat adalah menjalankan dari folder yang benar, tempat file package.json berada. Untuk praktik umum, isi start untuk produksi, dev untuk development, dan test untuk pengujian.
{
"scripts": {
"start": "node index.js",
"dev": "node --watch index.js"
}
}
Perintah npm start bisa jalan tanpa kata run karena start dan test adalah script khusus npm. Script lain wajib memakai npm run, contohnya npm run dev.
Kebutuhan Sebelum Edit package.json
Pastikan tiga hal ini beres sebelum menambah script agar tidak muncul error yang membingungkan.
- File package.json valid dan terminal sudah berada di folder proyek. Cek dengan perintah
dirdi Windows ataulsdi Linux dan macOS. - Nama script memakai huruf kecil, tanpa spasi, dan gunakan tanda hubung bila perlu. Contoh benar:
start,dev,test-watch. - Perintah yang ditulis memang bisa jalan di komputer tersebut. Kalau menulis
nodemonataujest, paket itu harus sudah terinstal di proyek.
Langkah Menambahkan Script package.json
- Buka file package.json di root proyek memakai code editor.
- Cari atau buat properti
scriptsdi level atas objek JSON. - Tambahkan pasangan nama dan perintah, contoh
"dev": "node --watch index.js". - Simpan file, lalu cek validitas JSON. Koma tertinggal adalah penyebab gagal paling umum.
- Jalankan script dengan
npm run dev,npm test, ataunpm start.
Contoh sebelum ditambah script dev:
{
"name": "backend-api",
"main": "index.js",
"scripts": {
"test": "node --test"
}
}
Contoh sesudah ditambah script dev dan start:
{
"name": "backend-api",
"main": "index.js",
"scripts": {
"start": "node index.js",
"dev": "node --watch index.js",
"test": "node --test"
}
}
Contoh Script yang Sering Dipakai
| Tahap | Tindakan | Catatan |
|---|---|---|
| start | node index.js |
Untuk jalan produksi |
| dev | node --watch index.js |
Restart otomatis saat file berubah |
| test | node --test |
Runner bawaan Node.js |
| lint | eslint . |
Perlu paket eslint terinstal |
"dev": "NODE_ENV=development node --watch index.js"untuk menandai mode development di Linux dan macOS."start": "NODE_ENV=production node index.js"untuk menandai mode produksi."test-watch": "node --test --watch"untuk pengujian ulang otomatis.
Untuk proyek CommonJS, file utama memakai require() dan module.exports. Untuk proyek dengan "type": "module", file utama memakai import dan export. Script npm tidak berubah, hanya isi kode JavaScript yang mengikuti sistem module tersebut.
FAQ
Kenapa npm run gagal setelah tambah script?
Periksa koma JSON, nama file entry seperti index.js, dan jalankan perintah dari folder berisi package.json.
Apakah nama script boleh pakai spasi?
Jangan pakai spasi, gunakan huruf kecil dan tanda hubung seperti test-watch.
Di mana cek daftar script yang tersedia?
Buka objek scripts di package.json atau jalankan npm run tanpa nama script.