在前端开发中使用 npm 包来管理依赖非常常见,但是如果你要发布自己的 npm 包,你肯定希望它可以更加便捷地发布,更加便捷地修改和升级。这时就需要使用 npm-publish-scripts 这个 npm 包。
npm-publish-scripts 是什么?
npm-publish-scripts 是一个 npm script 集合,通过 npm run scripts 的方式管理 npm 包的发布流程,尤其是自动化部分(包括更新版本号、打 tag、提交 git 版本控制、发布到 npm),可以大大简化每次更新的串联操作。
npm-publish-scripts 包括了以下 6 个 npm script:
npm-bump-patch
:更新 patch 版本npm-bump-minor
:更新 minor 版本npm-bump-major
:更新 major 版本npm-create-tag
:创建 git tagnpm-commit
:向 git 提交代码npm-publish
:发布 npm 包
如何使用?
首先安装 npm-publish-scripts,可以全局或项目本地安装:
npm install -g npm-publish-scripts 或 npm install --save-dev npm-publish-scripts
然后在 package.json 中添加 scripts:
"scripts": { "version-patch": "npm-bump-patch", "version-minor": "npm-bump-minor", "version-major": "npm-bump-major", "tag": "npm-create-tag", "commit": "npm-commit", "publish": "npm-publish" }
这样就可以使用 npm run version-patch
等命令更新版本,并通过 npm run publish
命令发布到 npm。
更新版本
npm-publish-scripts 支持三种方式更新版本:patch、minor、major。通过执行以下命令可以进行版本号更新:
npm run version-patch npm run version-minor npm run version-major
版本号更新包括以下步骤:
- 自动升级 package.json 中的版本号;
- 向 git 提交代码,commit message 为
Release v0.1.1
; - 创建一个 git tag,tag 名为
v0.1.1
。
你也可以手动更改 package.json 中的版本号,然后执行以下命令生成 tag 和提交 git:
npm run create-tag npm run commit
发布 npm 包
执行以下命令即可发布 npm 包:
npm run publish
npm-publish-scripts 会将包发布到 npm,同时也会将代码推送到 git 远程仓库。
示例代码
以下是一个简单的示例代码,发布时会执行自动更新 package.json 的版本号、提交到 git、打 tag、发布 npm 包:
-- -------------------- ---- ------- ---------- - ------- ----- -------- -- ---- ----------- -- ---- --- ---------------- ----------------- ---------------- ----------------- ---------------- ----------------- ------ ----------------- --------- ------------- ---------- -------------- ----------------- ---- --- ------------- -- --- --- ------ -- --- --- ----- -------------- ---- ---- ------ ------ -- --- ---- ------- --
总结
npm-publish-scripts 可以将 npm 包的发布流程自动化,大幅度减少繁琐的手动操作。帮助你更好地管理和发布 npm 包。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedcc83b5cbfe1ea06127ea