# 使用 uv（推薦）
uv tool install ruff@latest          # 全局安裝
uv add --dev ruff                    # 添加到項(xiàng)目開發(fā)依賴

# 使用 pip
pip install ruff

# 使用 pipx
pipx install ruff

# 使用 uvx（無需安裝）
uvx ruff check                       # 直接運(yùn)行檢查
uvx ruff format                      # 直接運(yùn)行格式化

# macOS/Linux 獨(dú)立安裝腳本
curl -LsSf https://astral.sh/ruff/install.sh | sh

# Windows 獨(dú)立安裝腳本
powershell -c "irm https://astral.sh/ruff/install.ps1 | iex"

# Homebrew (macOS/Linux)
brew install ruff

# Conda
conda install -c conda-forge ruff

# Docker
docker run -v .:/io --rm ghcr.io/astral-sh/ruff check

ruff --version
ruff check --help          # 查看 linter 選項(xiàng)
ruff format --help         # 查看 formatter 選項(xiàng)

# 檢查當(dāng)前目錄所有 Python 文件
ruff check

# 檢查并自動(dòng)修復(fù)問題
ruff check --fix

# 監(jiān)聽文件變化并重新檢查
ruff check --watch

# 檢查指定路徑
ruff check path/to/code/
ruff check path/to/file.py

# 檢查并顯示所有可用修復(fù)（包括不安全修復(fù)）
ruff check --fix --unsafe-fixes

# 退出碼為 0 即使發(fā)現(xiàn) violations
ruff check --exit-zero

# pyproject.toml
[tool.ruff.lint]
# 啟用規(guī)則
select = ["E", "F", "B", "UP", "SIM", "I"]

# 忽略特定規(guī)則
ignore = ["E501", "F401"]

# 自動(dòng)修復(fù)設(shè)置
fixable = ["ALL"]
unfixable = ["F401"]

[tool.ruff.lint]
select = [
    "E",    # pycodestyle 錯(cuò)誤
    "F",    # Pyflakes
    "UP",   # pyupgrade
    "B",    # flake8-bugbear
    "SIM",  # flake8-simplify
    "I",    # isort
]

ruff check --fix --unsafe-fixes

# 忽略特定規(guī)則
x = 1  # noqa: F841

# 忽略多個(gè)規(guī)則
i = 1  # noqa: E741, F841

# 忽略所有 violations
y = 2  # noqa

# 文件級忽略（放在文件頂部）
# ruff: noqa

# 文件級忽略特定規(guī)則
# ruff: noqa: F401, E501

# 格式化當(dāng)前目錄所有 Python 文件
ruff format

# 格式化指定路徑
ruff format path/to/code/
ruff format path/to/file.py

# 檢查格式但不寫入（用于 CI）
ruff format --check

# 格式化并顯示差異
ruff format --diff

# pyproject.toml
[tool.ruff]
line-length = 88           # 行長度限制（默認(rèn) 88）

[tool.ruff.format]
quote-style = "double"     # 引號風(fēng)格: single/double/preserve
indent-style = "space"     # 縮進(jìn)風(fēng)格: space/tab
line-ending = "auto"       # 行尾: auto/lf/crlf
docstring-code-format = false  # 是否格式化 docstring 中的代碼示例
docstring-code-line-length = "dynamic"  # docstring 代碼行長度

# fmt: off
not_formatted = 3
also_not_formatted = 4
# fmt: on

# 跳過單個(gè)語句
a = [1, 2, 3, 4, 5]  # fmt: skip

[tool.ruff.lint]
ignore = [
    "W191",  # tab-indentation
    "E111",  # indentation-with-invalid-multiple
    "E114",  # indentation-with-invalid-multiple-comment
    "E117",  # over-indented
    "D206",  # docstring-tab-indentation
    "D300",  # triple-single-quotes
    "Q000",  # bad-quotes-inline-string
    "Q001",  # bad-quotes-multiline-string
    "Q002",  # bad-quotes-docstring
    "Q003",  # avoidable-escaped-quote
    "COM812", # missing-trailing-comma
    "COM819", # prohibited-trailing-comma
]

