JavaScript是一种为网络开发的语言,但它的用处已经远远超出了互联网的范畴。由于Node.js和Electron这样的项目,JavaScript既是一种通用的脚本语言,也是一种浏览器组件。有专门设计的JavaScript库来构建命令行界面。是的,你可以在你的终端中运行JavaScript。
现在,当你在终端输入一个命令时,一般都有一些选项,也叫_开关_或_标志_,你可以用它们来修改命令的运行方式。这是由POSIX规范定义的一个有用的惯例,所以作为一个程序员,知道如何检测和解析这些选项是很有帮助的。为了从JavaScript中获得这种功能,使用一个旨在使建立命令行界面变得容易的库是很有用的。我最喜欢的是Commander.js。它很简单,很灵活,而且很直观。
安装node
要使用Commander.js库,你必须安装Node.js。在Linux上,你可以用你的软件包管理器安装Node。例如,在Fedora、CentOS、Mageia和其他系统上。
$ sudo dnf install nodejs
在Windows和macOS上,你可以从nodejs.org网站下载安装程序。
安装Commander.js
要安装Commander.js,请使用npm 命令。
$ npm install commander
在你的JavaScript代码中添加一个库
在JavaScript中,你可以使用require 关键字,将一个库纳入(或导入,如果你习惯于Python)你的代码中。创建一个名为example.js 的文件,并在你喜欢的文本编辑器中打开它。在顶部添加这一行,以包括Commander.js库。
const { program } = require('commander');
JavaScript中的选项解析
要解析选项,你必须做的第一件事是定义你的应用程序可以接受的有效选项。Commander.js库让你定义短的和长的选项,同时还有一个有用的信息来澄清每个选项的目的。
program
.description('A sample application to parse options')
.option('-a, --alpha', 'Alpha')
.option('-b, --beta ', 'Specify a VALUE', 'Foo');
第一个选项,我称之为--alpha (简称-a ),是一个布尔型开关。它要么存在,要么不存在。它不需要任何参数。第二个选项,我称之为--beta ( 简称-b ),接受一个参数,甚至在你没有提供任何参数的情况下指定一个默认值。
访问命令行数据
一旦你定义了有效的选项,你就可以使用长的选项名称来引用这些值。
program.parse();
const options = program.opts();
console.log('Options detected:');
if (options.alpha) console.log('alpha');
const beta = !options.beta ? 'no' : options.beta;
console.log('beta is: %s', beta);
运行该程序
试着用node 命令来运行它,首先不使用选项。
$ node ./example.js
Options detected:
beta is: Foo
在没有用户覆盖的情况下,会使用beta 的默认值。
再次运行它,这次使用选项。
$ node ./example.js --beta hello --alpha
Options detected:
alpha
beta is: hello
这一次,测试脚本成功地检测到了选项--alpha ,并使用用户提供的值检测了--beta 选项。
选项解析
下面是完整的演示代码供你参考。
const { program } = require('commander');
program
.description('A sample application to parse options')
.option('-a, --alpha', 'Alpha')
.option('-b, --beta ', 'Specify a VALUE', 'Foo');
program.parse();
const options = program.opts();
console.log('Options detected:');
console.log(typeof options);
if (options.alpha) console.log(' * alpha');
const beta = !options.beta ? 'no' : options.beta;
console.log(' * beta is: %s', beta);
在项目的Git存储库中还有更多的例子。
对任何应用程序来说,包括用户的选项都是一个重要的功能,而Commander.js使它很容易做到。除了Commander.js,还有其他库,但我觉得这个库使用起来很简单、很快捷。你最喜欢的JavaScript命令行构建器是什么?