Skip to content

PyCharm plugin for ruff. This plugin provides reformat code using ruff.

License

MIT, Apache-2.0 licenses found

Licenses found

MIT
LICENSE
Apache-2.0
LICENSE_apache_version_2.txt
Notifications You must be signed in to change notification settings

koxudaxi/ruff-pycharm-plugin

Repository files navigation

Ruff PyCharm Plugin

License: MIT JetBrains IntelliJ Plugins Rating Total downloads

A ruff integration plugin for JetBrains PyCharm.

See documentation for more details.

Features

  • Inspection and highlighting
  • Integrating Reformat Code with ⌥⇧ ⌘ L or Ctrl+Alt+L
  • Quick Fix (from mouse-over, ⌥⏎ or Alt+Enter)
    • Show fix message
    • Suppressing warnings with # noqa:
  • Show code explanation tooltips when hovering # noqa: <code>
  • Run ruff --fix as an action
  • Run ruff --fix for a file when the file is saved
  • Detect both global and project-specific instances of ruff
    • Always use global ruff command
    • Custom global ruff executable path
    • Detect a project ruff after packages refreshed
  • Execute ruff command as a new process
  • Support ruff config file path as an option
  • Detect ruff executable in Conda environment
  • Detect ruff executable in WSL
  • Support Ruff LSP feature
    • LSP Client
    • LSP Server
      • ruff-lsp integration
      • ruff server integration
    • Live Config Reload: Automatically updates from pyproject.toml and ruff.toml without restarting
  • Support ruff format for ruff version 0.0.289 or later [Experimental]

Support ruff-lsp for only PyCharm Pro/IDEA Ultimate

You can enable it in Preferences/Settings -> Tools -> Ruff -> Use ruff-lsp (Experimental) for PyCharm Pro/IDEA Ultimate

The lsp integration applies only below features:

This is experimental feature.

Screenshots

inspection quickfix settings

Installation

JetBrains Marketplace

You can install the stable version on PyCharm's Marketplace (Preferences -> Plugins -> Marketplace).

search plugin

See the section on managing plugins in the official documentation.

Contribute

See Development section of the documentation.

We are waiting for your contributions to ruff-pycharm-plugin!

Links

Sponsors

JetBrains Logo

JetBrains

Astral Logo

Astral

Datadog, Inc. Logo

Datadog, Inc.