Tworzenie narzędzia CLI przy użyciu TypeScript
Tworzenie narzędzia interfejsu wiersza poleceń (CLI) za pomocą TypeScript zapewnia bezpieczeństwo typów i nowoczesne funkcje JavaScript. TypeScript ulepsza środowisko programistyczne, oferując statyczne typowanie i lepsze wsparcie narzędzi. Ten przewodnik obejmuje kroki tworzenia narzędzia CLI za pomocą TypeScript.
Krok 1: Skonfiguruj swój projekt TypeScript
Zacznij od skonfigurowania nowego projektu TypeScript. Zainicjuj nowy projekt npm i zainstaluj TypeScript i inne zależności.
npm init -y
npm install typescript ts-node @types/node --save-dev
npx tsc --init
Pakiet ts-node
umożliwia bezpośrednie uruchamianie plików TypeScript, natomiast @types/node
zawiera definicje typów dla Node.js.
Krok 2: Utwórz podstawowy skrypt CLI
Utwórz plik TypeScript, który będzie służył jako punkt wejścia dla narzędzia CLI. Ten plik będzie obsługiwał argumenty wiersza poleceń i implementował podstawową funkcjonalność.
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);
W tym przypadku pakiet commander
służy do obsługi argumentów wiersza poleceń i udostępnia prosty interfejs do definiowania poleceń i opcji.
Krok 3: Dodaj zależności CLI
Zainstaluj dodatkowe zależności wymagane do zbudowania narzędzia CLI. W tym przykładzie do analizy argumentów użyto commander
.
npm install commander
Krok 4: Kompilacja kodu TypeScript
Skompiluj kod TypeScript do JavaScript. Ten krok jest konieczny do dystrybucji narzędzia CLI.
npx tsc
Krok 5: Utwórz skrypt wykonywalny
Zaktualizuj plik package.json
, aby uwzględnić sekcję bin
. Ta sekcja mapuje polecenie CLI na skompilowany plik JavaScript.
{
"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"
}
}
Krok 6: Przetestuj narzędzie CLI
Połącz narzędzie CLI lokalnie, aby je przetestować przed publikacją. Użyj npm link
, aby utworzyć dowiązanie symboliczne w globalnym katalogu node_modules
.
npm link
my-cli-tool --name TypeScript
Wniosek
Tworzenie narzędzia CLI z TypeScript obejmuje skonfigurowanie projektu TypeScript, utworzenie podstawowego skryptu CLI, dodanie zależności i skompilowanie kodu. Wykorzystując statyczne typowanie i nowoczesne funkcje TypeScript, możliwe jest tworzenie solidnych i łatwych w utrzymaniu narzędzi CLI.