5分钟上手Ruff命令行：从参数困惑到效率大师

5分钟上手Ruff命令行：从参数困惑到效率大师

【免费下载链接】ruff 一个极其快速的 Python 代码检查工具和代码格式化程序，用 Rust 编写。 项目地址: https://gitcode.com/GitHub_Trending/ru/ruff

你是否也曾面对命令行工具时感到手足无措？参数众多难以记忆，配置过程复杂繁琐，稍有不慎就会出错。别担心，本文将带你5分钟内轻松掌握Ruff命令行参数的使用，让你从参数困惑中解脱，成为效率大师。读完本文，你将学会Ruff核心参数的使用、配置技巧以及自动化方案，让Python代码检查和格式化工作变得轻松高效。

核心参数速查表

Ruff命令行参数	作用	示例	相关文档
check	检查Python代码中的问题	ruff check src/	检查功能说明
format	格式化Python代码	ruff format src/	格式化功能说明
--config	指定配置文件路径	ruff check --config custom.toml src/	配置说明
--fix	自动修复可修复的问题	ruff check --fix src/	修复功能说明
--watch	监视文件变化并自动检查	ruff check --watch src/	监视功能说明

3步配置工作流

初始化配置文件

首先，在项目根目录下创建配置文件。可以使用以下命令生成默认的配置文件：

ruff init

该命令会在当前目录下生成pyproject.toml文件，你可以在其中进行自定义配置。

添加自定义规则

打开pyproject.toml文件，添加自定义的规则。例如，如果你想禁用某个特定的规则，可以添加如下配置：

[tool.ruff]
exclude = ["tests/"]
ignore = ["E501"]

这里排除了tests/目录，并忽略了E501规则（行长度超过限制）。更多规则相关的配置可以参考docs/configuration.md。

集成到IDE

为了提高开发效率，将Ruff集成到你的IDE中。以VS Code为例，安装Ruff插件后，在VS Code的设置中添加如下配置：

{
    "editor.codeActionsOnSave": {
        "source.fixAll.ruff": true
    }
}

这样，在保存文件时，Ruff会自动对代码进行检查和修复。不同IDE的集成方式可能略有不同，详细内容可以参考docs/editors/setup.md。

避坑指南

忽略文件配置

如果你想让Ruff忽略某些文件或目录，可以在pyproject.toml文件中进行配置。例如：

[tool.ruff]
exclude = ["venv/", "dist/"]

这样，Ruff在检查和格式化时就会跳过venv/和dist/目录。

缓存清理

Ruff会缓存检查结果以提高性能，但有时缓存可能会导致问题。如果遇到检查结果不符合预期的情况，可以尝试清理缓存：

ruff cache clean

缓存相关的代码实现可以查看crates/ruff_cache/src/lib.rs。

通过以上内容，相信你已经掌握了Ruff命令行参数的使用和配置方法。赶快动手实践，让Ruff为你的Python开发工作带来便利吧！后续我们还将介绍更多Ruff的高级用法，敬请关注。

【免费下载链接】ruff 一个极其快速的 Python 代码检查工具和代码格式化程序，用 Rust 编写。 项目地址: https://gitcode.com/GitHub_Trending/ru/ruff