什么是命令行程序呢?像我们常见的webpack,vue-cli都属于命令行程序。
本文将带你从0开始用node写一个自己的命令行程序,并发布到npm。
我打算写一个统计个人代码提交量的命令行工具,起名 git-tool
。
npm地址见 git-tool,GitHub地址见 git-tool。
git-tool
。npm init
创立package.json文件。// 其余代码"bin": { "git-tool": "./index.js"},// 其余代码
bin字段里面的key值可以随意取名,value值为对应的执行文件。
#!/usr/bin/env nodeconsole.log('git-tool')
#!/usr/bin/env node
的意思是让系统自己去找node的执行程序,该行必不可少。
执行npm link
假如执行该命令报错,参考https://docs.npmjs.com/getting-started/fixing-npm-permissio
运行git-tool
我们发现控制台会打印出git-tool。
经过以上步骤我们已经基本搭好环境了,下面即可以开始写自己的逻辑了。
参数读取process.argv
用来获取命令行参数。
修改index.js文件
#!/usr/bin/env nodeconsole.log('git-tool')console.log(process.argv)
而后执行git-tool ss cd
,结果如下图所示:
process.argv
返回一个数组,数组前两位是固定的,分别是node程序的路径和脚本存放的位置,从第三位开始才是额外输入的内容。
npm社区有少量优秀的命令行参数解析包,如yargs,commander.js
我使用的是commander.js
插件commander.js
的基本使用很简单,
#!/usr/bin/env nodeconst program = require('commander');program.version('1.0.0')program .command('codeLineNum') .description('统计git提交代码量') .option("--author [author]", "统计指定作者git提交代码量") .action(function (options) { console.log(options.author) })program.parse(process.argv);
此时执行git-tool -h
,效果如下:
它会帮我们自动做少量事情,很方便。
思路
我们要实现统计代码提交量的目的,就必需借助git命令。git log --author="username" --pretty=tformat: --numstat
该命令输出如下:
代码
具体实现细节就不开展了,有兴趣的可以去GitHub看源码。
最终实现效果如下
npm login
npm publish
每次发布时都需要更改package.json 中的version;
发布需将npm registry地址设为 http://registry.npmjs.orgnpm config set registry http://registry.npmjs.org
手把手教你使用nodejs编写cli(命令行)
Node.js 命令行程序开发教程-阮一峰
魔兽世界燃烧的远征__一区_沙尔图拉_30000金=1440.00元 【在线发货,方便快捷】
魔兽世界燃烧的远征__一区_水晶之牙_30000金=1440.00元 【在线发货,方便快捷】
魔兽世界燃烧的远征__一区_莫格莱尼_30000金=1440.00元 【在线发货,方便快捷】
魔兽世界燃烧的远征__一区_霜语_30000金=1440.00元 【在线发货,方便快捷】
魔兽世界燃烧的远征__一区_希尔盖_30000金=1440.00元 【在线发货,方便快捷】
魔兽世界燃烧的远征__一区_维克洛尔_30000金=1440.00元 【在线发货,方便快捷】