Cara menerbitkan pakej ke npm: panduan langkah demi langkah

Menerbitkan pakej pada NPM (Pengurus pakej Node) bukan sahaja cara untuk berkongsi kerja anda dengan pembangun lain, tetapi juga untuk menonjol dalam komuniti pembangunan. Bayangkan mencipta penyelesaian boleh guna semula yang boleh disepadukan ke dalam pelbagai projek di seluruh dunia, menjimatkan masa dan usaha pengaturcara lain.

Dalam artikel ini, anda akan belajar, langkah demi langkah, cara mengkonfigurasi, menerbitkan dan mengekalkan pakej anda sendiri pada NPM, menjadikan sumbangan anda boleh diakses dan meningkatkan keterlihatan anda sebagai pembangun.

Prasyarat

Sebelum anda bermula, pastikan anda mempunyai:

• NPM dipasang. Anda boleh memuat turunnya daripada nodejs.org atau gunakan NVM (Pengurus versi Node).
• Akaun yang dibuat di npmjs.com

Jalankan arahan di bawah dalam terminal untuk mengesahkan bahawa pemasangan Node.js dan NPM telah berjaya.

node -v
npm -v

Jika pemasangan betul, terminal akan memaparkan versi setiap satu.
Hasilnya akan serupa dengan yang di bawah:

$ v20.18.0 # node -v
$ 10.8.2 # npm -v

Mengkonfigurasi projek

Mulakan dengan mencipta folder dengan nama yang anda mahukan untuk pakej tersebut. Dalam kes saya, saya memilih "string-reverser-jm".

mkdir string-reverser-jm # cria a pasta via terminal
cd string-reverser-jm # acessa a pasta via terminal

Memulakan NPM:

npm init

Apabila melaksanakan arahan di atas, terminal akan bertanya kepada anda beberapa soalan untuk mencipta fail package.json.
Di bawah adalah penjelasan setiap item yang perlu kami isi.

• nama: Pengecam unik untuk pakej.
• versi: Gunakan versi semantik untuk menunjukkan perubahan.
• penerangan: Penerangan ringkas tentang perkara yang dilakukan oleh pakej.
• utama: Fail titik masuk, contohnya, index.js.
• kata kunci: Kata kunci untuk mengkategorikan dan memudahkan pembangun lain mencari pakej.
• pengarang: Tambahkan butiran pengarang yang berkaitan.
• lesen: Lesen mentakrifkan cara kod boleh digunakan, diubah suai dan diedarkan oleh orang lain. Lesen yang paling biasa ialah MIT, yang permisif dan membenarkan kebebasan penggunaan yang besar, selagi notis hak cipta asal diberikan.

Jika anda menyelesaikan soalan dan NPM mencipta fail tanpa sebarang maklumat ini, buka fail yang dibuat dalam editor dan tambahkan apa-apa yang tiada.

Contoh:

{
  "name": "string-reverser-jm",
  "version": "1.0.0",
  "description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"No test specified\" && exit 1"
  },
  "author": "Juliana Macedo <contact@starcoders.info> (https://www.starcoders.info)",
  "keywords": [
    "string",
    "reverse",
    "utility"
  ],
  "license": "MIT"
}

Menulis kod

Buat fail index.js dalam akar projek.

function reverseString(str) {
  if (typeof str !== "string") {
    throw new TypeError("Expected a string as input");
  }
  return str.split("").reverse().join("");
}

module.exports = reverseString;

Menguji pakej

Untuk menguji pakej sebelum menerbitkannya, kami akan menggunakan arahan pautan npm

Dalam direktori pakej, jalankan arahan:

npm link

Dalam projek di mana anda ingin menguji pakej, jalankan arahan:

node -v
npm -v

Import dan gunakan pakej dalam projek ujian anda untuk memastikan ia berfungsi:

$ v20.18.0 # node -v
$ 10.8.2 # npm -v

Untuk mengalih keluar pautan yang dibuat, hanya jalankan arahan npm unlink string-reverser-jm dalam direktori projek ujian dan kemudian npm unlink dalam direktori pakej.

Menyediakan pakej untuk penerbitan

Pertama, buat repositori Git untuk pakej dan pautkannya ke NPM. Ini meningkatkan ketelusan dan kepercayaan dengan menyediakan kod sumber, memudahkan kerjasama dan sumbangan komuniti serta membolehkan automasi dengan CI/CD untuk pengurusan dan penyelenggaraan yang lebih cekap.

Untuk memaut ke NPM, salin alamat https repositori dan tambahkannya ke package.json:

mkdir string-reverser-jm # cria a pasta via terminal
cd string-reverser-jm # acessa a pasta via terminal

• .gitignore: Buat fail .gitignore untuk mengecualikan folder dan fail, seperti node_modules dan .env, daripada versi.
• .npmignore: Cipta fail .npmignore untuk menentukan fail dan folder yang tidak boleh disertakan dalam pakej NPM.
• README.md: Buat fail dengan maklumat tentang pakej.

Menerbitkan pakej

Log masuk ke NPM menggunakan butiran log masuk anda:

npm init

Jalankan arahan di bawah untuk menerbitkan pakej:

{
  "name": "string-reverser-jm",
  "version": "1.0.0",
  "description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"No test specified\" && exit 1"
  },
  "author": "Juliana Macedo <contact@starcoders.info> (https://www.starcoders.info)",
  "keywords": [
    "string",
    "reverse",
    "utility"
  ],
  "license": "MIT"
}

Baiklah, pakej itu akan tersedia dalam pendaftaran NPM tidak lama lagi!
https://www.npmjs.com/package/string-reverser-jm

Mengemas kini pakej

Apabila membuat kemas kini atau pembetulan pepijat, tingkatkan nombor versi dalam package.json mengikut versi semantik menggunakan salah satu arahan di bawah:

function reverseString(str) {
  if (typeof str !== "string") {
    throw new TypeError("Expected a string as input");
  }
  return str.split("").reverse().join("");
}

module.exports = reverseString;

Dan kemudian terbitkan versi yang dikemas kini:

npm link

Masalah kerap:

• Nama Pakej Sudah Diambil: Jika penerbitan gagal kerana pakej dengan nama yang sama sudah wujud, pilih nama lain, yang belum diambil.
• Ralat Pengesahan: Pastikan anda log masuk dan mempunyai semua kebenaran yang diperlukan untuk menerbitkan.
• Konflik Versi: Jika anda cuba menerbitkan tanpa mengemas kini nombor versi, NPM akan menolak siaran anda. Gunakan versi npm untuk meningkatkan versi.

---

Atas ialah kandungan terperinci Cara menerbitkan pakej ke npm: panduan langkah demi langkah. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!