Cara Mencipta dan Menerbitkan Pakej TypeScript pada NPM

Apabila TypeScript semakin popular, ramai pembangun mencipta pakej bertaip statik untuk memanfaatkan faedah yang ditawarkan oleh bahasa. Dalam siaran ini, kami akan membincangkan proses mencipta dan menerbitkan pakej NPM menggunakan TypeScript.

---

1. Mengkonfigurasi Persekitaran

Pastikan anda memasang Node.js, NPM dan TypeScript. Anda boleh memasang TypeScript secara global dengan:

npm install -g typescript

Periksa sama ada semuanya dipasang dengan betul:

node -v
npm -v
tsc -v

2. Mencipta Projek

Mulakan dengan mencipta direktori untuk projek anda:

mkdir meu-pacote-typescript
cd meu-pacote-typescript

Memulakan projek Node.js:

npm init

Ini akan mencipta fail package.json di mana anda boleh menentukan maklumat pakej asas.

3. Mengkonfigurasi TypeScript

Sekarang, mulakan projek TypeScript:

tsc --init

Ini akan mencipta fail tsconfig.json. Edit mengikut keperluan, tetapi konfigurasi biasa adalah seperti berikut:

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS",
    "declaration": true,
    "outDir": "./dist",
    "strict": true
  },
  "include": ["src/**/*"]
}

Di sini, kami sedang mengkonfigurasi pengkompil TypeScript untuk menjana kod ES6, dengan modul CommonJS, dan menyertakan pengisytiharan jenis (pengisytiharan: benar). Kod yang disusun akan diletakkan dalam direktori dist.

4. Menulis Kod

Buat direktori src dan di dalamnya fail index.ts:

mkdir src
touch src/index.ts

Dalam fail index.ts, tulis kod pakej anda. Mari cipta fungsi mudah untuk menukar rentetan kepada huruf besar:

export function toUpperCase(str: string): string {
  return str.toUpperCase();
}

5. Menyusun Kod

Kompilasi TypeScript kepada JavaScript:

tsc

Ini akan menjana fail JavaScript dan menaip pengisytiharan dalam direktori dist.

6. Menguji Pakej Secara Tempatan

Untuk menguji pakej anda, anda boleh memasangnya secara setempat dalam projek lain:

1. Dalam direktori projek ujian anda, jalankan:

   npm install ../caminho-para-o-diretorio-do-seu-pacote/dist

1. Gunakan fungsi dalam projek ujian:

   import { toUpperCase } from 'nome-do-seu-pacote';

   console.log(toUpperCase('hello world')); // "HELLO WORLD"

Ini memastikan kedua-dua kod JavaScript dan pengisytiharan jenis berfungsi dengan betul.

7. Penerbitan di NPM

Jika semuanya berfungsi dengan betul, anda sudah bersedia untuk menerbitkan pakej anda.

1. Log Masuk NPM

Jika anda belum mempunyai akaun NPM, buat satu dan log masuk:

   npm login

1. Penerbitan

Sebelum menerbitkan, tambahkan skrip binaan pada package.json:

   "scripts": {
     "build": "tsc"
   }

Dan tambahkan laluan output dalam package.json:

   "main": "dist/index.js",
   "types": "dist/index.d.ts"

Sekarang susun dan terbitkan:

   npm run build
   npm publish

Jika nama pakej sudah wujud, anda perlu memilih nama baharu.

8. Mengemaskini Pakej

Untuk menerbitkan versi baharu, tukar versi dalam package.json, jalankan npm run build sekali lagi dan terbitkan:

npm publish

9. Amalan Baik

• Dokumentasi: Sertakan fail README.md yang menerangkan cara menggunakan pakej anda.
• Ujian: Tulis ujian menggunakan rangka kerja seperti Jest untuk memastikan kod berfungsi seperti yang diharapkan.
• Linting: Gunakan alatan seperti ESLint dan Prettier untuk mengekalkan kualiti kod.
• Versi: Ikuti SemVer untuk versi pakej anda.

Kesimpulan

Mencipta dan menerbitkan pakej TypeScript pada NPM bukan sahaja meningkatkan kualiti kod, ia juga menawarkan faedah menaip kepada mereka yang menggunakan pakej anda. Dengan mengikuti panduan ini, anda akan bersedia untuk berkongsi penyelesaian anda dengan komuniti JavaScript dan TypeScript, menyumbang kepada ekosistem pembangunan yang lebih kukuh dan teguh.

Setelah anda mengetahui prosesnya, bagaimana pula dengan mula membina pakej TypeScript anda yang seterusnya?

Atas ialah kandungan terperinci Cara Mencipta dan Menerbitkan Pakej TypeScript pada NPM. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!