HBC BLOG

主题

NPM发布与开发指南 ​

本文档总结了开发、调试和发布 test-kit(随便起的一个名称) 的常用命令。

🛠 开发调试 (Development) ​

1. 本地开发与实时构建 ​

在开发过程中，保持构建工具运行，以便实时生成最新的 JS 文件。

bash
# 开启监听模式 (Vite build --watch)
npm run dev
# 或
pnpm dev

2. 在其他项目中调试 (Linking) ​

推荐使用文件路径安装法，最稳定且支持热更新。

步骤：

  1. 在本项目的根目录下运行 npm run dev 保持监听。
  2. 去你的目标项目根目录，运行：
bash
# npm
npm install "d:\test\test-kit"

# pnpm (推荐)
pnpm add "d:\test\test-kit"

这样目标项目会直接引用你硬盘上的文件。

📦 发布流程 (Publishing) ​

1. 准备工作 ​

  • 确保 CHANGELOG.md 已更新。
  • 确保 package.json 中的版本号已递增。
    • 自动更新版本号 (可选)
bash
# 小版本号，自动修改最后一位版本号，如1.0.0会修改为1.0.1
npm version patch # 1.0.0 -> 1.0.1

# 中版本号，自动修改中间一位版本号，如1.0.0会修改为1.1.0
npm version minor # 1.0.0 -> 1.1.0

# 大版本号，自动修改第一位版本号，如1.0.0会修改为2.0.0
npm version major # 1.0.0 -> 2.0.0

2. 检查构建 ​

虽然配置了 prepublishOnly 钩子，但手动检查是个好习惯。

bash
npm run build

检查 dist/ 目录是否生成了 index.umd.js, index.mjs 和类型定义文件。

3. 发布到 npm ​

  • 查看npm当前的镜像源
bash
npm config get registry
  • 修改npm镜像源为官网地址
bash
npm config set registry https://registry.npmjs.org
  • 登录到npm
bash
npm login
  • 首次发布到npm
bash
npm publish --access=public
  • 修改npm镜像源为官网地址
bash
npm config set registry https://registry.npmmirror.com
  • 后续更新发布到npm
bash
npm publish

🧹 清理环境 (Troubleshooting) ​

如果你之前使用了 link 导致环境混乱，可以使用以下命令清理。

bash
# 1. 在本项目目录解除注册
npm unlink -g
# 或
pnpm unlink --global

# 2. 在目标项目目录解除引用
npm unlink test-kit
# 或
pnpm remove --global test-kit