Construirea unui instrument CLI cu TypeScript

Crearea unui instrument de interfață de linie de comandă (CLI) cu TypeScript oferă siguranță tipului și caracteristici JavaScript moderne. TypeScript îmbunătățește experiența de dezvoltare, oferind tastare statică și un suport mai bun pentru instrumente. Acest ghid acoperă pașii pentru a construi un instrument CLI folosind TypeScript.

Pasul 1: Configurați proiectul TypeScript

Începeți prin a configura un nou proiect TypeScript. Inițializați un nou proiect npm și instalați TypeScript și alte dependențe.

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

Pachetul ts-node permite rularea directă a fișierelor TypeScript, în timp ce @types/node oferă definiții de tip pentru Node.js.

Pasul 2: Creați un Script CLI de bază

Creați un fișier TypeScript care va servi drept punct de intrare pentru instrumentul CLI. Acest fișier va gestiona argumentele liniei de comandă și va implementa funcționalitatea de bază.

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

Aici, pachetul commander este folosit pentru a gestiona argumentele liniei de comandă și pentru a oferi o interfață simplă pentru definirea comenzilor și opțiunilor.

Pasul 3: Adăugați dependențe CLI

Instalați dependențe suplimentare necesare pentru construirea instrumentului CLI. Pentru acest exemplu, commander este folosit pentru analizarea argumentelor.

npm install commander

Pasul 4: Compilați codul TypeScript

Compilați codul TypeScript în JavaScript. Acest pas este necesar pentru distribuirea instrumentului CLI.

npx tsc

Pasul 5: Creați un script executabil

Actualizați fișierul package.json pentru a include o secțiune bin. Această secțiune mapează comanda CLI la fișierul JavaScript compilat.

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

Pasul 6: Testați instrumentul CLI

Conectați instrumentul CLI la nivel local pentru a-l testa înainte de publicare. Utilizați npm link pentru a crea o legătură simbolică în directorul global node_modules.

npm link
my-cli-tool --name TypeScript

Concluzie

Construirea unui instrument CLI cu TypeScript implică configurarea unui proiect TypeScript, crearea unui script CLI de bază, adăugarea de dependențe și compilarea codului. Utilizând tastarea statică și caracteristicile moderne ale TypeScript, este posibil să creați instrumente CLI robuste și care pot fi întreținute.