code-simplifier

代码简化器

在进行更改后清理并简化代码。

适用时机

完成某项功能或修复后运行此技能，以确保代码整洁、易读且易于维护。

简化目标

降低复杂度

• 将冗长的函数拆分为更小、更专注的函数
• 减少嵌套层级（最多 3 层）
• 简化复杂的条件语句
• 将魔法数字提取为具名常量

提高可读性

• 使用描述性强的变量名和函数名
• 为不明显的逻辑添加说明性注释
• 确保格式一致
• 删除不必要的注释

使用 Pythonic 模式

• 适当使用列表、字典和集合推导式
• 使用 with 语句管理资源
• 使用 enumerate() 代替手动索引
• 使用 zip() 并行迭代
• 使用 f-string 进行格式化
• 使用 pathlib 处理文件路径

清理代码

• 删除未使用的导入
• 删除未使用的变量
• 删除已注释掉的代码
• 删除冗余的代码路径
• 合并重复逻辑

工作流

1. 识别已更改的文件

   • 聚焦于当前会话中修改的文件
   • 或将文件/目录指定为参数

2. 分析每个文件

   • 检查简化机会
   • 优先处理影响较大的改进

3. 应用简化

   • 逐步进行更改
   • 保持原有行为
   • 每次更改后运行测试

4. 格式化和代码检查

   • 运行 ruff format .
   • 运行 ruff check --fix .

5. 验证

   • 运行测试：pytest
   • 确保行为未改变

参数

可以选择指定要简化的文件或目录。

用法：

• /code-simplifier - 简化最近更改的文件
• /code-simplifier src/module.py - 简化指定文件
• /code-simplifier src/ - 简化整个目录

转换示例

修改前：

result = []
for i in range(len(items)):
    if items[i].is_valid == True:
        result.append(items[i].value)

修改后：

result = [item.value for item in items if item.is_valid]

修改前：

if x != None:
    if y != None:
        if z != None:
            process(x, y, z)

修改后：

if all(v is not None for v in (x, y, z)):
    process(x, y, z)