如何从0开始用node写一个自己的命令行程序

当我们谈到命令行程序时，我们通常需要使用 Node.js 来实现。本文将介绍如何从零开始编写一个 Node.js 命令行程序，并提供两个示例程序。

步骤

第一步：初始化项目

为了开始编写 Node.js 命令行程序，您需要创建一个新的 Node.js 项目。通过在终端中导航到您的项目目录并运行以下命令，您可以初始化一个新项目：

npm init

这会提示您提供一些信息，例如项目名称，版本和入口文件。您可以保留大部分选项的默认设置，但需要确保输入正确的入口文件。

第二步：安装依赖项

现在您的项目已初始化，可以安装所需的依赖项。为了创建命令行程序，您需要安装 Commander.js。Commander.js 可以帮助您处理命令行参数和选项。

npm install --save commander

第三步：创建 Commander.js 实例

接下来，您需要在入口文件中引入 Commander.js 并创建一个新的 Commander.js 实例。然后，您可以使用实例的 .command() 和 .option() 方法来添加命令和选项。

以下是一个简单示例程序，该程序定义了一个名为 hello 的命令，该命令可接受一个名字作为参数，并输出“Hello, [name]!” 的字符串：

#!/usr/bin/env node

const { program } = require('commander');

program
  .command('hello <name>')
  .description('output "Hello, [name]!"')
  .action((name) => {
    console.log(`Hello, ${name}!`);
  });

program.parse(process.argv);

第四步：运行程序

一旦您的程序定义了一些命令和选项，您可以运行它以处理命令行参数。您可以通过在终端中输入 ./index.js [command] [options] 来运行您的程序。注意，您需要将 ./index.js 替换为您的入口文件名称。

例如，在我们的示例程序中，我们可以尝试使用以下命令来输出“Hello, world!” 的字符串：

./index.js hello world

这应该会输出以下内容：

Hello, world!

您还可以运行以下命令以显示帮助文档：

./index.js --help

这应该会输出您程序定义的命令和选项的详细信息。

示例

示例一：计算器

以下示例程序是一个简单的命令行计算器。该程序接受两个数字和操作符作为参数，并输出结果。

#!/usr/bin/env node

const { program } = require('commander');

program
  .command('add <num1> <num2>')
  .description('add two numbers')
  .action((num1, num2) => {
    console.log(Number(num1) + Number(num2));
  });

program
  .command('subtract <num1> <num2>')
  .description('subtract two numbers')
  .action((num1, num2) => {
    console.log(Number(num1) - Number(num2));
  });

program.parse(process.argv);

使用以下命令，您可以将两个数字相加：

./index.js add 2 3

这应该会输出 5。

使用以下命令，您可以从一个数字中减去另一个数字：

./index.js subtract 5 3

这应该会输出 2。

示例二：To-do List

以下示例程序是一个简单的命令行 To-do List 应用程序。该程序允许您添加，删除和列出待办事项。

#!/usr/bin/env node

const { program } = require('commander');

let todos = [];

program
  .command('add <text>')
  .description('add a new todo item')
  .action((text) => {
    todos.push(text);
    console.log(`Added "${text}" to the todo list.`);
  });

program
  .command('remove <index>')
  .description('remove a todo item')
  .action((index) => {
    const removed = todos.splice(index, 1);
    console.log(`Removed "${removed}" from the todo list.`);
  });

program
  .command('list')
  .description('list all todo items')
  .action(() => {
    console.log("Todo list:");
    todos.forEach((todo, index) => console.log(`[${index}] ${todo}`));
  });

program.parse(process.argv);

使用以下命令，您可以将一个新待办事项添加到列表中：

./index.js add "Buy milk"

如果您要删除列表中的一个项目，请使用以下命令：

./index.js remove 0

这将删除第一个待办事项。

使用以下命令，您可以列出当前列表中的所有项目：

./index.js list

这将输出类似以下内容的信息：

Todo list:
[0] Buy milk

结论

现在您已经学会了如何创建一个简单的 Node.js 命令行程序并运行它。虽然本文提供了两个简单的示例程序，但使用 Node.js，您可以创建各种各样的实用程序和工具。