mcpField
O
openpress-apply-comments

openpress-apply-comments

github.com/quan0715文档处理1460 次安装9 周前更新
代码仓库

关于 openpress-apply-comments

openpress-apply-comments 是用于处理源文件中待办 @openpress-comment 标记的工作流技能,面向维护 OpenPress 文档的 Agent。它指导按评论执行小范围修改、完成后移除标记,并验证结果。

主要功能

  1. 01查找待处理评论标记
  2. 02读取评论说明与源码上下文
  3. 03按要求修改源文件
  4. 04修改完成后移除标记
  5. 05验证并报告处理结果

适用场景

  1. 01逐条落实文档源码中的审阅意见
  2. 02在修改后确认评论标记已正确清理
  3. 03遇到含糊或失败的评论时保留标记

安装

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

$npx skills add https://github.com/quan0715/open-press --skill openpress-apply-comments

安装后在 Claude Code 中输入/openpress-apply-comments确认已加载。

详细介绍

open-press 应用评论

这是用于将待处理的 @openpress-comment 标记转换为源文件编辑的工作流技能。只有在完成所请求的源文件修改并移除标记后,评论才算解决。

openpress-collaborate 负责确定 Agent 应提出建议、刷新、应用已审阅的预览,还是直接编辑。本技能负责标记的处理方式。如果用户要求应用 .openpress/review/current.json,请返回 openpress-collaborate,不要将评论解读为单独的一批直接编辑。

职责

  • 列出待处理的 @openpress-comment 标记。
  • 读取解码后的评论说明、提示、源文件路径和附近的源代码。
  • 进行小幅源文件修改,以应用所请求的编辑。
  • 完成编辑后移除标记。
  • 保留含义不明确或处理失败的评论。
  • 在报告完成前进行验证。

边界

  • 不确定时,使用 openpress 查看权威的源文件/生成文件路径表。
  • 编辑源文件,而不是生成的输出。
  • 默认编辑包含标记的源文件。
  • 将领域性较强的工作转交给负责的技能:
    • openpress-create-pages 负责页面文案、层级、说明文字、主张、语气、叙事、页面主题和页面组件。
    • openpress-create-slide 负责演示文稿叙事、幻灯片内容密度、直接幻灯片源文件、当前主题令牌、核心 Object API 组合、Tailwind 语义化样式和可复用 UI 原语。
    • openpress-plugins 负责外部绘图、视觉工具和写作辅助工具。
  • 解决单条评论时,不要重写无关部分。

工作流

  1. 发现评论。

    rg "@openpress-comment" press -n
    

    如果需要解码后的说明,且框架辅助工具可用,请使用它:

    node --input-type=module -e 'import { listCommentMarkers } from "./packages/core/engine/react/comment-marker.mjs"; console.log(JSON.stringify(await listCommentMarkers({ root: process.cwd() }), null, 2));'
    
  2. 选择所请求的范围。

    • 如果用户指定了一条评论,只解决该评论。
    • 如果用户要求应用评论但未指定 id,请按源文件中的顺序处理待处理评论。
    • 一次处理一条评论;不要在一个标记下批量进行互不相关的重写。
  3. 检查目标。

    • 读取包含标记的源文件。
    • 编辑前检查附近的行。
    • 如有标记提示和渲染对象元数据,请参考它们,但仍须以源文件为准进行核实。
  4. 应用编辑。

    • 进行满足评论要求的最小源文件修改。
    • 保持本地风格、组件 API 和 MDX 结构。
    • 如果请求含义不明确,请求澄清并保留标记。
  5. 移除已解决的标记。

    • 只有在完成源文件编辑后,才删除 @openpress-comment 标记。
    • 不要仅仅因为读过标记就清除它。
    • 只有用户明确要求时,才在不应用编辑的情况下清除标记。
  6. 验证。

    npm run build
    

    build 会验证结构并渲染完整输出。快速迭代内部步骤时:

    node engine/cli.mjs validate .   # structural checks only, no render
    node engine/cli.mjs export .     # rewrite document.json only, no Vite bundle
    

完成报告

报告以下内容:

  • 已解决的评论 id,
  • 已更改的文件,
  • 因含义不明确或处理失败而保留的评论,
  • 运行了哪些验证命令,以及是否通过。

常见错误

  • 不要编辑 public/openpress/、dist-react/、.deploy/ 或 .openpress/。只有独立的 openpress-collaborate 工作流负责 .openpress/review/current.json。
  • 不要移除尚未解决的评论。
  • 除非评论明确要求,否则不要重写大段内容。
  • 如果需要导出,在源文件导出之前,不要声称浏览器中的内容已更改。

评论

支持 Markdown