使用nodejs开发cli项目实例

下面是使用nodejs开发cli项目的完整攻略：

什么是CLI项目？

CLI（Command Line Interface）是指通过命令行界面与程序交互的方式。CLI项目是为命令行界面设计的应用程序。使用CLI项目可以在终端中执行特定的命令，实现特定的功能，比如，创建文件、删除文件、安装软件等。

开始构建CLI项目

创建项目文件夹

在终端中选择一个合适的位置，使用以下命令创建项目文件夹：

mkdir myCLI

初始化项目

在项目文件夹中执行以下命令初始化一个npm项目：

npm init -y

安装依赖

在终端中执行以下命令安装所需的依赖：

npm install commander inquirer chalk --save

上面这条命令用来安装使用CLI必备的三个npm模块：commander、inquirer和chalk。

创建代码文件

在项目文件夹内创建一个index.js文件。该文件将包含整个项目的代码。

编写CLI程序

编写CLI程序的过程可以看成是两个部分：定义命令和编写命令处理函数。

定义命令

在项目的index.js文件中编写以下代码，以定义CLI程序要支持的命令：

const { program } = require('commander');
program.version('0.1.0');

program
  .command('create <name>')
  .description('create a new project')
  .option('-s, --style <style>', 'add style language support')
  .option('-f, --force', 'overwrite existing files')
  .action((name, options) => {
    console.log('run create command', name, options);
  });

program.parse(process.argv);

上面这段代码定义了一个create命令，用于创建新的项目。该命令包含两个选项：-s和-f，在创建项目时可以使用这两个选项来指定一些参数。该命令使用console.log()函数来输出命令执行时的一些信息。

编写命令处理函数

在上面的代码中，以.action()方法指定了一个回调函数，在命令执行时将被调用。下面是一个示例回调函数：

const fs = require('fs');
const { promisify } = require('util');
const chalk = require('chalk');
const inquirer = require('inquirer');

const writeFile = promisify(fs.writeFile);

async function createApp(name, options) {
  // 检查是否指定了文件夹名字
  if (!name) {
    console.log(chalk.red('Please specify the project name'));
    return;
  }
  // 检查文件夹是否已存在
  const exists = fs.existsSync(name);
  if (exists && options.force) {
    console.log(chalk.yellow('Project exists, but overwriting existing files'));
    await createFiles(name); // 在已存在的文件夹中创建项目文件
    console.log(chalk.green('Project created successfully!'));
  } else if (exists) {
    console.log(chalk.red('Project already exists, please use another name or use the --force option to overwrite existing files!'));
  } else {
    await createFiles(name); // 创建一个新的文件夹和项目文件
    console.log(chalk.green('Project created successfully!'));
  }
}

async function createFiles(name) {
  // 创建新的文件夹
  fs.mkdirSync(name);

  // 创建package.json文件
  const pkg = {
    name,
    description: name,
    version: '1.0.0',
    scripts: {
      start: 'node index.js'
    },
    dependencies: {},
    devDependencies: {}
  };
  await writeFile(`${name}/package.json`, JSON.stringify(pkg, null, 2));

  // 创建index.js文件
  await writeFile(`${name}/index.js`, `console.log("Hello, ${name}!");\n`);
  console.log(chalk.green('Project files created successfully!'));
}

上面这段代码中，createApp()函数是实现“创建项目”逻辑的核心代码。在该函数中，主要做三件事：

检查是否指定了文件夹名字；
检查文件夹是否已存在，如果已存在，根据选项来覆盖原来的文件夹或者提示错误信息；
在文件夹中创建项目文件。

createFiles()函数是具体用来创建项目文件的代码。

测试CLI程序

在完成编写CLI程序的过程以后，我们需要在终端中测试该程序。在终端中执行以下命令安装该程序：

npm install -g .

其中的“.”意味着将当前目录下的文件安装为全局模块。

安装好后，我们在终端中执行以下命令：

myCLI create myproject

执行该命令后，我们可以在当前目录下看到myproject文件夹被创建。如果多次执行同样的命令，可以看到不同的输出结果。

示例说明

下面我们通过两个实际例子说明如何使用nodejs开发CLI项目：

1. 创建文本文件

本例子中，我们将开发一个CLI程序用来在终端中创建文本文件。该程序需要接受文件名参数和文本内容参数，以便在特定位置创建一个文本文件，并把特定内容写入到该文件中。

首先初始化一个npm项目并安装需要的依赖：

npm init -y
npm install commander --save

然后，我们在项目根目录下创建一个index.js文件。在该文件中，我们定义了create命令，用于创建文本文件。该命令接收两个参数：文件名和文件内容，文件名是必需的，文件内容是可选的。如果不提供文件内容，则会创建一个空文件。

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

program
  .command('create <filename> [content]')
  .description('create a new text file')
  .action((filename, content) => {
    console.log(`creating file "${filename}" with content "${content}"`);
    fs.writeFile(filename, content, function (err) {
      if (err) throw err;
      console.log('file saved!');
    });
  });

program.parse(process.argv);

当运行该程序时，我们需要在终端中输入以下命令：

node index.js create myFile.txt "Hello, world!"

这条命令将在当前目录下创建一个名为myFile.txt的文本文件，并将“Hello, world!”这个字符串写入到文件中。另外，如果只想创建一个空文件，则可以省略第二个参数。此时终端中的命令将变成：

node index.js create myFile.txt

2. 下载图片

本例子中，我们将开发一个CLI程序用来从图片URL中下载图片。我们将使用request和fs-extra两个扩展模块来实现该程序。

首先初始化一个npm项目并安装所需的依赖：

npm init -y
npm install commander request fs-extra --save

然后在项目根目录下创建一个index.js文件，该文件中我们定义了download命令。该命令接收一个参数：图片URL。在下载图片之前，先判断指定的文件夹是否存在，如果不存在则创建该文件夹。然后将图片下载并保存到该文件夹中。图片的名字将自动根据URL构建。

const fs = require('fs-extra');
const request = require('request');
const { program } = require('commander');

program
  .command('download <url>')
  .description('download an image')
  .action(async url => {
    const path = './images/';
    if (!fs.existsSync(path)) {
      fs.mkdirSync(path);
    }
    const imageName = url.split('/').pop();
    const dest = path + imageName;
    request(url)
      .pipe(fs.createWriteStream(dest))
      .on('close', () => {
        console.log('Image downloaded successfully!');
      })
      .on('error', err => {
        console.log(err.message);
      });
  });

program.parse(process.argv);