Membangun Alat CLI dengan TypeScript

Membuat alat Command-Line Interface (CLI) dengan TypeScript menyediakan keamanan tipe dan fitur JavaScript modern. TypeScript meningkatkan pengalaman pengembangan dengan menawarkan pengetikan statis dan dukungan perkakas yang lebih baik. Panduan ini membahas langkah-langkah untuk membuat alat CLI menggunakan TypeScript.

Langkah 1: Siapkan Proyek TypeScript Anda

Mulailah dengan menyiapkan proyek TypeScript baru. Inisialisasi proyek npm baru dan instal TypeScript serta dependensi lainnya.

npm init -y
npm install typescript ts-node @types/node --save-dev
npx tsc --init

Paket ts-node memungkinkan untuk menjalankan file TypeScript secara langsung, sementara @types/node menyediakan definisi tipe untuk Node.js.

Langkah 2: Buat Skrip CLI Dasar

Buat file TypeScript yang akan berfungsi sebagai titik masuk untuk alat CLI. File ini akan menangani argumen baris perintah dan mengimplementasikan fungsionalitas inti.

import { Command } from 'commander';

const program = new Command();

program
  .version('1.0.0')
  .description('A simple CLI tool')
  .option('-n, --name <name>', 'Specify the name')
  .action((options) => {
    console.log(`Hello, ${options.name || 'World'}!`);
  });

program.parse(process.argv);

Di sini, paket commander digunakan untuk menangani argumen baris perintah dan menyediakan antarmuka sederhana untuk mendefinisikan perintah dan opsi.

Langkah 3: Tambahkan Ketergantungan CLI

Instal dependensi tambahan yang diperlukan untuk membangun alat CLI. Untuk contoh ini, commander digunakan untuk penguraian argumen.

npm install commander

Langkah 4: Kompilasi Kode TypeScript

Kompilasi kode TypeScript ke dalam JavaScript. Langkah ini diperlukan untuk mendistribusikan alat CLI.

npx tsc

Langkah 5: Buat Skrip yang Dapat Dieksekusi

Perbarui berkas package.json untuk menyertakan bagian bin. Bagian ini memetakan perintah CLI ke berkas JavaScript yang dikompilasi.

{
  "name": "my-cli-tool",
  "version": "1.0.0",
  "bin": {
    "my-cli-tool": "./dist/index.js"
  },
  "scripts": {
    "build": "tsc",
    "start": "ts-node src/index.ts"
  },
  "dependencies": {
    "commander": "^8.3.0"
  },
  "devDependencies": {
    "@types/node": "^14.14.31",
    "typescript": "^4.3.5",
    "ts-node": "^10.2.1"
  }
}

Langkah 6: Uji Alat CLI Anda

Hubungkan alat CLI secara lokal untuk mengujinya sebelum menerbitkannya. Gunakan npm link untuk membuat tautan simbolik di direktori global node_modules.

npm link
my-cli-tool --name TypeScript

Kesimpulan

Membangun alat CLI dengan TypeScript melibatkan penyiapan proyek TypeScript, pembuatan skrip CLI dasar, penambahan dependensi, dan kompilasi kode. Dengan memanfaatkan pengetikan statis dan fitur-fitur modern TypeScript, dimungkinkan untuk membuat alat CLI yang tangguh dan mudah dirawat.