npm publish发布流程
将本地包发布到npmjs.com,即可被全球开发者通过npm install安装使用。
npm publish发布流程
1. 注册并登录NPM账号
Bash
# 登录npmjs.com(需先在网站注册)
npm login
按提示输入用户名、密码和邮箱,验证通过后登录成功。
Bash
# 查看当前登录状态
npm whoami
2. 确保package.json配置完整
必须字段:
JSON
{
"name": "my-utils",
"version": "1.0.0",
"main": "lib/index.js"
}
发布作用域包(@scope/name):
JSON
{
"name": "@myorg/utils",
"publishConfig": {
"access": "public"
}
}
作用域包默认为private,需设置
publishConfig.access: "public"才能公开发布。
3. 确认包内容
Bash
# 查看将要发布的文件列表
npm pack --dry-run
使用.npmignore或package.json的files字段控制发布内容:
JSON
{
"files": [
"lib",
"README.md"
]
}
4. 执行发布
Bash
npm publish
# 作用域包公开发布
npm publish --access public
发布成功后,包可在https://www.npmjs.com/package/<name>访问。
5. 更新版本后重新发布
Bash
# 递增版本
npm version patch
# 重新发布
npm publish
每次发布version必须不同于已发布版本,否则会报错。
镜像源为npmmirror时无法发布,需先切回官方源:
npm config set registry https://registry.npmjs.org。
要点总结
- 发布前需
npm login登录,通过npm whoami验证登录状态 - package.json的name和version是必填项,作用域包需设置access为public
- 用
npm pack --dry-run预览发布内容,用files字段精确控制打包范围 - 每次发布前必须更新version,镜像源环境下需切回官方源才能发布