plugin-publish

Zhin 插件发布

引导将 Zhin.js 插件发布到 npm 和 Zhin 插件市场，确保包结构、元数据和质量符合社区标准。

适用场景

• 用户说"发布插件"、"提交到插件市场"、"准备发版"
• 插件开发完成需要分享给社区
• 需要检查插件是否满足发布条件

发布前检查清单

第 1 步：包元数据检查

验证 package.json 必需字段：

{
  "name": "zhin.js-{name}",          // ✅ 社区前缀
  "version": "0.1.0",                 // ✅ 语义化版本
  "type": "module",                    // ✅ ESM
  "description": "插件简介",           // ✅ 非空描述
  "main": "./lib/index.js",           // ✅ 入口指向编译产物
  "types": "./lib/index.d.ts",        // ✅ 类型声明
  "exports": {
    ".": {
      "types": "./lib/index.d.ts",
      "development": "./src/index.ts", // ✅ 开发条件导出
      "import": "./lib/index.js"
    },
    "./package.json": "./package.json"
  },
  "files": [                           // ✅ 发布文件白名单
    "src", "lib", "client", "dist",
    "skills", "tools",
    "README.md", "CHANGELOG.md"
  ],
  "keywords": ["zhin.js", "plugin"],   // ✅ 包含 zhin.js 关键词
  "peerDependencies": {
    "zhin.js": ">=x.x.x"              // ✅ 声明框架兼容版本
  },
  "license": "MIT",                    // ✅ 开源协议
  "repository": { "url": "..." },      // 推荐：仓库地址
  "homepage": "...",                    // 推荐：文档地址
  "author": "..."                       // 推荐：作者信息
}

插件市场识别条件：

• name 以 zhin.js- 开头（社区）或 @zhin.js/ 开头（官方）
• keywords 包含 zhin.js
• peerDependencies 包含 zhin.js

第 2 步：代码质量检查

# 1. 类型检查
pnpm build            # 确保 tsc 编译通过，无类型错误

# 2. 运行测试
pnpm test             # 确保所有测试通过

# 3. 覆盖率检查
pnpm test:coverage    # 确保覆盖率达标

质量底线：

• tsc 编译零错误
• 所有测试通过
• 语句覆盖率 ≥ 60%
• 无 any 类型滥用
• 无未处理的 TODO/FIXME 阻塞发布

第 3 步：文档检查

README.md 必须包含：

• 插件功能简介
• 安装步骤（pnpm add zhin.js-{name}）
• 配置说明（配置项及默认值）
• 命令列表（如有）
• AI 工具说明（如有）
• 使用示例

CHANGELOG.md 必须包含：

• 当前版本的变更记录
• 遵循 Keep a Changelog 格式

关键词： 有 skills/ 目录时，确认 SKILL.md 的 description 准确描述插件能力。

第 4 步：构建产物检查

# 确保 lib/ 目录存在且完整
ls lib/

# 检查将要发布的文件
npm pack --dry-run

确认 npm pack 输出的文件列表：

• ✅ 包含 lib/（编译后的 JS + d.ts）
• ✅ 包含 src/（源码，供开发模式使用）
• ✅ 包含 skills/（AI 技能描述）
• ✅ 包含 README.md、CHANGELOG.md
• ❌ 不包含 node_modules/、tests/、.env
• ❌ 不包含 coverage/、.DS_Store