Erstellen eines CLI-Tools mit TypeScript

Das Erstellen eines Befehlszeilenschnittstellen-Tools (CLI) mit TypeScript bietet Typensicherheit und moderne JavaScript-Funktionen. TypeScript verbessert das Entwicklungserlebnis, indem es statische Typisierung und bessere Toolunterstützung bietet. In diesem Handbuch werden die Schritte zum Erstellen eines CLI-Tools mit TypeScript beschrieben.

Schritt 1: Richten Sie Ihr TypeScript-Projekt ein

Beginnen Sie mit der Einrichtung eines neuen TypeScript-Projekts. Initialisieren Sie ein neues npm-Projekt und installieren Sie TypeScript und andere Abhängigkeiten.

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

Das Paket ts-node ermöglicht das direkte Ausführen von TypeScript-Dateien, während @types/node Typdefinitionen für Node.js bereitstellt.

Schritt 2: Erstellen Sie ein einfaches CLI-Skript

Erstellen Sie eine TypeScript-Datei, die als Einstiegspunkt für das CLI-Tool dient. Diese Datei verarbeitet die Befehlszeilenargumente und implementiert die Kernfunktionalität.

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

Hier wird das Paket commander verwendet, um Befehlszeilenargumente zu verarbeiten und eine einfache Schnittstelle zum Definieren von Befehlen und Optionen bereitzustellen.

Schritt 3: CLI-Abhängigkeiten hinzufügen

Installieren Sie zusätzliche Abhängigkeiten, die zum Erstellen des CLI-Tools erforderlich sind. In diesem Beispiel wird commander zum Argumentparsing verwendet.

npm install commander

Schritt 4: TypeScript-Code kompilieren

Kompilieren Sie den TypeScript-Code in JavaScript. Dieser Schritt ist für die Verteilung des CLI-Tools erforderlich.

npx tsc

Schritt 5: Erstellen Sie ein ausführbares Skript

Aktualisieren Sie die Datei package.json, um einen Abschnitt bin einzuschließen. Dieser Abschnitt ordnet den CLI-Befehl der kompilierten JavaScript-Datei zu.

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

Schritt 6: Testen Sie Ihr CLI-Tool

Verknüpfen Sie das CLI-Tool lokal, um es vor der Veröffentlichung zu testen. Verwenden Sie npm link, um einen symbolischen Link im globalen Verzeichnis node_modules zu erstellen.

npm link
my-cli-tool --name TypeScript

Abschluss

Zum Erstellen eines CLI-Tools mit TypeScript müssen Sie ein TypeScript-Projekt einrichten, ein grundlegendes CLI-Skript erstellen, Abhängigkeiten hinzufügen und den Code kompilieren. Durch die Nutzung der statischen Typisierung und der modernen Funktionen von TypeScript können Sie robuste und wartungsfreundliche CLI-Tools erstellen.