Xây dựng công cụ CLI với TypeScript

Tạo công cụ Giao diện dòng lệnh (CLI) bằng TypeScript cung cấp tính năng an toàn kiểu và các tính năng JavaScript hiện đại. TypeScript nâng cao trải nghiệm phát triển bằng cách cung cấp tính năng gõ tĩnh và hỗ trợ công cụ tốt hơn. Hướng dẫn này bao gồm các bước để xây dựng công cụ CLI bằng TypeScript.

Bước 1: Thiết lập dự án TypeScript của bạn

Bắt đầu bằng cách thiết lập một dự án TypeScript mới. Khởi tạo một dự án npm mới và cài đặt TypeScript cùng các phụ thuộc khác.

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

Gói ts-node cho phép chạy trực tiếp các tệp TypeScript, trong khi @types/node cung cấp định nghĩa kiểu cho Node.js.

Bước 2: Tạo một tập lệnh CLI cơ bản

Tạo một tệp TypeScript sẽ đóng vai trò là điểm vào cho công cụ CLI. Tệp này sẽ xử lý các đối số dòng lệnh và triển khai chức năng cốt lõi.

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);

Tại đây, gói commander được sử dụng để xử lý các đối số dòng lệnh và cung cấp giao diện đơn giản để xác định lệnh và tùy chọn.

Bước 3: Thêm phụ thuộc CLI

Cài đặt các phụ thuộc bổ sung cần thiết để xây dựng công cụ CLI. Đối với ví dụ này, commander được sử dụng để phân tích đối số.

npm install commander

Bước 4: Biên dịch mã TypeScript

Biên dịch mã TypeScript thành JavaScript. Bước này là cần thiết để phân phối công cụ CLI.

npx tsc

Bước 5: Tạo một tập lệnh thực thi

Cập nhật tệp package.json để bao gồm phần bin. Phần này ánh xạ lệnh CLI tới tệp JavaScript đã biên dịch.

{
  "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"
  }
}

Bước 6: Kiểm tra công cụ CLI của bạn

Liên kết công cụ CLI cục bộ để kiểm tra trước khi xuất bản. Sử dụng npm link để tạo liên kết tượng trưng trong thư mục node_modules toàn cục.

npm link
my-cli-tool --name TypeScript

Phần kết luận

Xây dựng công cụ CLI bằng TypeScript bao gồm thiết lập dự án TypeScript, tạo tập lệnh CLI cơ bản, thêm các phụ thuộc và biên dịch mã. Bằng cách tận dụng kiểu tĩnh và các tính năng hiện đại của TypeScript, có thể tạo các công cụ CLI mạnh mẽ và dễ bảo trì.