利用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 相关文章推荐
JS操作Cookie写入和读取实例代码
Oct 20 Javascript
利用jQuery简单实现产品展示图片左右滚动功能(示例代码)
Jan 02 Javascript
解决checkbox的attr(checked)一直为undefined问题
Jun 16 Javascript
node.js中的events.emitter.listeners方法使用说明
Dec 10 Javascript
javascript实现单击和双击并存的方法
Dec 13 Javascript
JavaScript数据推送Comet技术详解
Apr 07 Javascript
Vue 将后台传过来的带html字段的字符串转换为 HTML
Mar 29 Javascript
使用微信小程序开发弹出框应用实例详解
Oct 18 Javascript
vue中使用 pako.js 解密 gzip加密字符串的方法
Jun 10 Javascript
layui的数据表格+springmvc实现搜索功能的例子
Sep 28 Javascript
微信小程序tabBar设置实例解析
Nov 14 Javascript
vue实现的封装全局filter并统一管理操作示例
Feb 02 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中break及continue两个流程控制指令区别分析
2011/04/18 PHP
排序算法之PHP版快速排序、冒泡排序
2014/04/09 PHP
PHP如何防止XSS攻击与XSS攻击原理的讲解
2019/03/22 PHP
如何实现iframe(嵌入式帧)的自适应高度
2006/07/26 Javascript
[原创]站长必须要知道的javascript广告代码
2007/05/30 Javascript
Javascript的并行运算实现代码
2010/11/19 Javascript
js实现上传图片之上传前预览图片
2013/03/25 Javascript
javascript使用appendChild追加节点实例
2015/01/12 Javascript
程序员必知35个jQuery 代码片段
2015/11/05 Javascript
全面解析多种Bootstrap图片轮播效果
2016/05/27 Javascript
angularjs2中父子组件的数据传递的实例代码
2017/07/05 Javascript
详解如何用webpack打包一个网站应用项目
2017/07/12 Javascript
JS中跳出循环的示例代码
2017/09/14 Javascript
JS+jQuery实现注册信息的验证功能
2017/09/26 jQuery
JS简单获取并修改input文本框内容的方法示例
2018/04/08 Javascript
ES6入门教程之let、const的使用方法
2019/04/13 Javascript
python self,cls,decorator的理解
2009/07/13 Python
Python多线程编程(八):使用Event实现线程间通信
2015/04/05 Python
使用pdb模块调试Python程序实例
2015/06/02 Python
Python实现八大排序算法
2016/08/13 Python
Python实现字典去除重复的方法示例
2017/07/31 Python
python3实现字符串的全排列的方法(无重复字符)
2018/07/07 Python
django连接oracle时setting 配置方法
2019/08/29 Python
树莓派3 搭建 django 服务器的实例
2019/08/29 Python
Python3 合并二叉树的实现
2019/09/30 Python
利用pyshp包给shapefile文件添加字段的实例
2019/12/06 Python
TensorFlow梯度求解tf.gradients实例
2020/02/04 Python
Python3.6 + TensorFlow 安装配置图文教程(Windows 64 bit)
2020/02/24 Python
Python selenium文件上传下载功能代码实例
2020/04/13 Python
用Python开发app后端有优势吗
2020/06/29 Python
HTML5如何实现元素拖拽
2016/03/11 HTML / CSS
HTML5之tabindex属性全面解析
2016/07/07 HTML / CSS
英国儿童设计师服装的领先零售商:Base
2019/03/17 全球购物
个人安全承诺书
2014/05/22 职场文书
Z-Order加速Hudi大规模数据集方案分析
2022/03/31 Servers
基于Python实现对比Exce的工具
2022/04/07 Python