mcpField
C
code-review-html

code-review-html

github.com/chann测试与质量039 次安装3 周前更新
代码仓库

关于 code-review-html

这是 code-review 技能的变体，会生成 Markdown 报告和交互式 HTML 报告。HTML 报告支持韩语与英语切换，并提供逐项评论、复制 Markdown 和反馈生成功能。

主要功能

  1. 01生成 Markdown 与交互式 HTML 报告
  2. 02支持韩语和英语切换
  3. 03显示严重级别并高亮代码
  4. 04提供浅色、深色及代码配色选项
  5. 05支持折叠侧栏和逐项评论
  6. 06复制单项 Markdown 或反馈

适用场景

  1. 01以双语 HTML 阅读代码审查结果
  2. 02在浏览器中评论审查发现
  3. 03复制发现内容或反馈以便修订

安装

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

$npx skills add https://github.com/chann/skills --skill code-review-html

安装后在 Claude Code 中输入/code-review-html确认已加载。

详细介绍

代码审查（HTML 报告）

概述

这是 code-review 技能的一个变体，可生成 Markdown 报告，并且生成独立、交互式的 HTML 报告。

HTML 报告为双语（韩语 + 英语，支持整页语言切换，默认显示韩语），并包含：严重性徽章、语法高亮（支持浅色／深色／自动主题及 8 种代码配色方案）、紧凑的可折叠／可调整大小的侧边栏、每项审查结果的“复制 Markdown”、存储在浏览器中的逐项评论，以及“复制反馈”按钮（可生成用于完善审查的重新生成载荷）。

工作流

开始之前，请先阅读主 code-review SKILL.md：位于 <plugin-root>/skills/code-review/SKILL.md。审查流程步骤、严重性表、语言参考映射和报告 Markdown 模板都在该文件中。本变体依赖这些内容。

主技能中的证据优先写作约定和条件章节规则具有权威性。请勿在此重复或弱化这些规则。

然后严格按照主 SKILL.md 中的审查流程操作——步骤 1–6 全部适用，包括生成 HTML。

简而言之：

  1. 确定审查范围并运行相应的 git diff（参见主 SKILL.md 中的“确定审查范围”）。

  2. 运行 diff_stats.py，加载相关语言的参考资料，并在需要时加载 common-vulnerabilities.md。

  3. 根据五个维度分析差异并评定严重性。为每项审查结果分配稳定的 [CR-001] 样式 ID。

  4. 编写两个结构相同的 Markdown 文件（ID 和代码块均相同）：

    • .reviews/<YYYY-MM-DD>_<short-sha>.md — 韩语，**Language:** ko（主报告）。
    • .reviews/<YYYY-MM-DD>_<short-sha>.en.md — 英语，**Language:** en。

    遵循主技能的证据优先写作约定，并保留对解析器有意义的英文元数据键。

  5. 运行 python <skill-path>/scripts/generate_html_report.py .reviews/<report>.md（脚本会自动检测 .en.md 同名文件，并将两份报告合并为一个 HTML），然后运行 open 打开报告。

  6. 对于这种持久化 HTML 模式，交接内容必须仅包含事实：按严重性统计的审查结果数量、总体风险、Markdown 和 HTML 产物路径、最新验证结果，以及已在浏览器中打开的事实或警告。不要重复报告正文，也不要承诺固定的审查结果数量。

仅当已生成产物且 .reviews/ 尚未被忽略时，才在交接内容中建议忽略 .reviews/。切勿自动修改 .gitignore。

脚本位于 <plugin-root>/skills/code-review/scripts/generate_html_report.py（在主技能中——各变体共用此脚本）。

文件名

  • .reviews/<YYYY-MM-DD>_<short-sha>.md — 韩语报告（主报告）
  • .reviews/<YYYY-MM-DD>_<short-sha>.en.md — 英语报告（译文）
  • .reviews/<YYYY-MM-DD>_<short-sha>.html — 合并后的双语 HTML

参见主 SKILL.md 中的“快速参考／文件名约定”。

语言

默认使用双语——同时撰写韩语和英语（参见主 SKILL.md 中的“双语 HTML 报告”）。在每个文件的页眉中设置 **Language:** ko / en，以便生成器正确标注并切换语言；两个文件中的审查结果 ID 必须保持一致，以确保读者切换语言时，逐项评论仍能对应到相应内容。如果用户明确要求只使用一种语言，则只编写对应文件；生成器会回退为单语言报告并隐藏切换按钮。

风险提示

与主 <plugin-root>/skills/code-review/SKILL.md 中的 Never/Always 列表相同。特别是：绝不自动修改 .gitignore（只能提出建议）；绝不评论差异之外的代码。

集成

搭配使用： git-commit——在提交前进行审查，作为最终质量关卡。

评论

支持 Markdown