Bygge et CLI-verktøy med TypeScript

Å lage et kommandolinjegrensesnitt (CLI) med TypeScript gir typesikkerhet og moderne JavaScript-funksjoner. TypeScript forbedrer utviklingsopplevelsen ved å tilby statisk skriving og bedre verktøystøtte. Denne veiledningen dekker trinnene for å bygge et CLI-verktøy ved hjelp av TypeScript.

Trinn 1: Sett opp TypeScript-prosjektet ditt

Begynn med å sette opp et nytt TypeScript-prosjekt. Initialiser et nytt npm-prosjekt og installer TypeScript og andre avhengigheter.

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

ts-node-pakken gjør det mulig å kjøre TypeScript-filer direkte, mens @types/node gir typedefinisjoner for Node.js.

Trinn 2: Lag et grunnleggende CLI-skript

Lag en TypeScript-fil som vil fungere som inngangspunkt for CLI-verktøyet. Denne filen vil håndtere kommandolinjeargumentene og implementere kjernefunksjonaliteten.

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 brukes commander-pakken til å håndtere kommandolinjeargumenter og gi et enkelt grensesnitt for å definere kommandoer og alternativer.

Trinn 3: Legg til CLI-avhengigheter

Installer ytterligere avhengigheter som kreves for å bygge CLI-verktøyet. For dette eksemplet brukes commander for argumentparsing.

npm install commander

Trinn 4: Kompiler TypeScript-kode

Kompiler TypeScript-koden til JavaScript. Dette trinnet er nødvendig for å distribuere CLI-verktøyet.

npx tsc

Trinn 5: Lag et kjørbart skript

Oppdater package.json-filen for å inkludere en bin-seksjon. Denne delen tilordner CLI-kommandoen til den kompilerte JavaScript-filen.

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

Trinn 6: Test CLI-verktøyet ditt

Koble CLI-verktøyet lokalt for å teste det før publisering. Bruk npm link for å lage en symbolkobling i den globale node_modules-katalogen.

npm link
my-cli-tool --name TypeScript

Konklusjon

Å bygge et CLI-verktøy med TypeScript innebærer å sette opp et TypeScript-prosjekt, lage et grunnleggende CLI-skript, legge til avhengigheter og kompilere koden. Ved å utnytte TypeScripts statiske skriving og moderne funksjoner, er det mulig å lage robuste og vedlikeholdbare CLI-verktøy.