1.初始化npm项目
npm init -y
执行命令后会生成package.json
文件,文件中有一些配置项,根据实际情况修改:
属性名 | 描述 |
---|---|
name | 包的名字,默认是这个文件夹的名字,要求不能是npm上重名的 |
version | 包的版本,默认是1.0.0 |
description | 包描述 |
main | 入口文件,默认是index.js |
keyword | 包的关键词,用于npm上搜索 |
author | 作者 |
license | 开源协议 |
2.编写脚本
入口文件index.js
,需要在第一行添加 #!/usr/bin/env node
:
#!/usr/bin/env node
console.log('hello wbts-create-react-app!');
同时需要在``文件中添加bin
配置,键名是生成的.cmd
文件的名字,值是执行这个命名所要执行的脚本:
{
"bin": {
"wbts-create-react-app": "index.js"
},
"type": "module",
"name": "wbts-create-react-app",
"version": "1.0.0",
"description": "a script for quickly creating react template project according to personal habits",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": ["wbts", "whereabouts"],
"author": "hezebin",
"license": "ISC"
}
3.测试
执行npm link
或npm install -g
全局安装生成的cmd文件,然后执行脚本即可:
3.发布到npm
首先前往官网注册npm账号:https://www.npmjs.com/。
然后登录自己的账号:
npm login
注意:若将npm的镜像源配置过为淘宝(
https://registry.npm.taobao.org
)等的需要先切回官方的镜像源https://registry.npmjs.org
:npm config set registry https://registry.npmjs.org
在发布完后再切回下载更快的三方镜像源。
最后发布即可:
npm publish
4.验证
登录到npm即可看到上述发布的包:
通过npx
在线执行以下npm命令:
npx wbts-create-react-app
若为安装npx可直接使用npm安装:
npm install -g npx
5.版本更新和卸载
若后续增删迭代功能后,不能直接发布,需要先更改配置文件中的版本号,或者执行命令:npm version patch
,然后才可以在发布。
若要删除则执行:
npm unpublish
同样请注意:在做npm的写操作时,请把npm镜像源切换回官方的地址。