详解Node.js如何开发命令行工具


Posted in Javascript onAugust 14, 2016

前言

Node 给前端开发带来了很大的改变,促进了前端开发的自动化,我们可以简化开发工作,然后利用各种工具包生成生产环境。如运行sass src/sass/main.scss dist/css/main.css即可编译 Sass 文件。

在实际的开发过程中,我们可能会有自己的特定需求,

那么我们得学会如何创建一个Node命令行工具。

hello world

老规矩第一个程序为hello world。在工程中新建bin目录,在该目录下创建名为helper的文件,具体内容如下:

#!/usr/bin/env node

console.log('hello world');

修改helper文件的权限:

$ chmod 755 ./bin/helper

执行helper文件,终端将会显示hello world

$ ./bin/helper
hello world

符号链接

接下来我们创建一个符号链接,在全局的node_modules目录之中,生成一个符号链接,指向模块的本地目录,使我们可以直接使用helper命令。

在工程的package.json文件中添加bin字段:

{
 "name": "helper",
 "bin": {
 "helper": "bin/helper"
 }
}

在当前工程目录下执行npm link命令,为当前模块创建一个符号链接:

$ npm link

/node_path/bin/helper -> /node_path/lib/node_modules/myModule/bin/helper
/node_path/lib/node_modules/myModule -> /Users/ipluser/myModule

现在我们可以直接使用helper命令:

$ helper
hello world

commander模块

为了更高效的编写命令行工具,我们使用TJ大神的commander模块。

$ npm install --save commander

helper文件内容修改为:

#!/usr/bin/env node

var program = require('commander');

program
 .version('1.0.0')
 .parse(process.argv);

执行helper -hhelper -V命令:

$ helper -h

 Usage: helper [options]

 Options:

 -h, --help  output usage information
 -V, --version output the version number

$ helper -V
1.0.0

commander模块提供-h, --help-V, --version两个内置命令。

创建命令

创建一个helper hello <author>的命令,当用户输入helper hello ipluser时,终端显示hello ipluser。修改helper文件内容:

#!/usr/bin/env node

var program = require('commander');

program
 .version('1.0.0')
 .usage('<command> [options]')
 .command('hello', 'hello the author') // 添加hello命令
 .parse(process.argv);

bin目录下新建helper-hello文件:

#!/usr/bin/env node

console.log('hello author');

执行helper hello命令:

$ helper hello ipluser
hello author

解析输入信息

我们希望author是由用户输入的,终端应该显示为hello ipluser。修改helper-hello文件内容,解析用户输入信息:

#!/usr/bin/env node

var program = require('commander');

program.parse(process.argv);

const author = program.args[0];

console.log('hello', author);

再执行helper hello ipluser命令:

$ helper hello ipluser
hello ipluser

哦耶,终于达到完成了,但作为程序员,这还远远不够。当用户没有输入author时,我们希望终端能提醒用户输入信息。

提示信息

helper-hello文件中添加提示信息:

#!/usr/bin/env node

var program = require('commander');

program.usage('<author>');

// 用户输入`helper hello -h`或`helper hello --helper`时,显示命令使用例子
program.on('--help', function() {
 console.log(' Examples:');
 console.log(' $ helper hello ipluser');
 console.log();
});

program.parse(process.argv);
(program.args.length < 1) && program.help(); // 用户没有输入信息时,调用`help`方法显示帮助信息

const author = program.args[0];

console.log('hello', author);

执行helper hellohelper hello -h命令,终端将会显示帮助信息:

$ helper hello

 Usage: helper-hello <author>

 Options:

 -h, --help output usage information

 Examples:
 $ helper hello ipluser

$ helper hello -h

 Usage: helper-hello <author>

 Options:

 -h, --help output usage information

 Examples:
 $ helper hello ipluser

总结

到此我们编写了一个helper命令行工具,并且具有helper hello <author>命令。刚兴趣的朋友们快快自己动手实践起来,只有自己做了才能算真正的学习了,希望本文对大家能有所帮助。

