Створення інструменту CLI за допомогою TypeScript

Створення інструменту інтерфейсу командного рядка (CLI) за допомогою TypeScript забезпечує безпеку типів і сучасні функції JavaScript. TypeScript покращує досвід розробки, пропонуючи статичний тип і покращену підтримку інструментів. Цей посібник описує кроки для створення інструменту CLI за допомогою TypeScript.

Крок 1: Налаштуйте проект TypeScript

Почніть із налаштування нового проекту TypeScript. Ініціалізуйте новий проект npm і встановіть TypeScript та інші залежності.

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

Пакет ts-node дозволяє запускати файли TypeScript безпосередньо, а @types/node надає визначення типів для Node.js.

Крок 2: Створіть базовий сценарій CLI

Створіть файл TypeScript, який слугуватиме точкою входу для інструменту CLI. Цей файл оброблятиме аргументи командного рядка та реалізовуватиме основні функції.

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

Тут пакет commander використовується для обробки аргументів командного рядка та забезпечує простий інтерфейс для визначення команд і параметрів.

Крок 3: Додайте залежності CLI

Установіть додаткові залежності, необхідні для створення інструменту CLI. У цьому прикладі commander використовується для аналізу аргументів.

npm install commander

Крок 4: Скомпілюйте код TypeScript

Скомпілюйте код TypeScript у JavaScript. Цей крок необхідний для розповсюдження інструменту CLI.

npx tsc

Крок 5: Створіть виконуваний сценарій

Оновіть файл package.json, щоб включити розділ bin. Цей розділ відображає команду CLI на скомпільований файл JavaScript.

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

Крок 6. Перевірте свій інструмент CLI

Зв’яжіть інструмент CLI локально, щоб перевірити його перед публікацією. Використовуйте npm link, щоб створити символічне посилання в глобальному каталозі node_modules.

npm link
my-cli-tool --name TypeScript

Висновок

Створення інструменту CLI за допомогою TypeScript передбачає налаштування проекту TypeScript, створення базового сценарію CLI, додавання залежностей і компіляції коду. Використовуючи статичну типізацію TypeScript і сучасні функції, можна створювати надійні інструменти CLI, які зручно підтримувати.