mcpField
1
1k-pkg-upgrade-review

1k-pkg-upgrade-review

github.com/onekeyhq测试与质量2.5k54 次安装今天更新
代码仓库

关于 1k-pkg-upgrade-review

用于评估 npm/Yarn 依赖升级的代码审查技能，面向处理依赖更新的开发团队。它比较版本源码、追踪项目调用点，并生成结构化兼容性报告。

主要功能

  1. 01比较升级前后的源码
  2. 02分类 API 与行为变化
  3. 03搜索直接和间接依赖用法
  4. 04追踪调用点并评估兼容风险
  5. 05生成报告并评论到 PR

适用场景

  1. 01审查 Dependabot 或 Renovate 更新
  2. 02评估 yarn.lock 或 package-lock.json 变更
  3. 03检查手动依赖升级的兼容性
  4. 04在合并前了解包内部变化

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/onekeyhq/app-monorepo --skill 1k-pkg-upgrade-review

安装后在 Claude Code 中输入/1k-pkg-upgrade-review确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
example-report.md
references/rules/
report-template.md
review-workflow.md

详细介绍

包升级审查

通过执行源码级 diff 分析、追踪所有调用点并生成结构化兼容性报告，评估 npm/yarn 包版本升级。

输出语言：中文（与团队规范一致）。

快速参考

主题指南描述
审查工作流review-workflow.md分步审查流程
报告模板report-template.md输出格式与风险指南
示例报告example-report.md真实案例：@isaacs/brace-expansion 5.0.0 -> 5.0.1

何时使用

  • 提升依赖版本的 Dependabot / Renovate PR
  • 手动 yarn upgrade 或 npm update 变更
  • 任何修改 yarn.lock 或 package-lock.json 的 PR
  • 当团队需要在合并前了解包内部实际变更内容时

工作流概览

  1. 识别包名与版本范围（旧 -> 新）
  2. 从 npm registry 下载两个版本并解压
  3. 对比两个版本之间的源码（关注 JS/TS，而非元数据）
  4. 分类变更：API 签名、返回值、新增导出、移除导出、行为变更
  5. 在项目源码中搜索直接 import/使用
  6. 在 node_modules 中搜索经由中间包的间接使用
  7. 追踪每个调用点以验证参数使用与兼容性
  8. 评估兼容性风险：签名、返回类型、返回内容、副作用
  9. 生成结构化报告到 node_modules/.cache/pkg-upgrade/
  10. 通过 gh pr comment 将完整报告发布为 PR 评论

关键命令

# Download and extract both versions for diffing
mkdir -p /tmp/pkg-diff && cd /tmp/pkg-diff
curl -sL $(npm view PKG@OLD_VER dist.tarball) | tar xz -C old
curl -sL $(npm view PKG@NEW_VER dist.tarball) | tar xz -C new

# Compare file lists
diff -rq old/package new/package

# Diff main source
diff old/package/dist/commonjs/index.js new/package/dist/commonjs/index.js

# Search project code for direct usage
grep -r "PACKAGE_NAME" --include="*.ts" --include="*.tsx" --include="*.js" -l . \
  --exclude-dir=.git --exclude-dir=node_modules

# Search node_modules for indirect usage
grep -rn "from ['\"]PACKAGE_NAME['\"]" node_modules/ --include="*.js" --include="*.mjs" \
  | grep -v "node_modules/.cache"

# Check package metadata
npm view PKG@NEW_VER deprecated
npm view PKG@NEW_VER dist.integrity

报告输出

  • 本地文件：node_modules/.cache/pkg-upgrade/<package-name>-<old>-to-<new>.md
  • PR 评论：完整报告还必须通过 gh pr comment 发布为 PR 上的评论

相关技能

  • /1k-code-review-pr - 全面的 PR 代码审查（安全性、代码质量、平台模式）

评论

支持 Markdown