前言
如果你想写一个npm插件,如果你想通过命令行来简化自己的操作,如果你也是个懒惰的人,那么这篇文章值得一看。
po主的上一篇文章介绍了定制自己的模版,但这样po主还是不满足啊,项目中我们频繁的需要新建一些页面,逻辑样式等文件,每次都手动new一个,然后复制一些基本代码进去非常的麻烦,所以就有了这篇文章。接下来就让po主为大家一步一步演示怎么做一个npm命令行插件。
注册npm账户
发布npm插件,首先肯定要有个npm帐号了,过程就不啰嗦了,走你。
npm官网
有了账号后,我们通过npm init 生成一个package配置文件,填写一些你的信息,然后就可以开始写逻辑代码了。
编写命令入口
首先看一下项目结构
. ├── bin //命令配置 ├── README.md //说明文档 ├── index.js //主入口 ├── src //功能文件 ├── package.json //包信息 └── test //测试用例
实例命令代码都是写在bin目录下,我们现在配置文件package文件中启用命令,添加一个配置项bin
"bin": { "xu": "./bin/xu.js" },
然后安装一个依赖,TJ大神写的commander插件,
npm i commander --save
有了这个工具我们可以很方便的编写命令代码
xu.js
#!/usr/bin/env node process.title = 'xu'; require('commander') .version(require('../package').version) .usage('<command> [options]') .command('generate', 'generate file from a template (short-cut alias: "g")') .parse(process.argv) require('./xu-generate'); >>引入
这个文件可以看作是入口文件,第一行代码是必须添加的,脚本用env启动的原因,是因为脚本解释器在linux中可能被安装于不同的目录,env可以在系统的PATH目录中查找。同时,env还规定一些系统环境变量。 这种写法主要是为了让你的程序在不同的系统上都能适用。
在这一步,你可以简单测试你自己的npm插件
$ node ./bin/xu.js >>> 输出一些插件usage。help信息
关于commander,大家可以去作者的Github先学习了解,这里不对参数讲解。
xu-generate.js
#!/usr/bin/env node const program = require('commander'); const chalk = require('chalk') const xu = require('../src/generate'); /** * Usage. */ program .command('generate') .description('quick generate your file') .alias('g') .action(function(type, name){ xu.run(type, name); }); program.parse(process.argv);
内容版权声明:除非注明,否则皆为本站原创文章。