利用node.js制作命令行工具方法教程(一)


Posted in Javascript onJune 22, 2017

前言

之前使用过一些全局安装的NPM包,安装完之后,可以通过其提供的命令,完成一些任务。比如Fis3,可以通过fis3 server start 开启fis的静态文件服务,通过fis3 release开启文件编译与发布;还有vue-cli,可以通过vue init webpack my-project来初始化vue+webpack的项目基础配置。最近有一个需求,需要写一个类似vue-cli的NPM包,通过命令行操作实现项目初始配置,所以就查看了相关资料,学习了一下如何使用node来生成自己的命令。

编写命令行

命令的目标:在当前目录下开启一个静态文件服务,端口号为8085

1.创建目录

构成命令的基础是需要一个命令文件web.js和package.json配置文件,执行以下命令:

$ mkdir node-commander #创建一个文件夹

$ cd node-commander && mkdir bin

$ npm init #初始化package.json文件<br>$ cd bin && touch web.js #创建命令文件

2.命令文件 

#!/usr/bin/env node

 

var express = require('express');

var path = process.cwd();

 

function run(argv) {

 if (argv[0] === '-v' || argv[0] === '--version') {

 console.log('version is 1.0.0');

 }

 else if (argv[0] === '-h' || argv[0] === '--help') {

 console.log('usage:\n');

 console.log('-v --version [show version]')

 }

 else if (argv[0] === '-s' || argv[0] === '--start') {

 var app = new express();

 app.use('/static', express.static(path));

 app.listen(8085, function () {

 console.log('server start at port 8085');

 });

 }

}

 

run(process.argv.slice(2)); 

文件的头部务必加入#!/usr/bin/env node这行代码,这里表示使用node作为脚本的解释程序,node的路径通过env来查找,可以避免node安装路径不一带来的问题。

其中process为node进程中的全局变量,process.argv为一数组,数组内存储着命令行的各个部分,argv[0]为node的安装路径,argv[1]为主模块文件路劲,剩下为子命令或参数,如下:

node ./bin/web.js a b c

# process.argv的值为[ '/usr/local/bin/node', '/PATH/web.js', 'a', 'b', 'c' ]

3.命令配置

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

"bin": {

 "web": "./bin/web.js"

 },

bin字段的作用:当安装npm包时,npm将添加一条命令/usr/local/bin/web,web命令软连接到web.js文件。

调试命令行

(1)采用install方法

进入npm包目录下,执行全局install,根据package.json中bin的配置,为全局命令创建软连。

# sudo npm install . -g
/usr/local/bin/web -> /usr/local/lib/node_modules/cli-demo/bin/web.js

/usr/local/lib

