Интеграция с редакторами

Ruff включает встроенный Language Server Protocol (LSP) сервер. Это значит, что любой редактор с поддержкой LSP может использовать Ruff для подсветки ошибок, автодополнения и рефакторинга.

Сервер называется ruff server и запускается автоматически редактором при открытии Python-файлов:

# Запустить LSP-сервер вручную (обычно это делает редактор)
ruff server

Что умеет ruff server:

• Diagnostics — подсветка ошибок и предупреждений
• Code actions — быстрые исправления (fix, ignore, show docs)
• Formatting — форматирование документа
• Hover — показывает описание правила при наведении
• Code lenses — запуск Ruff из интерфейса

Установка расширения

Установи официальное расширение Ruff от Astral Software:

• Открой VS Code
• Перейди в Extensions (Ctrl+Shift+X)
• Найди "Ruff" от Astral Software (ID: charliermarsh.ruff)
• Нажми Install

Также можно установить через командную строку:

code --install-extension charliermarsh.ruff

Настройка для проекта (.vscode/settings.json)

Создай файл .vscode/settings.json в корне проекта:

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

Что делает каждая настройка:

Глобальные настройки VS Code

Чтобы Ruff работал во всех Python-проектах по умолчанию, добавь в глобальный settings.json (Ctrl+Shift+P — "Open User Settings JSON"):

{
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "charliermarsh.ruff"
  },
  "ruff.lint.enable": true,
  "ruff.format.enable": true,
  "ruff.organizeImports": true,
  "ruff.codeAction.disableRuleComment": {
    "enable": true
  },
  "ruff.nativeServer": true
}

Дополнительные настройки VS Code

{
  // Путь к исполняемому файлу ruff
  "ruff.path": ["/path/to/ruff"],

  // Аргументы командной строки для ruff
  "ruff.args": [],

  // Игнорировать файлы по шаблону
  "ruff.ignorePatterns": ["**/migrations/**"],

  // Показывать только предупреждения (не ошибки)
  "ruff.lint.run": "onType",  // или "onSave"

  // Размер кэша для LSP
  "ruff.trace.server": "off"  // "messages" для отладки
}

Быстрые клавиши VS Code

Способ 1: Плагин Ruff

В PyCharm есть официальный плагин Ruff:

1. Открой Settings → Plugins → Marketplace
2. Найди "Ruff"
3. Установи плагин
4. Перезагрузи IDE

Способ 2: File Watchers

Если плагин не подходит, настрой Ruff как внешний инструмент через File Watchers:

Program:  ruff
Arguments: check --fix --stdin-file-path $FilePath$ -
Output paths: $FilePath$
Environment: PYTHONUNBUFFERED=1
Working directory: $ProjectFileDir$

Способ 3: Настройка Ruff как External Tool

Можно добавить Ruff в Tools → External Tools:

Name: Ruff Check
Program: ruff
Arguments: check $FilePath$
Working directory: $ProjectFileDir$

Name: Ruff Format
Program: ruff
Arguments: format $FilePath$
Working directory: $ProjectFileDir$

Neovim поддерживает LSP через built-in LSP клиент с nvim-lspconfig:

-- lazy.nvim
{
  "neovim/nvim-lspconfig",
  config = function()
    local lspconfig = require("lspconfig")
    lspconfig.ruff.setup({
      init_options = {
        settings = {
          -- настройки Ruff (те же, что в pyproject.toml)
        }
      }
    })
  end
}

-- Или через Mason:
{
  "williamboman/mason.nvim",
  opts = {
    ensure_installed = { "ruff" }
  }
}

Более полная конфигурация с keymaps:

vim.api.nvim_create_autocmd("FileType", {
  pattern = "python",
  callback = function()
    vim.keymap.set("n", "<leader>rf", function()
      vim.lsp.buf.format({ async = true })
    end, { desc = "Format with Ruff" })

    vim.keymap.set("n", "<leader>ri", function()
      vim.lsp.buf.code_action({
        context = { only = { "source.organizeImports" } },
        apply = true
      })
    end, { desc = "Organize imports" })

    vim.keymap.set("n", "<leader>rx", function()
      vim.lsp.buf.code_action({
        context = { only = { "source.fixAll" } },
        apply = true
      })
    end, { desc = "Fix all" })
  end,
})

Для интеграции с форматированием (замена black/yapf):

-- Включить Ruff как форматтер
lspconfig.ruff.setup({
  on_attach = function(client, bufnr)
    -- Только форматирование
    client.server_capabilities.documentFormattingProvider = true
  end,
})

Helix имеет встроенную поддержку LSP. Для Ruff настройка в .config/helix/languages.toml:

[language-server.ruff]
command = "ruff"
args = ["server"]

[[language]]
name = "python"
language-servers = ["ruff", "pyright"]

Для форматирования через Ruff:

[language-server.ruff]
command = "ruff"
args = ["server"]

[language-server.pyright]
command = "pyright-langserver"
args = ["--stdio"]

[[language]]
name = "python"
language-servers = ["ruff", "pyright"]
formatter = { command = "ruff", args = ["format", "-"] }

Zed имеет встроенную поддержку Ruff через LSP. Файл конфигурации .config/zed/settings.json:

