Prettier 格式强制执行机器人
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/prettier-format-enforcement-bot
技能介绍
要解决的问题
团队代码风格不统一时,Code Review 很容易被格式化差异淹没。不同编辑器、不同版本的 Prettier、或缺少配置同步,都会让同一仓库出现多套缩进、引号与换行规则。结果是 diff 里混入大量无意义改动,真正的逻辑变更被冲淡。
Prettier 本身已经能解决格式化规则的定义问题,但真正执行仍需接入检查入口。这个技能用 Prettier 的公开 API,把校验和修正接到工作流里,减少靠个人自觉执行的环节。
技能如何工作
技能直接调用 Prettier 的能力,核心点可以归为三类:
- 格式校验:调用
prettier.check(),在不改文件的前提下判断代码是否符合当前规则,适合放进 CI 或提交前检查。 - 格式修正:调用
prettier.format(),对不符合规范的代码做重排,输出可用于回写或作为补丁。 - import 整理:集成
prettier-plugin-organize-imports,在格式化过程中一并处理导入顺序和未使用引用,减少额外脚本。
配置方面,技能支持从项目根目录读取 .prettierrc,因此团队已有的 Prettier 规则可以直接沿用,不需要重建一套独立约定。语言层面跟随 Prettier 原生支持范围,覆盖常见前端与脚本语言,日常仓库里出现的 .js、.ts、.json、.css 等基本都能处理。
典型流程是:确定目标文件范围,读取 .prettierrc 与 Prettier 版本环境,执行 check() 或 format(),根据返回结果决定阻断提交、输出差异,还是自动改写文件。
适用边界与注意点
这个技能适合把 Prettier 的格式约束接入自动化入口,比如 CI 检查、提交前钩子,或本地保存时的即时校验。它不替代代码评审,也不负责判断逻辑正确性;格式合规的代码仍可能存在 bug。
需要注意,当前 SKILL.md 未提供可直接使用的安装与运行步骤。实际接入前建议先在测试分支验证 Prettier 版本、插件依赖以及 .prettierrc 的匹配情况,确认输出符合预期后再用于正式流程。
使用场景
- 提交前用 prettier.check() 校验改动文件,按 .prettierrc 阻断不合规提交
- 在 CI 步骤对新增 JS/TS 文件调用 prettier.format() 并写回,减少格式 diff
- 编辑 TSX 后调用 prettier-plugin-organize-imports 整理导入顺序,清理未使用引用
- 跨语言仓库中按 .prettierrc 对 JSON、CSS、Markdown 等 20+ 语言统一执行格式化
适合人员
- 后端工程师:希望在提交前用 .prettierrc 统一代码格式,减少评审中的格式争论
- 开源维护者:希望在 CI 中调用 prettier.check() 拦截不合规提交,保护主干一致性
- 前端工程师:希望借助 organize-imports 插件统一 TSX 导入顺序,避免手动整理
- 多语言仓库贡献者:希望按 .prettierrc 对 JSON、CSS、Markdown 等文件统一格式化