Ruff 完全ガイド：Rust で書き直された Python コードチェックツール、Flake8 の 100 倍高速

# 方法 1：pip を使用（推奨）
pip install ruff

# 方法 2：uv を使用（より高速）
uv tool install ruff

# 方法 3：macOS Homebrew
brew install ruff

# 方法 4：公式インストールスクリプト
curl -LsSf https://astral.sh/ruff/install.sh | sh

# インストール確認
ruff --version
# 出力：ruff 0.9.x

import os
import sys
import json  # unused

def  hello_world():
    x=1+2
    print("hello world")
    return x

if __name__ == "__main__":
    hello_world()

ruff check hello.py

ruff check --fix hello.py

def hello_world():
    x = 1 + 2
    print("hello world")
    return x

if __name__ == "__main__":
    hello_world()

ruff format hello.py

[tool.ruff]
# 対象 Python バージョン
target-version = "py312"
# 1 行の文字数制限
line-length = 88
# チェック対象のディレクトリ
src = ["src", "tests"]
# 除外するディレクトリ
exclude = [
    ".git",
    ".venv",
    "__pycache__",
    "build",
    "dist",
]

[tool.ruff.lint]
# 有効にするルールセット
select = [
    "E",      # pycodestyle エラー
    "W",      # pycodestyle 警告
    "F",      # pyflakes
    "I",      # isort（import ソート）
    "UP",     # pyupgrade（バージョンアップ推奨）
    "B",      # flake8-bugbear（一般的なバグパターン）
    "SIM",    # flake8-simplify（コード簡素化）
    "RUF",    # Ruff 独自ルール
]
# 無視するルール
ignore = [
    "E501",   # 行が長すぎる（フォーマッターに任せる）
    "E402",   # import がファイルの先頭にない（一部のスクリプトで必要）
]
# 許容される最大複雑度
mccabe.max-complexity = 10

[tool.ruff.lint.per-file-ignores]
# テストファイルでは一部のルールを無視
"tests/**/*.py" = ["S101", "PLR2004"]
# マイグレーションファイルでは全ルール無視
"**/migrations/*.py" = ["ALL"]

[tool.ruff.format]
# クォートスタイル：シングルクォートまたはダブルクォート
quote-style = "double"
# インデントの種類
indent-style = "space"
# 末尾の改行
skip-magic-trailing-comma = false

pip uninstall black isort flake8 autoflake pyupgrade -y

[tool.ruff]
line-length = 88          # Black のデフォルト行幅
target-version = "py312"

[tool.ruff.format]
quote-style = "double"    # Black のデフォルトはダブルクォート
indent-style = "space"

[tool.ruff.lint]
select = ["E", "W", "F", "I"]

# ステップ 1：すべての Python ファイルをフォーマット
ruff format .

# ステップ 2：チェックして自動修正
ruff check --fix .

# ステップ 3：残りの問題を確認（自動修正しない）
ruff check .

repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.9.0
    hooks:
      # フォーマットを先に実行
      - id: ruff-format
      # その後チェック
      - id: ruff
        args: [--fix, --exit-non-zero-on-fix]

pip install pre-commit
pre-commit install

name: Ruff Check

on: [push, pull_request]

jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install Ruff
        run: pip install ruff

      - name: Run Ruff format check
        run: ruff format --check .

      - name: Run Ruff lint
        run: ruff check --output-format=github .

ruff:
  image: python:3.12-slim
  stage: test
  script:
    - pip install ruff
    - ruff format --check .
    - ruff check .
  allow_failure: true  # 最初は失敗を許可しておくと安心

# 変更されたファイルのみをチェック（CI 向け）
ruff check --diff .

# SARIF 形式で出力（GitHub Code Scanning 用）
ruff check --output-format=sarif . > results.sarif

# 特定のルールのみチェック
ruff check --select=F,E .

# Ruff の設定とキャッシュ状態を確認
ruff check --show-settings .

[tool.ruff.lint]
select = ["E", "F", "W"]

# 一部のルールをエラーではなく警告に設定
[tool.ruff.lint.flake8-errmsg]
max-string-length = 20

[tool.ruff.lint.pydocstyle]
convention = "google"  # または "numpy", "pep257"

// .vscode/settings.json
{
  "[python]": {
    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.codeActionsOnSave": {
      "source.fixAll.ruff": "explicit"
    }
  }
}

# ファイルの変更を監視して自動再チェック
ruff check --watch .

# JSON 形式で出力。jq で処理可能
ruff check --output-format=json . | jq '.'

# または sarif 形式で GitHub Code Scanning と連携
ruff check --output-format=sarif . > ruff-results.sarif