Opbygning af et CLI-værktøj med TypeScript

Oprettelse af et Command-Line Interface-værktøj (CLI) med TypeScript giver typesikkerhed og moderne JavaScript-funktioner. TypeScript forbedrer udviklingsoplevelsen ved at tilbyde statisk skrivning og bedre værktøjsunderstøttelse. Denne vejledning dækker trinene til at bygge et CLI-værktøj ved hjælp af TypeScript.

Trin 1: Konfigurer dit TypeScript-projekt

Begynd med at opsætte et nyt TypeScript-projekt. Initialiser et nyt npm-projekt og installer TypeScript og andre afhængigheder.

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

ts-node-pakken giver mulighed for at køre TypeScript-filer direkte, mens @types/node giver typedefinitioner for Node.js.

Trin 2: Opret et grundlæggende CLI-script

Opret en TypeScript-fil, der vil tjene som indgangspunkt for CLI-værktøjet. Denne fil vil håndtere kommandolinjeargumenterne og implementere kernefunktionaliteten.

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

Her bruges commander-pakken til at håndtere kommandolinjeargumenter og give en enkel grænseflade til at definere kommandoer og muligheder.

Trin 3: Tilføj CLI-afhængigheder

Installer yderligere afhængigheder, der kræves for at bygge CLI-værktøjet. I dette eksempel bruges commander til argumentparsing.

npm install commander

Trin 4: Kompiler TypeScript-kode

Kompiler TypeScript-koden til JavaScript. Dette trin er nødvendigt for at distribuere CLI-værktøjet.

npx tsc

Trin 5: Opret et eksekverbart script

Opdater filen package.json til at inkludere en bin sektion. Dette afsnit knytter CLI-kommandoen til den kompilerede JavaScript-fil.

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

Trin 6: Test dit CLI-værktøj

Link CLI-værktøjet lokalt for at teste det før udgivelse. Brug npm link til at oprette et symbollink i det globale node_modules bibliotek.

npm link
my-cli-tool --name TypeScript

Konklusion

Opbygning af et CLI-værktøj med TypeScript involverer opsætning af et TypeScript-projekt, oprettelse af et grundlæggende CLI-script, tilføjelse af afhængigheder og kompilering af koden. Ved at udnytte TypeScripts statiske indtastning og moderne funktioner er det muligt at skabe robuste og vedligeholdelige CLI-værktøjer.