前端日常开发中,会遇见各种各样的cli,比如一行命令帮你打包的webpack,一行命令帮你生成vue项目模板的vue-cli,还有创建react项目的create-react-app等等等等。这些工具极大地方便了我们的日常工作,让计算机自己去干繁琐的工作,而我们,就可以节省出大量的时间用于学习、交流、开发、 逛steam 。
但是有时候一些十分特别的需求,我们是找不到适合的cli工具去做的。比如说,你的项目十分庞大,你给项目添加一个新的路由,要经过 创建目录 -> 创建.vue文件 -> 更新vue-router的路由列表 这一趟流程,就算快捷键创建目录文件用得再熟悉,也比不过你一行命令来得快,特别是路由目录嵌套深,.vue文件初始化模板复杂的时候。
所以呢,何不为自己项目写一个cli?就专门做这些繁琐的活?
0x1 hello world
nodejs的cli,本质就是跑node脚本嘛,基本上每位前端er都会:
// index.js console.log('hello world')
然后命令行调用
> node index.js ## 输出: > hello world
可以做得更逼真一点,我们在package.json里面的scripts字段上添加一下脚本名:
{ "scripts":{ "hello":"node index.js" } }
然后命令行调用:
> npm run hello
但是,看到这里你肯定会说,人家webpack还有vue-cli都是“有名字”的!什么 vue-cli init app 、 webpack -p 的,多漂亮,看看这个命令行, node index.js ,还 npm run hello ,谁不会啊,丑不拉几的,怕又不是来水文章的哦?差评!!
别急啊各位大人,接下来就说说,如何给这个node脚本起个名字。
0x2 起名字
姑且,先把这个cli的名字命名为 hello-cli ,就是我们能够在命令行里面,输入 hello-cli ,然后它就打印一句 hello world ,没有 node 也没有 npm ,就是:
这里,我们需要做几步操作:
1、index.js文件顶部声明执行环境:
// index.js #!/usr/bin/env node console.log('hello world')
添加 #!/usr/bin/env node 或者 #!/usr/bin/node ,这是告诉系统,下面这个脚本,使用nodejs来执行。当然,这个系统不包括windows,因为windows下有个JScript的历史遗留物在,会让你的脚本跑不起来。
#!/usr/bin/env node 的意思是让系统自己去找node的执行程序。
#!/usr/bin/node 的意思是,明确告诉系统,node的执行程序在路径为 /usr/bin/node 。
2、添加package.json的bin字段。
可以在index.js当前的目录下执行 npm init 创建一个package.json,然后在package.json里面,添加一个bin字段:
{ "name": "hello-test", "version": "1.0.0", "bin":{ "hello-cli":"index.js" } }
bin字段里面写上这个命令行的名字,也就是 hello-cli ,它告诉npm,里面的js脚本可以通过命令行的方式执行,以 hello-cli 的命令调用。当然命令行的名字你想写什么都是你的自由,比如:
3、 在当前package.json目录下,打开命令行工具,执行 npm link ,将当前的代码在npm全局目录下留个快捷方式。
npm检测到package.json里面存在一个bin字段,它就同时在全局npm包目录下生成了一个可执行文件:
当我们在系统命令行直接执行 hello-cli 的时候,实际上就是执行这里的脚本。
因为安装node的时候,npm将这个目录配置为系统变量环境了,当你执行命令的时候,系统会先找系统命令和系统变量,然后到变量环境里面去查找这个命令名,然后找到这个目录后,发现匹配上了该命令名的可执行文件,接着就直接执行它。vue-cli也好,webpack-cli也好,都是这样执行的。
这样,你的第一个cli脚本就成功安装了,可以在命令行里面,直接敲你的cli名字,看看结果输出吧。
另外,如果你仅希望你的cli脚本仅在项目里执行,则需要在你项目里面新建一个目录,重复上述的操作,只是在第三步的时候,不要llink到全局里面去,而是使用 npm i -D file:<你的脚本cli目录路径> ,把它当成项目的依赖安装到node_modules里面去,如果安装成功,那么在项目的package.json你会看到多了一条依赖,这条依赖的值不是版本号,而是你脚本的路径。然后在node_modules里面会有一个.bin目录,里面就存放着你的可执行文件。
局部安装建议用 npm i -D file:xxx ,这样它会在package.json留条记录,方便其他小伙伴看到。自然,你的脚本最好也是放进项目目录里面。
当然,这样安装的cli脚本,必须在项目的package.json的scripts字段上声明脚本命令,然后通过 npm run 的方式执行。
哦?这样子使用的话不就回到最最最开始的时候那种原始的 npm run hello 一样么。