Javascript 相关文章推荐
父窗口获取弹出子窗口文本框的值
Jun 27 Javascript
避免回车键导致的页面无意义刷新的解决方法
Apr 12 Javascript
JavaScript中合并数组的N种方法
Sep 16 Javascript
Node.js中安全调用系统命令的方法(避免注入安全漏洞)
Dec 05 Javascript
jQuery中:checked选择器用法实例
Jan 04 Javascript
JavaScript中Date.toSource()方法的使用教程
Jun 12 Javascript
JS获得多个同name 的input输入框的值的实现方法
Jan 09 Javascript
微信小程序城市定位的实现实例(获取当前所在国家城市信息)
May 17 Javascript
jQuery实现左右滑动的toggle方法
Mar 03 jQuery
vue之将echart封装为组件
Jun 02 Javascript
JavaScript中click和onclick本质区别与用法分析
Jun 07 Javascript
微信小程序scroll-view锚点链接滚动跳转功能
Dec 12 Javascript
javascript中的 object 和 function小结
Aug 14 #Javascript
JavaScript兼容浏览器FF/IE技巧
Aug 14 #Javascript
关于JavaScript限制字数的输入框的那些事
Aug 14 #Javascript
使用ajaxfileupload.js实现上传文件功能
Aug 13 #Javascript
几种二级联动案例(jQuery\Array\Ajax php)
Aug 13 #Javascript
漂亮! js实现颜色渐变效果
Aug 12 #Javascript
jQuery ztree实现动态树形多选菜单
Aug 12 #Javascript
You might like
杏林同学录(六)
2006/10/09 PHP
php读取txt文件组成SQL并插入数据库的代码(原创自Zjmainstay)
2012/07/31 PHP
克隆一个新项目的快捷方式
2013/04/10 PHP
php常见的魔术方法详解
2014/12/25 PHP
laravel框架数据库配置及操作数据库示例
2019/10/10 PHP
javascript 判断中文字符长度的函数代码
2012/08/27 Javascript
js动态拼接正则表达式的两种方法
2014/03/04 Javascript
JS动态添加Table的TR,TD实现方法
2015/01/28 Javascript
JavaScript中property和attribute的区别详细介绍
2015/03/03 Javascript
基于jQuery和hwSlider实现内容左右滑动切换效果附源码下载(一)
2016/06/22 Javascript
详解ES6之用let声明变量以及let loop机制
2017/07/15 Javascript
JS实现的汉字与Unicode码相互转化功能分析
2018/05/25 Javascript
判断js数据类型的函数实例详解
2019/05/23 Javascript
JS页面获取 session 值,作用域和闭包学习笔记
2019/10/16 Javascript
通过实例解析vuejs如何实现调试代码
2020/07/16 Javascript
vue render函数动态加载img的src路径操作
2020/10/26 Javascript
Python 开发Activex组件方法
2009/11/08 Python
python fabric实现远程部署
2017/01/05 Python
详解tensorflow载入数据的三种方式
2018/04/24 Python
Python面向对象之接口、抽象类与多态详解
2018/08/27 Python
python3安装speech语音模块的方法
2018/12/24 Python
详解Python装饰器
2019/03/25 Python
python 弹窗提示警告框MessageBox的实例
2019/06/18 Python
Python中base64与xml取值结合问题
2019/12/22 Python
Python getsizeof()和getsize()区分详解
2020/11/20 Python
使用html5+css3来实现slider切换效果告别javascript+css
2013/01/08 HTML / CSS
html5基础标签(html5视频标签 html5新标签用法)
2013/12/30 HTML / CSS
Bench加拿大官方网站:英国城市服装品牌
2017/11/03 全球购物
毕业自我评价
2014/02/05 职场文书
群众路线教育实践活动自我剖析思想汇报
2014/10/04 职场文书
老兵退伍标语
2014/10/07 职场文书
五星级酒店前台接待岗位职责
2015/04/02 职场文书
关于感恩老师的古诗句
2019/08/20 职场文书
vue实现同时设置多个倒计时
2021/05/20 Vue.js
Java面试题冲刺第十六天--消息队列
2021/08/07 面试题
django项目、vue项目部署云服务器的详细过程
2022/07/23 Servers