mcpField
T
techdebt

techdebt

github.com/meleantonio开发65753 次安装9 周前更新
代码仓库

关于 techdebt

一项用于发现并处理代码库技术债的开发技能。它扫描重复代码、死代码、过时模式和代码异味，并报告、排序、修复和验证问题。

主要功能

  1. 01查找重复代码和死代码
  2. 02标记过时模式与代码异味
  3. 03报告路径、行号和严重程度
  4. 04排序并修复选定问题
  5. 05运行 Ruff 和 pytest 验证

适用场景

  1. 01审查整个代码库的可维护性问题
  2. 02针对文件或目录检查技术债
  3. 03通过 Lint 和测试验证修复

安装

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

$npx skills add https://github.com/meleantonio/awesome-econ-ai-stuff --skill techdebt

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

附带文件index.md

详细介绍

技术债务查找器

识别并修复代码库中的技术债务。

查找内容

代码重复
  • 逻辑相似、可以合并的函数
  • 复制粘贴的代码块
  • 应当抽象出来的重复模式
死代码
  • 未使用的导入
  • 未使用的函数或类
  • 注释掉的代码块
  • 不可达的代码路径
过时模式
  • 使用已弃用的 API
  • 使用旧式字符串格式化（% 或 .format），而非 f 字符串
  • 使用 typing.List 而非 list 的类型提示
  • 公共函数缺少类型提示
代码异味
  • 函数超过 50 行
  • 参数过多（超过 5 个）
  • 嵌套过深（超过 3 层）
  • 未使用常量的魔法数字
  • 过于复杂的条件语句
缺少最佳实践
  • 公共函数缺少文档字符串
  • 缺少错误处理
  • 应当设为配置的硬编码值
  • 关键路径缺少测试

工作流

  1. 扫描代码库

    • 查找与上述问题匹配的模式
    • 根据影响和修复难易程度确定优先级

  2. 报告发现的问题

    • 按类别列出问题
    • 附上文件路径和行号
    • 评估严重程度（高／中／低）

  3. 修复问题

    • 从严重程度高且易于修复的问题开始
    • 为每项修复创建独立提交
    • 每次更改后运行测试

  4. 验证

    • 运行代码检查器：ruff check .
    • 运行测试：pytest
    • 确保没有引入新问题

参数

可指定要重点检查的目录或文件。

用法：

  • /techdebt - 扫描整个项目
  • /techdebt src/ - 扫描指定目录
  • /techdebt src/utils.py - 扫描指定文件

输出

提供以下内容的摘要：

  • 发现的问题（按类别）
  • 已修复的问题
  • 留待后续处理的事项

评论

支持 Markdown