何为cli?
它是一个简单到不想解释的东西,但如果不去了解,仍然觉得它很神秘。
先定个小目标
实现在自己的电脑上使用自定义的mycli命令做一些事儿,像vue-cli、webpack-cli他们一样,通过npm install -g mycli安装后使用。
-
第一步
在npmjs.com上注册一个账号 -
第二步
本地创建一个mycli项目文件夹,结构如:
- bin
|- mycli.js
- package.json
- README.md
关键文件mycli.js的代码:
#!/usr/bin/env node
require('colors')
const commander = require('commander')
const package = require('../package')
const childProcess = require('child_process')
commander
.version((package.name + '@' + package.version || '').green)
.description(package.description || '')
.usage('<projectName>')
commander
.command('* <project>')
.action(function (project) {
if (project) {
childProcess.exec('mkdir ' + project, (err) => {
if(err) return console.err(err)
console.log('创建了一个名为“'+project+'”的项目'.green)
})
} else {
console.log('正确命令例子:mycli myproject'.red)
}
})
commander.parse(process.argv)
文件开头#!/usr/bin/env node
这一行是关键,它是一条bash指令,用来告诉系统使用node来启动这个文件。剩下的其他代码就是自己想怎么写就怎么写。
commander:是处理指令最好的工具,这里实现通过mycli myproject来创建一个项目文件夹(空的),也可以通过mycli --version 或 mycli -V打印版本信息等。
colors:是用来给console.log输出内容加颜色的,可有可无。
关键文件package.json:
{
"name": "@ludyjim/mycli",
"version": "1.0.0",
"description": "写个cli",
"main": "index.js",
"bin": {
"mycli": "bin/mycli.js"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [
"mycli"
],
"author": "670752970@qq.com",
"license": "ISC",
"dependencies": {
"colors": "^1.4.0",
"commander": "^5.0.0"
},
"devDependencies": {}
}
这里的关键字段是
{
"name": "@ludyjim/mycli",
"version": "1.0.0",
"bin": {
"mycli": "bin/mycli.js"
}
}
name:是解决发布的npm包名称,用户安装时通过这个名称安装。名称不能与其他人已发布的重名,一般建议加自己的账号如"@ludyjim/"
作为前缀,这样可以避免冲突。
version:是版本号,每次更新发布必须改它,不然不允许发布。
bin:是配置指令mycli
和指令的指向文件bin/mycli.js
,它也决定着npm install -g mycli
安装的时把mycli.js安装到本地环境变量中,一般会安装到/usr/local/bin/mycli
。
总结就是:name和version决定能不能发布,bin决定能不能安装使用。
第三步
登录npm,执行:npm adduser
, 然后安照提示输入账号,输入密码,输入邮箱等,如果不成功,说明本地可能已经添加过账号了。那么执行:npm login
,同样输入账号,输入密码,输入邮箱,登录成功。第四步
发布,执行:npm publish --access public
,这里最关键的是--access public
,它意思是发布一个公开的包,如果不加,默认发布为私有包,而众所周知npm发布私有包是要付费的,所以只能流下贫穷的眼泪。
到这里已经完成了,打开npmjs.com
,点自己的头像下拉菜单选择packages
,进去一看就会看到多了个@ludyjim/mycli
,接下来就是安装使用了。
安装
执行:npm install -g @ludyjim/mycli
然后,试一下:mycli -V
、mycli -h
、mycli myproject
。自己玩吧。
更新
如果修改了mycli.js
,想要重新发布,必须修改package.json
里的version版本号。然后npm publish
即可发布,可不需要 --access public
了。
WINDOWS系统兼容
以上在windows系统安装可能会使用不了,需要在包的配置文件package.json添加engines字段
"engines": {
"node": "^12.0.0 || >= 14.0.0"
}
最后
灵魂拷问:四不四简单得要命?