Mengonfigurasi package.json

  • 4 menit

Selamat datang di dunia manajemen proyek Node.js dengan npm dan manajemen paket. Mari kita selaraskan hal-hal penting dalam pengemasan dan bagaimana hal itu dapat membesarkan proses pengembangan Anda.

Manajemen Kemasan dan Paket

NPM, manajer paket default untuk Node.js, adalah senjata rahasia Anda untuk memasukkan kode eksternal ke dalam proyek Anda. Ini seperti memiliki asisten pribadi untuk membantu Anda membangun aplikasi lebih cepat dan lebih efisien.

Kemasan seperti pembungkusan hadiah kode Anda untuk distribusi. Ini dengan rapi menggabungkan kode Anda dan dependensinya ke dalam paket yang dapat dengan mudah diinstal dan digunakan orang lain. Manajemen paket adalah seni menangani paket-paket ini, dan melibatkan:

  • File package.json , cetak biru proyek Anda. Ini dikemas dengan metadata tentang proyek Anda dan mengurus pengelolaan dependensi dan file paket.
  • Alat CLI npm, handyman pribadi Anda untuk menginstal dan mengelola paket dari registri npm.
  • Registri npm, harta karun paket publik yang siap digunakan dalam proyek Anda.

Buat package.json Anda

Membuat sederhana package.json seperti menjalankan npm init perintah. Ada dua cara utama untuk melakukan ini:

  • npm init: Perintah ini seperti panduan yang ramah, memandu Anda melalui proses langkah demi langkah yang meminta detail tentang proyek Anda seperti nama, versi, dan deskripsinya.
  • npm init -y: Perintah ini adalah versi kereta ekspres dari npm init. Ini zip melewati pertanyaan dan mengisi nilai default untuk Anda.

Berikut adalah cuplikan menyeluruk file yang package.json akan Anda hasilkan.

{
  "name": "my project",
  "version": "1.0.0",
  "description": "",
  "main": "script.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

Memahami area file package.json

package.json Anggap file sebagai peti harta karun, diisi dengan permata berharga yang memberikan proyek Anda berkilau. Permata ini adalah properti dalam package.json file, dan mereka termasuk dalam tiga kategori utama:

  • Meta-information: Properti ini seperti permata mahkota, menentukan meta-informasi tentang proyek Anda. Mereka menyertakan nama proyek, deskripsi, penulis, kata kunci, dan banyak lagi.
  • Dependensi: Ini adalah koin emas dan perak, mewakili paket yang digunakan proyek Anda. Properti dependencies dan devDependencies menyimpan harta ini. Saat melakukan perjalanan lebih jauh, Anda akan mempelajari cara menggunakan properti ini untuk menginstal, memperbarui, dan mengelola dependensi Anda.
  • Skrip: Ini adalah perintah terminal yang membuat tugas proyek Anda terjadi. Anda dapat mencantumkan skrip untuk tugas seperti mulai, bangun, uji, dan lint.

Mempercepat tugas dengan skrip

package.json Dalam file, Anda harus menyertakan setidaknya empat skrip umum:

  • start: Skrip ini menghiasi proyek Anda. Misalnya, mungkin menggunakan perintah node ./src/index.js.
  • build: Skrip ini mempersiapkan proyek Anda untuk debut akbarnya. Ini mungkin mengubah TypeScript menjadi JavaScript, misalnya.
  • test: Skrip ini memeriksa kesehatan proyek Anda, biasanya menggunakan paket pengujian.
  • lint: Skrip ini mengikat kode Anda, memeriksa masalah gaya dan pemformatan menggunakan alat seperti ESLint.

Nama skrip ini seperti kata-kata ajaib, diakui secara universal di komunitas pengembang dan penting untuk menjaga proyek Anda tetap teratur.

Menstandarkan nama skrip

Dalam file package.json Anda, skrip didefinisikan dengan tindakan dan perintah:

"scripts" : {
  "<action>" : "<command>"
}

Berikut contohnya:

"scripts" : {
  "start" : "node ./dist/index.js",
  "test": "jest",
  "build": "tsc",
  "lint": "eslint"
}

Menjalankan skrip

Untuk menjalankan skrip di terminal dengan memasukkan perintah npm run <action>. Contohnya, npm run lint.

Tindakan start dan test bersifat khusus karena Anda dapat menghilangkan kata run dalam perintah. Daripada memasukkan perintah npm run start, Anda dapat memasukkan npm start.

Menggunakan lingkungan pengembangan yang telah ditentukan sebelumnya

Modul pelatihan ini menawarkan kontainer pengembangan, baik di browser atau untuk komputer lokal Anda. Kontainer ini menyediakan semua lingkungan yang diperlukan sehingga Anda dapat menggunakan modul pelatihan ini tanpa harus menginstal IDE atau Node.js. Anda tidak perlu tahu apa pun tentang kontainer untuk menyelesaikan modul pelatihan ini.