介绍
在前端开发中，我们经常会使用一些 npm 包来提高开发效率。今天我们要介绍的是 lexcli，一款快速构建 CLI（命令行界面）应用的 npm 包。通过使用 lexcli，我们可以方便地构建各类命令行工具，例如模板生成器、代码打包、构建工具等。本文将介绍如何使用 lexcli 构建一个简单的命令行工具，并说明其中的原理和使用技巧。
安装
在使用 lexcli 之前，我们需要先安装它。可以通过以下命令进行安装：
npm install lexcli --save-dev
基本用法
使用 lexcli 构建命令行工具的基本流程如下：
- 定义命令清单
- 解析输入参数
- 执行对应命令
定义命令清单
在使用 lexcli 构建命令行工具时，我们需要先定义需要支持的命令。可以通过 lexcli.addCommand(name, args, description, action) 方法添加命令，其中：
name为命令名称args为命令参数description为命令描述，用于在命令行中展示action为命令执行函数，接收命令参数作为输入，返回执行结果
例如，我们需要定义一个简单的 echo 命令，用于将输入的参数原样输出。可以使用以下代码进行定义：
const lexcli = require('lexcli')
lexcli.addCommand('echo', '[text...]', 'Output the input text', console.log)在上面的代码中，我们通过 lexcli.addCommand() 方法定义了一个名为 echo 的命令，它需要接收一个 text... 参数，并将参数原样输出。
解析输入参数
在添加完命令后，我们需要解析输入的参数并选择对应的命令进行执行。可以使用 lexcli.parseCommands(commands, defaultCommand) 方法解析输入的参数，其中：
commands为命令清单，是一个数组，每个元素为一个包含name、args、description、action属性的对象，即命令定义对象defaultCommand为空时，将显示命令列表和使用说明；不为空时，将直接执行指定命令
例如，我们可以通过以下代码解析输入参数并进行操作：
lexcli.parseCommands(lexcli.commands, 'echo "Hello, world!"')
在上面的代码中，我们通过 lexcli.parseCommands() 方法对输入参数进行解析，并指定了默认的命令为 echo "Hello, world!"，从而直接输出字符串 Hello, world!。
执行对应命令
在解析输入参数后，lexcli 将自动根据输入的参数选择对应的命令进行执行。例如，如果我们输入 echo "Hello, world!"，lexcli 将自动调用命令定义中相关的方法（在上面的代码中是 console.log）将参数输出到命令行界面。
高级用法
除了基本用法外，lexcli 还提供了一些高级用法，包括自定义参数解析、设置命令别名和更改输出流等。
自定义参数解析
lexcli 默认采用类似 Unix shell 的参数解析规则，即将 -a 和 --arg 形式的参数解析为 { a: true } 和 { arg: true } 对象。如果需要自定义参数解析规则，可以通过 lexcli.parseArgs(args, options) 方法自定义参数解析函数，其中：
args为要解析的参数options为自定义参数解析选项，包含以下属性：boolean：布尔型参数名的数组，例如['isPrivate', 'isDebug']string：字符串型参数名的数组，例如['name', 'prefix']alias：参数别名的对象，例如{ v: 'verbose' }default：默认参数的对象，例如{ port: 8888 }
例如，我们可以使用以下代码自定义参数解析规则：
const lexcli = require('lexcli')
lexcli.parseArgs(['--name', 'apple', '-p', '8080'], {
boolean: ['isPrivate'],
string: ['name', 'prefix'],
alias: { p: 'port' },
default: { port: 8080 }
})在上面的代码中，我们使用 lexcli.parseArgs() 方法自定义了参数解析规则。通过 boolean、string、alias 和 default 属性可以分别定义布尔型参数名、字符串型参数名、参数别名和默认参数。例如，上方指定了 name 参数为字符串型，将 -p 参数别名设置为 port，将 port 的默认值设置为 8080。
设置命令别名
除了默认的命令名称外，我们还可以为命令设置别名，从而提高使用的灵活性。可以通过 lexcli.addAlias(alias) 方法为命令设置别名，其中：
alias为别名对象，包含多个属性，每个属性表示一个命令别名，属性名为别名，属性值为实际命令名称
例如，我们可以通过以下代码设置命令别名：
const lexcli = require('lexcli')
lexcli.addAlias({
e: 'echo', // echors 表示 echo
build: 'npm run build', // build 表示运行 npm run build
start: 'node server.js' // start 表示运行 node server.js
})在上面的代码中，我们将 e 命令别名设置为 echo，将 build 和 start 分别设置为 npm run build 和 node server.js。
更改输出流
默认情况下，命令行工具将输出到控制台。如果需要将输出流重定向到其他地方，可以通过 lexcli.setStream(stdout, stderr) 方法设置输出流，其中：
stdout为标准输出流，例如process.stdoutstderr为标准错误流，例如process.stderr
例如，我们可以通过以下代码将输出流重定向到文件中：
const fs = require('fs')
const lexcli = require('lexcli')
const logFile = fs.createWriteStream('./mylog.log')
lexcli.setStream(logFile, logFile)在上面的代码中，我们使用 fs.createWriteStream() 方法创建一个名为 mylog.log 的文件，然后通过 lexcli.setStream() 方法将输出流重定向到该文件中。
示例代码
下面是一个完整的使用 lexcli 构建的命令行工具示例：
-- -------------------- ---- ------- ----- ------ - ----------------- ------------------------- ------------ ------- --- ----- ------ ------------ ------------------------ ---- ----- ---------- --- --- -- - --- --- ------ -- - ----- - -- - - - - - ---- ----------------------- - ------------ -- ------------------------------------- ---- -- ----
在上面的代码中，我们定义了一个名为 echo 的命令用于输出输入的参数，并定义了一个名为 sum 的命令用于计算输入参数的和。我们首先解析输入参数，接着使用默认的命令，即执行 sum 10 20，输出结果 30。
结论
通过本文的介绍，我们可以了解到如何使用 lexcli 这款 npm 包构建 CLI 应用。在实际使用中，我们可以根据自己的需求加入更多的自定义功能，例如自定义参数解析规则、设置命令别名或更改输出流等。希望本文对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005601781e8991b448de363