利用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 相关文章推荐
Gird组件 Part-3:范例RSSFeed Viewer
Mar 10 Javascript
通过JS获取用户本地图片路径并显示的代码
Feb 16 Javascript
Javascript模块化编程(三)require.js的用法及功能介绍
Jan 17 Javascript
Jquery模仿Baidu、Google搜索时自动补充搜索结果提示
Dec 26 Javascript
Jquery 在页面加载后执行的几种方式
Mar 14 Javascript
用js的document.write输出的广告无阻塞加载的方法
Jun 05 Javascript
jQuery中[attribute*=value]选择器用法实例
Dec 31 Javascript
JavaScript转换与解析JSON方法实例详解
Nov 24 Javascript
深入浅出讲解ES6的解构
Aug 03 Javascript
Layui多选只有最后一个值的解决方法
Sep 02 Javascript
vue实现打地鼠小游戏
Aug 21 Javascript
小程序自定义圆形进度条
Nov 17 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中str_replace函数使用小结
2008/10/11 PHP
PHP设计模式 注册表模式(多个类的注册)
2012/02/05 PHP
Yii框架调试心得--在页面输出执行sql语句
2014/12/25 PHP
php+ajax无刷新上传图片的实现方法
2016/12/06 PHP
ArrayList类(增强版)
2007/04/04 Javascript
JavaScript 拖拉缩放效果
2008/12/10 Javascript
ajax 缓存 问题 requestheader
2010/08/01 Javascript
轻松创建nodejs服务器(2):nodejs服务器的构成分析
2014/12/18 NodeJs
Node.js中的流(Stream)介绍
2015/03/30 Javascript
jquery任意位置浮动固定层插件用法实例
2015/05/29 Javascript
JavaScript SHA512&amp;SHA256加密算法详解
2015/08/11 Javascript
JavaScript小技巧整理
2015/12/30 Javascript
纯js实现悬浮按钮组件
2016/12/17 Javascript
使用Node.js实现ORM的一种思路详解(图文)
2017/10/24 Javascript
js判断节假日实例代码
2017/12/27 Javascript
JavaScript时间与时间戳的转换操作实例分析
2018/12/07 Javascript
微信小程序页面传多个参数跳转页面的实现方法
2019/05/17 Javascript
jQuery实现电梯导航模块
2020/12/22 jQuery
Python的Tornado框架异步编程入门实例
2015/04/24 Python
解决Python安装后pip不能用的问题
2018/06/12 Python
Django分页查询并返回jsons数据(中文乱码解决方法)
2018/08/02 Python
python进程间通信Queue工作过程详解
2019/11/01 Python
使用Keras预训练模型ResNet50进行图像分类方式
2020/05/23 Python
基于python实现MQTT发布订阅过程原理解析
2020/07/27 Python
pandas实现导出数据的四种方式
2020/12/13 Python
Matlab使用Plot函数实现数据动态显示方法总结
2021/02/25 Python
解决Pyinstaller打包软件失败的一个坑
2021/03/04 Python
俄罗斯童装网上商店:BebaKids
2020/06/06 全球购物
DBA数据库管理员JAVA程序员架构师必看
2016/02/07 面试题
《诺贝尔》教学反思
2014/02/17 职场文书
网络管理专业求职信
2014/03/15 职场文书
查摆问题自查报告范文
2014/10/13 职场文书
教师工作表现自我评价
2015/03/05 职场文书
2015年前台接待工作总结
2015/05/04 职场文书
《花钟》教学反思
2016/02/17 职场文书
只需要12页,掌握撰写一流商业计划书的技巧
2019/05/07 职场文书