{
  "languages": {
    "Python": {
      "language_servers": ["ruff", "pyright"],
      "format_on_save": {
        "external": {
          "command": "ruff",
          "arguments": ["format", "--stdin-filename", "{buffer_path}", "-"]
        }
      }
    }
  },
  "lsp": {
    "ruff": {
      "settings": {
        "lineLength": 100,
        "lint": {
          "select": ["E", "F", "I", "N", "UP", "B"]
        }
      }
    }
  }
}

Или с использованием системного конфигурационного файла Ruff:

{
  "languages": {
    "Python": {
      "language_servers": ["ruff"],
      "format_on_save": "on"
    }
  }
}

Zed автоматически предложит установить Ruff, если он не найден в PATH.

Для Sublime Text можно использовать пакет LSP-ruff через Package Control:

1. Установи Package Control (если ещё нет)
2. Ctrl+Shift+P → Package Control: Install Package
3. Найди "LSP-ruff" и установи

Или через ручную настройку LSP:

// Preferences → Package Settings → LSP → Settings
{
  "clients": {
    "ruff": {
      "command": ["ruff", "server"],
      "selector": "source.python",
      "settings": {}
    }
  }
}

eglot (рекомендуется)

(use-package eglot
  :config
  (add-to-list 'eglot-server-programs
               '(python-mode "ruff" "server"))
  :hook
  (python-mode . eglot-ensure))

lsp-mode

(use-package lsp-mode
  :hook (python-mode . lsp-deferred)
  :commands lsp)

(use-package lsp-ruff
  :after lsp-mode
  :config
  (setq lsp-ruff-line-length 100)
  (setq lsp-ruff-lint-select "E,F,I,N,UP,B"))

Для автоформатирования при сохранении:

(add-hook 'python-mode-hook
  (lambda ()
    (add-hook 'before-save-hook 'eglot-format-buffer nil t)))

ale

" .vimrc или init.vim
let g:ale_linters = {'python': ['ruff']}
let g:ale_fixers = {'python': ['ruff_format', 'ruff']}
let g:ale_fix_on_save = 1
let g:ale_python_ruff_options = '--fix'

coc.nvim

" coc-settings.json
{
  "languageserver": {
    "ruff": {
      "command": "ruff",
      "args": ["server"],
      "filetypes": ["python"],
      "rootPatterns": ["pyproject.toml", "ruff.toml", ".git"]
    }
  }
}

Ruff можно использовать не только в редакторах. Вот как интегрировать его в другие инструменты:

watchdog (автоматическая проверка)

# Проверять все Python файлы при изменении
ruff check --watch src/

make / task

# Makefile
.PHONY: lint
lint:
    ruff check

.PHONY: format
format:
    ruff format

.PHONY: lint-fix
lint-fix:
    ruff check --fix

just (команды justfile)

# justfile
lint:
    ruff check

format:
    ruff format

check: lint format

Проблема 1: Ruff не работает в редакторе

Проблема 2: Ruff не форматирует при сохранении

Проблема 3: Конфликт Ruff с другим LSP сервером

"python.linting.enabled": false,
"python.linting.pylintEnabled": false,
"python.linting.flake8Enabled": false,
"python.linting.mypyEnabled": false,
"python.linting.banditEnabled": false

Проблема 4: Ruff не находит pyproject.toml

Проблема 5: Медленная работа в большом проекте

Для автоматизации проверок в CI используйте GitHub Actions. Вот типичный workflow:

# .github/workflows/lint.yml
name: Lint
on: [push, pull_request]
jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - run: pip install ruff
      - run: ruff check
      - run: ruff format --check

С автоисправлением (создаёт PR с исправлениями):

# .github/workflows/ruff-fix.yml
name: Ruff auto-fix
on:
  pull_request:
    types: [opened, synchronize]
jobs:
  fix:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - run: pip install ruff
      - run: ruff check --fix
      - uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: "style: auto-fix ruff issues"

Просмотр логов LSP сервера

Для диагностики проблем с расширением VS Code:

1. Нажми Ctrl+Shift+P → "Developer: Toggle Developer Tools"
2. Перейди на вкладку Console — там могут быть ошибки расширения
3. Или открой View → Output и выбери "Ruff" из выпадающего списка

Настройка verbose-логирования

{
  "ruff.trace.server": "messages",   // логировать все LSP сообщения
  "ruff.trace.server": "verbose",     // максимальный уровень логирования
  "ruff.logLevel": "info",            // info, warn, error, debug
}

Распространённые ошибки в Output панели

Настройте задачи VS Code для быстрого запуска Ruff из редактора. Создайте .vscode/tasks.json:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Ruff: Lint all files",
      "type": "shell",
      "command": "ruff check",
      "problemMatcher": []
    },
    {
      "label": "Ruff: Fix all files",
      "type": "shell",
      "command": "ruff check --fix",
      "problemMatcher": []
    },
    {
      "label": "Ruff: Format all files",
      "type": "shell",
      "command": "ruff format",
      "problemMatcher": []
    }
  ]
}

Запуск: Ctrl+Shift+P → "Tasks: Run Task" → выбери нужную задачу.

Ruff LSP предлагает несколько code actions (быстрых действий) через лампочку или Ctrl+.: