PUBLISH_CHECKLIST.md•4.24 kB
# 📦 发布前检查清单
代码已经改造完成，准备发布到 npm！
## ✅ 已完成的改造
### 1. package.json 完善
- ✅ 添加了 `bin` 字段，支持命令行调用
- ✅ 添加了 `files` 字段，只发布必要文件
- ✅ 添加了完整的 `keywords`（12个关键词）
- ✅ 添加了 `repository`、`bugs`、`homepage` 字段
- ✅ 添加了 `engines` 限制 Node.js 版本
- ✅ 添加了 `prepublishOnly` 和 `prepack` 脚本自动编译
### 2. .npmignore 创建
- ✅ 排除源代码（只发布编译后的代码）
- ✅ 排除开发文件和配置
- ✅ 排除测试文件和脚本
- ✅ 保留必要的文档
### 3. 编译验证
- ✅ shebang 已正确保留在编译后的文件中
- ✅ 打包测试通过（13 个文件，13.3 KB）
## 📝 发布前你需要做的事
### 第一步：修改 package.json 中的个人信息
打开 `package.json`，修改以下内容：
```json
{
"author": "Your Name <your.email@example.com>", // 👈 改成你的名字和邮箱
"repository": {
"type": "git",
"url": "https://github.com/yourusername/health-reminder-mcp.git" // 👈 改成你的 GitHub 仓库
},
"bugs": {
"url": "https://github.com/yourusername/health-reminder-mcp/issues" // 👈 改成你的 GitHub 仓库
},
"homepage": "https://github.com/yourusername/health-reminder-mcp#readme" // 👈 改成你的 GitHub 仓库
}
```
### 第二步：推送代码到 GitHub（可选但推荐）
```bash
# 如果还没有创建 git 仓库
git init
git add .
git commit -m "feat: ready for npm publish"
# 在 GitHub 上创建仓库，然后推送
git remote add origin https://github.com/yourusername/health-reminder-mcp.git
git branch -M main
git push -u origin main
```
### 第三步：登录 npm
```bash
npm login
```
输入你的：
- Username（用户名）
- Password（密码）
- Email（邮箱）
- 如果启用了 2FA，输入验证码
### 第四步：最后检查
```bash
# 查看将要发布的文件
npm pack --dry-run
# 确认信息无误
```
### 第五步：发布到 npm
```bash
# 正式发布
npm publish
# 如果包名是 @username/package-name 格式（scoped package）
npm publish --access public
```
## 🎯 发布后的使用
发布成功后，任何人都可以通过以下方式使用：
### 在 Cursor 的 mcp.json 中配置
```json
{
"mcpServers": {
"health-reminder": {
"command": "npx",
"args": [
"-y",
"health-reminder-mcp@latest"
],
"env": {
"REMINDER_INTERVAL": "30",
"REMINDER_MESSAGE": "该起身活动一下了！",
"REMINDER_TITLE": "健康提醒",
"REMINDER_SOUND": "true"
}
}
}
}
```
### 直接运行测试
```bash
npx health-reminder-mcp@latest
```
## 📊 打包信息
当前打包配置：
- **包大小**: 13.3 KB（已压缩）
- **解压后大小**: 49.4 KB
- **文件数量**: 13 个
- **包含内容**:
- ✅ 编译后的 JS 代码（dist/）
- ✅ TypeScript 类型定义（.d.ts）
- ✅ README.md
- ✅ LICENSE
- ✅ CHANGELOG.md
- ✅ config.example.json
- ❌ 不包含源代码
- ❌ 不包含开发文件
## 🔄 更新版本
每次更新代码后：
```bash
# 1. 修复 bug（1.0.0 -> 1.0.1）
npm version patch
# 2. 新增功能（1.0.0 -> 1.1.0）
npm version minor
# 3. 重大更新（1.0.0 -> 2.0.0）
npm version major
# 4. 发布新版本
npm publish
```
## ⚠️ 注意事项
1. **包名可用性**: 确保 `health-reminder-mcp` 没被占用
- 访问：https://www.npmjs.com/package/health-reminder-mcp
- 如果已被占用，需要改名
2. **邮箱验证**: 确保 npm 账号已验证邮箱
3. **发布后无法撤销**: 发布 72 小时后就无法删除包了
4. **版本号不能重复**: 每次发布必须是新版本号
## 🎉 改造完成！
你的代码已经完全准备好发布到 npm 了！
只需要：
1. 修改 package.json 中的个人信息
2. npm login
3. npm publish
就这么简单！🚀
---
**参考文档**: [docs/NPM_PUBLISH.md](docs/NPM_PUBLISH.md)