Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/koxudaxi/ruff-pycharm-plugin

PyCharm plugin for ruff. This plugin provides reformat code using ruff.
https://github.com/koxudaxi/ruff-pycharm-plugin

format intelij pycharm pycharm-plugin python ruff

Last synced: 1 day ago
JSON representation

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

Host: GitHub
URL: https://github.com/koxudaxi/ruff-pycharm-plugin
Owner: koxudaxi
License: mit
Created: 2022-12-01T15:35:17.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2025-01-05T17:41:19.000Z (18 days ago)
Last Synced: 2025-01-08T10:02:36.690Z (16 days ago)
Topics: format, intelij, pycharm, pycharm-plugin, python, ruff
Language: Kotlin
Homepage:
Size: 2.91 MB
Stars: 231
Watchers: 5
Forks: 10
Open Issues: 41
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Ruff PyCharm Plugin

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![JetBrains IntelliJ Plugins](https://img.shields.io/jetbrains/plugin/v/20574)](https://plugins.jetbrains.com/plugin/20574-ruff)

[![Rating](https://img.shields.io/jetbrains/plugin/r/rating/20574-ruff)](https://plugins.jetbrains.com/plugin/20574-ruff)

[![Total downloads](https://img.shields.io/jetbrains/plugin/d/20574-ruff)](https://plugins.jetbrains.com/plugin/20574-ruff)

A [`ruff`](https://github.com/charliermarsh/ruff) integration [plugin](https://plugins.jetbrains.com/plugin/20574-ruff) for [JetBrains PyCharm](https://www.jetbrains.com/pycharm/).

See [documentation](https://koxudaxi.github.io/ruff-pycharm-plugin/) for more details.

## Features

- [x] Inspection and highlighting

- [x] Integrating `Reformat Code` with `⌥⇧ ⌘ L` or `Ctrl+Alt+L`

- [x] Quick Fix (from mouse-over, `⌥⏎` or `Alt+Enter`)

  - [x] Show fix message

  - [x] Suppressing warnings with `# noqa:`

- [x] Show code explanation tooltips when hovering `# noqa: `

- [x] Run `ruff --fix` as an action

- [x] Run `ruff --fix` for a file when the file is saved

- [x] Detect both global and project-specific instances of `ruff`

  - [x] Always use global `ruff` command

  - [x] Custom global `ruff` executable path

  - [x] Detect a project ruff after packages refreshed

- [x] Execute `ruff` command as a new process

- [x] Support `ruff` config file path as an option

- [x] Detect `ruff` executable in Conda environment

- [x] Detect `ruff` executable in WSL

- [x] Support Ruff LSP feature

  - LSP Client

    - [x] [Intellij LSP integration](https://blog.jetbrains.com/platform/2023/07/lsp-for-plugin-developers/) for PyCharm Pro/IDEA Ultimate

    - [x] [LSP4IJ by RedHat](https://github.com/redhat-developer/lsp4ij) (Requires installation of the [LSP4IJ plugin](https://plugins.jetbrains.com/plugin/23257-lsp4ij))

  - LSP Server

    - [x] `ruff-lsp` integration

    - [x] `ruff server` integration

  - [x] Live Config Reload: Automatically updates from `pyproject.toml` and `ruff.toml` without restarting

- [x] 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:

- Errors/warnings highlighting ([textDocument/publishDiagnostics](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics))

- Quick-fixes for these errors/warnings ([textDocument/codeAction](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction)

_This is experimental feature._

## Screenshots

![inspection](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/inspection.png)

![quickfix](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/quickfix.png)

![settings](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/settings.png)

## Installation

### JetBrains Marketplace

You can install the stable version on PyCharm's `Marketplace` (_Preferences_ -> _Plugins_ -> _Marketplace_).

![search plugin](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/search_plugin.png)

See the section on [managing plugins](https://www.jetbrains.com/help/idea/managing-plugins.html) in the official documentation.

## Contribute

See [Development](https://koxudaxi.github.io/ruff-pycharm-plugin/development/) section of the documentation.

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

## Links

* [JetBrains Plugin Page](https://plugins.jetbrains.com/plugin/20574-ruff)

* [Pydantic PyCharm Plugin](https://github.com/koxudaxi/pydantic-pycharm-plugin/)

## Sponsors

  

    

    

      

      
JetBrains


    

    

  

    

      

      Astral

    

  

  

    

      

      Datadog, Inc.