mcpField
C
code-simplifier

code-simplifier

github.com/pproenca开发2201.6k 次安装11 周前更新
代码仓库

关于 code-simplifier

面向 AI Agent 和 LLM 的代码简化指南,强调先理解项目约定、保持行为不变并控制改动范围,提供分级规则与示例。

主要功能

  1. 01涵盖 8 类简化规则
  2. 02按影响优先级排列规则
  3. 03强调保留输出、错误和副作用
  4. 04建议控制改动范围并保持差异精简
  5. 05提供控制流、命名和语言习惯指导

适用场景

  1. 01清理近期修改的代码
  2. 02减少嵌套、复杂度或重复
  3. 03改进命名与可读性
  4. 04审查代码的可维护性

安装

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

$npx skills add https://github.com/pproenca/dot-skills --skill code-simplifier

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

包含的文件

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

AGENTS.md
metadata.json
README.md
assets/templates/
_template.md
references/
_sections.md
behave-no-semantics-change.md
behave-preserve-api.md
behave-preserve-errors.md
behave-preserve-outputs.md
behave-preserve-side-effects.md
behave-verify-before-commit.md
ctx-detect-lint-config.md
ctx-follow-existing-patterns.md
ctx-project-over-generic.md
ctx-read-claude-md.md
dead-delete-not-comment.md
dead-keep-why-comments.md
dead-remove-obvious-comments.md
dead-remove-todo-fixme.md
dead-remove-unused.md
dup-avoid-over-abstraction.md
dup-data-driven.md
dup-extract-for-clarity.md
dup-no-single-use-helpers.md
dup-rule-of-three.md
flow-boolean-simplification.md
flow-early-return.md
flow-explicit-over-dense.md
flow-flatten-nesting.md
flow-guard-clauses.md

详细介绍

社区代码简化最佳实践

面向 AI Agent 和大模型的全面代码简化指南。包含 8 个类别中的 47 条规则,按影响程度从关键(上下文发现、行为保留)到渐进(语言惯用写法)排序。每条规则都包含详细说明、对比错误与正确实现的实际示例,以及具体的影响指标。

核心原则

  1. 上下文优先:进行任何更改前,先了解项目约定
  2. 保留行为:改变代码的写法,而不是代码的功能
  3. 严守范围:聚焦于近期修改的代码,保持差异精简
  4. 清晰胜于简短:明确、易读的代码胜过巧妙的单行代码

适用场景

在以下情况下参考这些指南:

  • 简化或清理近期修改的代码
  • 减少嵌套、复杂性或重复
  • 改进命名和可读性
  • 应用特定语言的惯用模式
  • 审查代码的可维护性问题

按优先级划分的规则类别

优先级类别影响前缀规则数
1上下文发现CRITICALctx-4
2行为保留CRITICALbehave-6
3范围管理HIGHscope-5
4控制流简化HIGHflow-9
5命名与清晰度MEDIUM-HIGHname-6
6减少重复MEDIUMdup-5
7消除死代码MEDIUMdead-5
8语言惯用写法LOW-MEDIUMidiom-7

快速参考

1. 上下文发现(CRITICAL)
2. 行为保留(CRITICAL)
3. 范围管理(HIGH)
4. 简化控制流(高)
5. 命名与清晰度(中高)
6. 减少重复(中)
7. 消除死代码(中)
8. 语言习惯用法(低至中)

工作流

  1. 了解上下文:阅读 CLAUDE.md 和 lint 配置,检查现有模式
  2. 确定范围:除非另有要求,否则聚焦于最近修改的代码
  3. 应用转换:按优先级顺序使用规则(先处理 CRITICAL)
  4. 验证行为:确保输出、错误和副作用保持不变
  5. 尽量缩小差异:保持改动小而集中,便于审查

如何使用

阅读各个参考文件,了解详细说明和代码示例:

参考文件

文件说明
references/_sections.md类别定义和排序
assets/templates/_template.md新规则模板
metadata.json版本和参考信息

评论

支持 Markdown