Ruff 代码检查与格式化工具
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/ruff-linter-formatter-agent。
技能介绍
解决什么问题
Python项目中,代码检查和格式化常依赖多个工具(如Black、isort、Flake8),不仅配置分散,执行速度也随着项目规模增长而下降。开发者常面临规则不一致、工具链切换成本高、格式化效率低三类问题。
如何工作
这个技能通过调用ruff命令行工具,将linting和格式化集成到统一流程中。核心能力包括:
- 自动修复:对可修复问题(如未使用导入、格式错误)直接执行修正
- 导入排序:兼容isort规则,自动规范import顺序
- 规则集选择:支持从800+内置规则中按需启用/禁用
- 配置驱动:通过
pyproject.toml集中管理规则,避免分散配置
典型使用流程:
- 在项目中配置
pyproject.toml定义规则集 - 执行
ruff check .进行linting并自动修复 - 运行
ruff format .完成代码格式化
适用边界
- 需确保项目使用
pyproject.toml管理配置,非Python项目不适用 - 规则集选择需团队共同维护,避免过度严格的规则影响开发效率
- 作为Rust实现的工具,依赖环境需包含
ruff可执行文件
使用场景
- 在Python项目中统一代码风格,使用自动格式化功能调整缩进和空行
- 团队协作时通过配置规则集统一导入排序标准,减少代码审查冲突
- 处理遗留代码时批量修复未使用的导入和变量,降低手动修改工作量
- 配置CI流程时集成Ruff检查,在提交阶段自动拦截格式问题
适合人员
- Python后端工程师,需要快速统一大型项目代码风格的开发者
- 技术团队负责人,希望规范团队代码审查标准并减少格式争论
- 开源项目维护者,需要在合并PR前自动检查贡献者代码格式
- 机器学习工程师,需要在模型迭代时保持数据处理脚本的代码规范