# pyproject.toml
[tool.ruff]
# 全局設(shè)置
line-length = 88
target-version = "py38"
include = ["*.py", "*.pyi", "**/pyproject.toml"]
exclude = [".git", "__pycache__", "build", "dist"]

[tool.ruff.lint]
# 啟用規(guī)則
select = ["E", "F", "B", "UP", "SIM", "I"]

# 忽略特定規(guī)則
ignore = ["E501", "F401"]

# 自動(dòng)修復(fù)設(shè)置
fixable = ["ALL"]
unfixable = []

# 按文件忽略規(guī)則
[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]  # 允許未使用的導(dǎo)入
"tests/**/*.py" = ["B"]   # 測試文件不檢查 bugbear

[tool.ruff.format]
# 格式化設(shè)置
quote-style = "double"
indent-style = "space"
line-ending = "auto"
docstring-code-format = true

# isort 設(shè)置
[tool.ruff.lint.isort]
known-first-party = ["my_package"]
section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]

# 1. 檢查并修復(fù)代碼
ruff check --fix

# 2. 格式化代碼
ruff format

# 3. 僅排序?qū)?
ruff check --select I --fix

# 4. 檢查未使用的 noqa 指令
ruff check --extend-select RUF100 --fix

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.8.0
    hooks:
      # Linter
      - id: ruff
        args: [--fix, --exit-non-zero-on-fix]
      # Formatter
      - id: ruff-format

# GitHub Actions
- name: Run Ruff
  run: |
    pip install ruff
    ruff check --exit-non-zero-on-fix
    ruff format --check

pip install ruff
ruff check --fix
ruff format

code --install-extension charliermarsh.ruff

{
    "[python]": {
        "editor.formatOnSave": true,
        "editor.codeActionsOnSave": {
            "source.fixAll.ruff": "explicit",
            "source.organizeImports.ruff": "explicit"
        },
        "editor.defaultFormatter": "charliermarsh.ruff"
    }
}

{
    // 啟用/禁用 Ruff 擴(kuò)展
    "ruff.enable": true,
    
    // 指定 Python 解釋器路徑（如果擴(kuò)展無法自動(dòng)檢測）
    "ruff.interpreter": ["/usr/bin/python3"],
    
    // 指定 Ruff 可執(zhí)行文件路徑
    "ruff.path": ["/home/user/.local/bin/ruff"],
    
    // 行長度限制
    "ruff.lineLength": 88,
    
    // 啟用的規(guī)則集
    "ruff.lint.select": ["E", "F", "W", "I"],
    
    // 忽略的規(guī)則
    "ruff.lint.ignore": ["E501"],
    
    // 排除的文件/目錄
    "ruff.exclude": ["**/tests/**", "**/vendor/**"],
    
    // 啟用預(yù)覽特性
    "ruff.lint.preview": true,
    "ruff.format.preview": true,
    
    // 配置優(yōu)先級
    "ruff.configurationPreference": "filesystemFirst"
}

# pyproject.toml
[tool.ruff]
line-length = 88
target-version = "py38"
include = ["*.py", "*.pyi", "**/pyproject.toml"]
exclude = [".git", "__pycache__", "build", "dist"]

[tool.ruff.lint]
# 啟用規(guī)則
select = ["E", "F", "B", "UP", "SIM", "I"]
# 忽略規(guī)則
ignore = ["E501"]
# 自動(dòng)修復(fù)設(shè)置
fixable = ["ALL"]
unfixable = []

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]
"tests/**/*.py" = ["B"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
docstring-code-format = true

{
    "ruff.configuration": "${workspaceFolder}/pyproject.toml",
    "ruff.logLevel": "info",
    "ruff.trace.server": "messages",
    "python.defaultInterpreterPath": "${workspaceFolder}/venv/bin/python"
}