利用node.js制作命令行工具方法教程(一)
前言
之前使用过一些全局安装的NPM包,安装完之后,可以通过其提供的命令,完成一些任务。比如Fis3,可以通过fis3serverstart开启fis的静态文件服务,通过fis3release开启文件编译与发布;还有vue-cli,可以通过vueinitwebpackmy-project来初始化vue+webpack的项目基础配置。最近有一个需求,需要写一个类似vue-cli的NPM包,通过命令行操作实现项目初始配置,所以就查看了相关资料,学习了一下如何使用node来生成自己的命令。
编写命令行
命令的目标:在当前目录下开启一个静态文件服务,端口号为8085
1.创建目录
构成命令的基础是需要一个命令文件web.js和package.json配置文件,执行以下命令:
$mkdirnode-commander#创建一个文件夹 $cdnode-commander&&mkdirbin $npminit#初始化package.json文件
$cdbin&&touchweb.js#创建命令文件
2.命令文件
#!/usr/bin/envnode varexpress=require('express'); varpath=process.cwd(); functionrun(argv){ if(argv[0]==='-v'||argv[0]==='--version'){ console.log('versionis1.0.0'); } elseif(argv[0]==='-h'||argv[0]==='--help'){ console.log('usage:\n'); console.log('-v--version[showversion]') } elseif(argv[0]==='-s'||argv[0]==='--start'){ varapp=newexpress(); app.use('/static',express.static(path)); app.listen(8085,function(){ console.log('serverstartatport8085'); }); } } run(process.argv.slice(2));
文件的头部务必加入#!/usr/bin/envnode这行代码,这里表示使用node作为脚本的解释程序,node的路径通过env来查找,可以避免node安装路径不一带来的问题。
其中process为node进程中的全局变量,process.argv为一数组,数组内存储着命令行的各个部分,argv[0]为node的安装路径,argv[1]为主模块文件路劲,剩下为子命令或参数,如下:
node./bin/web.jsabc #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的配置,为全局命令创建软连。
#sudonpminstall.-g /usr/local/bin/web->/usr/local/lib/node_modules/cli-demo/bin/web.js /usr/local/lib `--cli-demo@1.0.0 ...
查看web命令
#whichweb /usr/local/bin/web
执行web命令
#web--start serverstartatport8085
(2)采用npmlink方法
npmlink方法创建了两个软连,命令与命令文件的软连,全局包与实际包文件的软连。
#sudonpmlink /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)进行操作了。
发布命令包
通过npmpublish进行发布,前提是有npm帐号。如何操作可以查看npm官方文档。
本文是通过原生node.js来开发命令工具,而vue-cli是采用commander.js来简化命令工具开发,关于commander.js的使用方法,将在下一篇文章中介绍。
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对毛票票的支持。