/
/
Membuat Sendiri NPM Package
Posted 5 years ago • 1735 Dibaca

Membuat Sendiri NPM Package

NPM berisi berbagai modul yang nanti bisa digunakan oleh para developer yang menggunakan Javascript. Postingan ini mengajak kamu untuk berkontribusi di NPM, tapi pastikan sebelum publikasi kesana module yang kamu buat unik, less bud, dan kodingnya dibuat efisien dan efektif, yuk langsung mulai saja.

Prasyarat

Berikut beberapa yang terlebih dahulu harus kamu instal di komputer kamu :

  • Node JS dan NPM (wajib) : https://nodejs.org/en/
  • Atau bisa juga menggunakan Yarn sebagai alternative NPM : https://yarnpkg.com

Inisialisasi Project

Langkah awal tentu saja inisialisasi project. Buat direktori kosong terlebih dahulu, untuk kemudian masuk ke direktori tersebut dan di terminal eksekusi perintah

npm init

Sisanya kamu akan dihadapkan dengan berbagai form, isinya meliputi nama package, version, description dan hal - hal dasar lainnya yang berhubungan dengan package, isinya persis dengan package.json atau bisa kamu lihat preview dibawah.

Mulai Koding

Jika dilihat di package.json terlihat property "main": "index.js" , itu ditujukan sebagai file inisial alias file utama yang dipanggil ketika package ini diimport.

Karena package ini cuma dummy, jadi cuma saya isi untuk stripTags function.

module.exports.stripTags = function(html = "") {
  // <b> or </b> => "" ""
  if(typeof html !== "string") return html
  const text = html.replace(/<[^>]+>/gi, "")
  return text
}

Untuk saat ini seja tulisan ini dibuat, NPM hanya support ES5 jadi kodingnya pakai standar itu ya, atau bisa menggunakan versi diatasnya tapi pastikan ketika nanti publish di transpile dulu ke ES5.

Jika divideo atas ada scene untuk unit tes, itu sebenarnya tidak wajib ya, tapi diusahakan ada karena memang penting sekali. Terutama untuk debuging, atau ketika mulai banyak developer lain yang ingin berkontribusi, unit test untuk memastikan seluruh fitur di package buatanmu tidak melenceng jauh dari ekspetasi dan tentunya mencegah bug ketika dipakai developer lain.

Waktunya Publikasi

Sebelum lanjut, pastikan kamu telah memiliki akun di https://npmjs.org , karena disanalah package ini akan bernaung.

Setelah akun telah berhasil terdaftar, lanjutkan dengan login NPM di perangkat kamu, melalui terminal, dengan command :

npm adduser

Sisanya masukan username, password dan public email kamu.

Setelah ada tampilan login sukses, saatnya untuk publikasi, gunakan command :

npm publish

JIka tidak ada masalah, maka setelah eksekusi command diatas maka secara resmi kamu telah memiliki NPM package sendiri.

Update Package

Perintah untuk publikasi baru dan update sebenarnya sama, yaitu 

npm publish

Tapi perlu perubahan di package.json agar package kamu bisa menerima update, yaitu perubahan pada property version di package json.

"version": "0.0.2",

Pastikan versionnya tidak sama dengan yang sudah pernah kamu publikasi di npmjs.com 

Hapus Package

NPM memberlakukan aturan ketat disini, karena ini selain berhubungan dengan pembuat package, juga berhubungan dengan pengguna package. Berikut aturan yang berlaku unpublish alias hapus package di NPM hanya berlaku 72 jam sejam package tersebut dirilis. Jika lebih dari itu maka hanya bisa set status menjadi deprecated alias kadaluarsa, sumber : https://docs.npmjs.com/cli/unpublish .

Command untuk menghapusnya adalah 

npm unpublish [<@scope>/]<pkg>[@<version>]

Penutup

Nah menarik bukan, ini adalah salah satu cara menarik untuk kontribusi didunia open source, buat package se unik mungkin, pastikan pula kodenya seefisien dan seefektif mungkin, selamat berkarya.

MauCoding © 2024 powered by YMG Team