使用 TypeScript 构建 CLI 工具

使用 TypeScript 创建命令行界面 (CLI) 工具可提供类型安全性和现代 JavaScript 功能。TypeScript 通过提供静态类型和更好的工具支持来增强开发体验。本指南介绍了使用 TypeScript 构建 CLI 工具的步骤。

步骤 1：设置你的 TypeScript 项目

首先设置一个新的 TypeScript 项目。初始化一个新的 npm 项目并安装 TypeScript 和其他依赖项。

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

ts-node 包允许直接运行 TypeScript 文件，而 @types/node 为 Node.js 提供类型定义。

第 2 步：创建基本 CLI 脚本

创建一个 TypeScript 文件，作为 CLI 工具的入口点。此文件将处理命令行参数并实现核心功能。

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

这里，commander包用于处理命令行参数并提供定义命令和选项的简单接口。

步骤 3：添加 CLI 依赖项

安装构建 CLI 工具所需的其他依赖项。在此示例中，commander 用于参数解析。

npm install commander

步骤 4：编译 TypeScript 代码

将 TypeScript 代码编译为 JavaScript。此步骤对于分发 CLI 工具是必需的。

npx tsc

步骤 5：创建可执行脚本

更新 package.json 文件以包含 bin 部分。此部分将 CLI 命令映射到已编译的 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"
  }
}

步骤 6：测试您的 CLI 工具

在发布之前，在本地链接 CLI 工具以进行测试。使用 npm link 在全局 node_modules 目录中创建符号链接。

npm link
my-cli-tool --name TypeScript

结论

使用 TypeScript 构建 CLI 工具涉及设置 TypeScript 项目、创建基本 CLI 脚本、添加依赖项以及编译代码。通过利用 TypeScript 的静态类型和现代功能，可以创建强大且易于维护的 CLI 工具。