Een CLI-tool bouwen met TypeScript
Het maken van een Command-Line Interface (CLI) tool met TypeScript biedt type safety en moderne JavaScript-functies. TypeScript verbetert de ontwikkelervaring door statische typen en betere tooling-ondersteuning te bieden. Deze gids behandelt de stappen om een CLI-tool te bouwen met TypeScript.
Stap 1: Stel uw TypeScript-project in
Begin met het opzetten van een nieuw TypeScript-project. Initialiseer een nieuw npm-project en installeer TypeScript en andere afhankelijkheden.
npm init -y
npm install typescript ts-node @types/node --save-dev
npx tsc --init
Met het pakket ts-node
kunt u TypeScript-bestanden rechtstreeks uitvoeren, terwijl @types/node
typedefinities voor Node.js biedt.
Stap 2: Maak een basis CLI-script
Maak een TypeScript-bestand dat als toegangspunt voor de CLI-tool zal dienen. Dit bestand zal de opdrachtregelargumenten afhandelen en de kernfunctionaliteit implementeren.
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 wordt het pakket commander
gebruikt om opdrachtregelargumenten te verwerken en een eenvoudige interface te bieden voor het definiëren van opdrachten en opties.
Stap 3: CLI-afhankelijkheden toevoegen
Installeer extra afhankelijkheden die nodig zijn voor het bouwen van de CLI-tool. Voor dit voorbeeld wordt commander
gebruikt voor argumentparsing.
npm install commander
Stap 4: TypeScript-code compileren
Compileer de TypeScript-code naar JavaScript. Deze stap is nodig voor het distribueren van de CLI-tool.
npx tsc
Stap 5: Maak een uitvoerbaar script
Werk het bestand package.json
bij om een sectie bin
toe te voegen. Deze sectie wijst de CLI-opdracht toe aan het gecompileerde JavaScript-bestand.
{
"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"
}
}
Stap 6: Test uw CLI-tool
Koppel de CLI-tool lokaal om deze te testen voor publicatie. Gebruik npm link
om een symlink te maken in de globale node_modules
directory.
npm link
my-cli-tool --name TypeScript
Conclusie
Het bouwen van een CLI-tool met TypeScript omvat het opzetten van een TypeScript-project, het maken van een basis-CLI-script, het toevoegen van afhankelijkheden en het compileren van de code. Door gebruik te maken van TypeScript's statische typen en moderne functies, is het mogelijk om robuuste en onderhoudbare CLI-tools te maken.