news 2026/8/7 11:46:01

我开源了一个 code-groom 代码组织梳理 skill

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
我开源了一个 code-groom 代码组织梳理 skill

code-groom

摘要:code-groom 是一个专注于代码结构梳理而非风格美化的工具。它通过五条判断原则(单一数据源、单层抽象、封装、消冗余、状态找主人)和七条操作规则(谁产生谁持有、死代码清除等),提供语言无关的代码结构自查框架,帮助开发者识别冗余中间层、状态分散、函数职责过多等底层问题,最终实现只改内部组织而不改变外部行为的代码优化。

代码组织梳理,不是风格美化。

大多数代码审查工具关注命名、格式和 lint 规则。code-groom 关注更底层的问题:冗余的中间层、散落在调用方身上的状态、一个函数干了好几层的事。它提供五条判断原则(改不改)加七条操作规则(怎么改),是一套语言无关的代码结构自查框架。

当你觉得代码"臃肿但说不上哪不对"时,用它过一遍。


安装

方式一:通过 AI 安装(推荐)

将以下提示词发送给你的 AI Agent:

请根据 https://skillhub.cn/install/skillhub.md,安装 code-groom。

方式二:Git 克隆

gitclone https://gitee.com/code-ape-hc/code-groom.git

然后将code-groom目录放入你的 Agent 的 skills 目录:

  • WorkBuddy:~/.workbuddy/skills/code-groom/
  • Claude Code:~/.claude/skills/code-groom/
  • 其他支持 SkillHub 的客户端: 见各自文档

安装后,对 Agent 说"梳理代码"或"groom"即可触发。

核心方法

五原则(判断力 — 改不改)

原则一句话
单一数据源同一份值有没有在多处重复定义?→ 收归一处
单层抽象一个函数做了超过一层的事?→ 拆成编排层 + 细节函数
封装外部能改这个模块的内部字段吗?→ 加只读或私有
消冗余方法体只有一行调另一个方法?→ 内联,删方法
状态找主人内部状态散落在调用方身上?→ 抽成类,构造/dispose 收口

七规则(操作手法 — 怎么改)

规则自查动作
R1 谁产生谁持有变量产生端自持,不让外部传回来
R2 死代码清除搜索引用数:0 删,1 考虑内联
R3 纯转发删除方法体一行调同名方法 → 删
R4 出口收进消费端仅内部用的公开接口 → 不公开
R5 动态适配用接口不同场景不同行为 → 接口注入,不写死实现
R6 小文件合并同职责 < 50 行 → 合
R7 重复模式抽方法同一结构 ≥ 2 次 → 抽

执行流程

  1. 扫描影响范围— 谁持有谁调用、谁监听谁发射、类型定义在哪
  2. 过五原则— 逐条问"我这个改动违反吗?"
  3. 过七规则— 具体动手时逐条执行
  4. 自验— 编译检查 + 竞态复核

约束

  • 行为零变化:只改内部组织,不改外部行为
  • 不过度抽象:拆出来 3 行且只被一处调用 → 不拆
  • 不扩大范围:只改命中的点,跨模块只记录不改

与其他工具的区别

code-groomlinter重构工具
关注点结构骨架(抽象层级、状态归属)格式风格(缩进、命名)行为变更(拆分模块、换算法)
语言绑定特定语言特定语言
输出改动清单 + 原因错误列表新代码
版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/8/7 11:38:13

《智能项目管理 AI 辅助创业决策 线上高并发排障实战》

《智能项目管理 AI 辅助创业决策 线上高并发排障实战》 作者: 钟伊人 (钟哩哩) 技术方向: AI 效率工具产品化、智能项目管理、AI 辅助创业决策、操作系统与端侧 AI 结合 &#x1f4a1; 导语与现场排障背景 在生产环境重构 智能项目管理与 AI 辅助创业决策 时&#xff0c;高并…

作者头像 李华
网站建设 2026/8/7 11:33:58

Forza Mods AIO终极指南:5分钟掌握《极限竞速地平线》修改技巧

Forza Mods AIO终极指南&#xff1a;5分钟掌握《极限竞速地平线》修改技巧 【免费下载链接】Forza-Mods-AIO Free and open-source FH4 & FH5 mod tool 项目地址: https://gitcode.com/gh_mirrors/fo/Forza-Mods-AIO 想要彻底改变《极限竞速地平线4/5》的游戏体验吗…

作者头像 李华
网站建设 2026/8/7 11:33:44

基于OpenBuddy与RAG技术构建私有化智能客服助手实战指南

1. 项目概述&#xff1a;为什么我们需要一个“私域”客服助手&#xff1f;最近和几个做电商、知识付费的朋友聊天&#xff0c;大家普遍头疼一个问题&#xff1a;客服成本越来越高&#xff0c;但服务质量却像开盲盒。用市面上的SaaS客服机器人吧&#xff0c;总担心自己的客户数据…

作者头像 李华
网站建设 2026/8/7 11:31:59

从零开始的敲代码生活--C语言篇(运算符)

运算符包括算术运算符、关系运算符、逻辑运算符、赋值运算符、逗号运算符等一、运算符分类1. 算术运算符符号&#xff1a; - * / % --&#xff08;加&#xff0c;减&#xff0c;乘&#xff0c;除&#xff0c;取余&#xff0c;自增&#xff0c;自减&#xff09;其中 - * / %为双…

作者头像 李华