`-- cli-demo@1.0.0
...

查看web命令

# which web 

/usr/local/bin/web

执行web命令

# web --start

server start at port 8085

(2)采用npm link方法

npm link方法创建了两个软连,命令与命令文件的软连,全局包与实际包文件的软连。

# sudo npm link

 

/usr/local/bin/web -> /usr/local/lib/node_modules/cli-demo/bin/web.js

/usr/local/lib/node_modules/cli-demo -> /Users/baidu/hwm/home/demos/node/node-commander

接下来可以按照方法(1)进行操作了。

发布命令包

通过npm publish进行发布,前提是有npm帐号。如何操作可以查看npm 官方文档。

本文是通过原生node.js来开发命令工具,而vue-cli是采用commander.js来简化命令工具开发,关于commander.js的使用方法,将在下一篇文章中介绍。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

Javascript 相关文章推荐
javascript 延迟加载技术(lazyload)简单实现
Jan 17 Javascript
不同的jQuery API来处理不同的浏览器事件
Dec 09 Javascript
中文输入法不触发onkeyup事件的解决办法
Jul 09 Javascript
jquery简单实现网页层的展开与收缩效果
Aug 07 Javascript
vue2.0数据双向绑定与表单bootstrap+vue组件
Feb 27 Javascript
jQuery实现可拖动进度条实例代码
Jun 21 jQuery
angular.js中解决跨域问题的三种方式
Jul 12 Javascript
BootstrapTable加载按钮功能实例代码详解
Sep 22 Javascript
微信小程序非swiper组件实现的自定义伪3D轮播图效果示例
Dec 11 Javascript
微信小程序使用wxParse解析html的方法示例
Jan 17 Javascript
AJAX在JQuery中的应用详解
Jan 30 jQuery
js实现div色块拖动录制
Jan 16 Javascript
关于在vue-cli中使用微信自动登录和分享的实例
Jun 22 #Javascript
详解vue 配合vue-resource调用接口获取数据
Jun 22 #Javascript
vue使用stompjs实现mqtt消息推送通知
Jun 22 #Javascript
Angularjs在360兼容模式下取数据缓存问题的解决办法
Jun 22 #Javascript
详解用webpack2搭建angular2的项目
Jun 22 #Javascript
vue2.0实现分页组件的实例代码
Jun 22 #Javascript
纯JS实现只能输入数字的简单代码
Jun 21 #Javascript
You might like
php的header和asp中的redirect比较
2006/10/09 PHP
php 随机记录mysql rand()造成CPU 100%的解决办法
2010/05/18 PHP
The specified CGI application misbehaved by not returning a complete set of HTTP headers
2011/03/31 PHP
PHP 面向对象程序设计(oop)学习笔记(三) - 单例模式和工厂模式
2014/06/12 PHP
Laravel搭建后台登录系统步骤详解
2016/07/26 PHP
PHP实现的日历功能示例
2018/09/01 PHP
分享20款好玩的jQuery游戏
2011/04/17 Javascript
jquery实现的随机多彩tag标签随机颜色和字号大小效果
2014/03/27 Javascript
解释&amp;&amp;和||在javascript中的另类用法
2014/07/28 Javascript
深入理解JavaScript系列(42):设计模式之原型模式详解
2015/03/04 Javascript
js调用百度地图及调用百度地图的搜索功能
2015/09/07 Javascript
BootstrapTable refresh 方法使用实例简单介绍
2017/02/20 Javascript
nodejs个人博客开发第二步 入口文件
2017/04/12 NodeJs
解决Extjs下拉框不显示的问题
2017/06/21 Javascript
Webpack path与publicPath的区别详解
2018/05/03 Javascript
nodejs使用node-xlsx生成excel的方法示例
2019/08/22 NodeJs
微信小程序跨页面传递data数据方法解析
2019/12/13 Javascript
[59:42]Secret vs Alliacne 2019国际邀请赛小组赛 BO2 第一场 8.15
2019/08/17 DOTA
python基础教程之字典操作详解
2014/03/25 Python
python监控网站运行异常并发送邮件的方法
2015/03/13 Python
Python实现确认字符串是否包含指定字符串的实例
2018/05/02 Python
selenium 安装与chromedriver安装的方法步骤
2019/06/12 Python
python文件选择对话框的操作方法
2019/06/27 Python
python基础 range的用法解析
2019/08/23 Python
Pyqt5 关于流式布局和滚动条的综合使用示例代码
2020/03/24 Python
python如何更新包
2020/06/11 Python
印尼在线购买隐形眼镜网站:Lensza.co.id
2019/04/27 全球购物
复古服装:RetroStage
2019/05/10 全球购物
远程研修随笔感言
2014/02/10 职场文书
3.12植树节活动总结2014
2014/03/13 职场文书
交通事故赔偿协议书范本
2014/04/15 职场文书
2014年绩效考核工作总结
2014/12/11 职场文书
优秀班组事迹材料
2014/12/24 职场文书
功夫熊猫观后感
2015/06/10 职场文书
Python+uiautomator2实现自动刷抖音视频功能
2021/04/29 Python
Java 泛型详解(超详细的java泛型方法解析)
2021/07/02 Java/Android