{"id":15136020,"url":"https://github.com/koxudaxi/ruff-pycharm-plugin","last_synced_at":"2025-04-12T17:44:33.912Z","repository":{"id":64167210,"uuid":"573049342","full_name":"koxudaxi/ruff-pycharm-plugin","owner":"koxudaxi","description":"PyCharm plugin for ruff.  This plugin provides reformat code using ruff.","archived":false,"fork":false,"pushed_at":"2025-04-02T02:01:23.000Z","size":3163,"stargazers_count":250,"open_issues_count":34,"forks_count":12,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-03T21:11:20.518Z","etag":null,"topics":["format","intelij","pycharm","pycharm-plugin","python","ruff"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koxudaxi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["koxudaxi"]}},"created_at":"2022-12-01T15:35:17.000Z","updated_at":"2025-03-21T12:20:59.000Z","dependencies_parsed_at":"2024-01-25T19:27:06.466Z","dependency_job_id":"b8743d08-4c90-4a3a-a250-565afd6491dc","html_url":"https://github.com/koxudaxi/ruff-pycharm-plugin","commit_stats":{"total_commits":526,"total_committers":11,"mean_commits":47.81818181818182,"dds":0.3821292775665399,"last_synced_commit":"02c890b8a0baad49445bedd3b69cee6c128b43d9"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fruff-pycharm-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fruff-pycharm-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fruff-pycharm-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fruff-pycharm-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koxudaxi","download_url":"https://codeload.github.com/koxudaxi/ruff-pycharm-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248609446,"owners_count":21132913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["format","intelij","pycharm","pycharm-plugin","python","ruff"],"created_at":"2024-09-26T06:03:37.492Z","updated_at":"2025-04-12T17:44:33.870Z","avatar_url":"https://github.com/koxudaxi.png","language":"Kotlin","funding_links":["https://github.com/sponsors/koxudaxi"],"categories":[],"sub_categories":[],"readme":"# Ruff PyCharm Plugin\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![JetBrains IntelliJ Plugins](https://img.shields.io/jetbrains/plugin/v/20574)](https://plugins.jetbrains.com/plugin/20574-ruff)\n[![Rating](https://img.shields.io/jetbrains/plugin/r/rating/20574-ruff)](https://plugins.jetbrains.com/plugin/20574-ruff)\n[![Total downloads](https://img.shields.io/jetbrains/plugin/d/20574-ruff)](https://plugins.jetbrains.com/plugin/20574-ruff)\n\nA [`ruff`](https://github.com/charliermarsh/ruff) integration [plugin](https://plugins.jetbrains.com/plugin/20574-ruff) for [JetBrains PyCharm](https://www.jetbrains.com/pycharm/).\n\nSee [documentation](https://koxudaxi.github.io/ruff-pycharm-plugin/) for more details.\n\n\u003c!-- Plugin description --\u003e\n## Features\n- [x] Inspection and highlighting\n- [x] Integrating `Reformat Code` with `⌥⇧ ⌘ L` or `Ctrl+Alt+L`\n- [x] Quick Fix (from mouse-over, `⌥⏎` or `Alt+Enter`)\n  - [x] Show fix message\n  - [x] Suppressing warnings with `# noqa:`\n- [x] Show code explanation tooltips when hovering `# noqa: \u003ccode\u003e`\n- [x] Run `ruff --fix` as an action\n- [x] Run `ruff --fix` for a file when the file is saved\n- [x] Detect both global and project-specific instances of `ruff`\n  - [x] Always use global `ruff` command\n  - [x] Custom global `ruff` executable path\n  - [x] Detect a project ruff after packages refreshed\n- [x] Execute `ruff` command as a new process\n- [x] Support `ruff` config file path as an option\n- [x] Detect `ruff` executable in Conda environment\n- [x] Detect `ruff` executable in WSL\n- [x] Support Ruff LSP feature\n  - LSP Client\n    - [x] [Intellij LSP integration](https://blog.jetbrains.com/platform/2023/07/lsp-for-plugin-developers/) for PyCharm Pro/IDEA Ultimate\n    - [x] [LSP4IJ by RedHat](https://github.com/redhat-developer/lsp4ij) (Requires installation of the [LSP4IJ plugin](https://plugins.jetbrains.com/plugin/23257-lsp4ij))\n  - LSP Server\n    - [x] `ruff-lsp` integration\n    - [x] `ruff server` integration\n  - [x] Live Config Reload: Automatically updates from `pyproject.toml` and `ruff.toml` without restarting\n- [x] Support `ruff format` for ruff version `0.0.289` or later [Experimental]\n\n### Support `ruff-lsp` for only PyCharm Pro/IDEA Ultimate\nYou can enable it in `Preferences/Settings` -\u003e `Tools` -\u003e `Ruff` -\u003e `Use ruff-lsp (Experimental) for PyCharm Pro/IDEA Ultimate`\n\nThe lsp integration applies only below features:\n- Errors/warnings highlighting ([textDocument/publishDiagnostics](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics))\n- Quick-fixes for these errors/warnings ([textDocument/codeAction](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction)\n\n_This is experimental feature._\n\n## Screenshots\n\n![inspection](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/inspection.png)\n![quickfix](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/quickfix.png)\n![settings](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/settings.png)\n\n\u003c!-- Plugin description end --\u003e\n\n## Installation\n\n### JetBrains Marketplace\n\nYou can install the stable version on PyCharm's `Marketplace` (_Preferences_ -\u003e _Plugins_ -\u003e _Marketplace_).\n\n![search plugin](https://raw.githubusercontent.com/koxudaxi/ruff-pycharm-plugin/main/docs/search_plugin.png)\n\nSee the section on [managing plugins](https://www.jetbrains.com/help/idea/managing-plugins.html) in the official documentation.\n\n## Contribute\n\nSee [Development](https://koxudaxi.github.io/ruff-pycharm-plugin/development/) section of the documentation.\n\nWe are waiting for your contributions to `ruff-pycharm-plugin`!\n\n\n## Links\n* [JetBrains Plugin Page](https://plugins.jetbrains.com/plugin/20574-ruff)\n* [Pydantic PyCharm Plugin](https://github.com/koxudaxi/pydantic-pycharm-plugin/)\n\n## Sponsors\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd valign=\"top\" align=\"center\"\u003e\n    \u003ca href=\"https://github.com/JetBrainsOfficial\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/u/60931315?s=100\u0026v=4\" alt=\"JetBrains Logo\" style=\"width: 100px;\"\u003e\n      \u003cp\u003eJetBrains\u003c/p\u003e\n    \u003c/a\u003e\n    \u003c/td\u003e\n  \u003ctd valign=\"top\" align=\"center\"\u003e\n    \u003ca href=\"https://github.com/astral-sh\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/u/115962839?s=200\u0026v=4\" alt=\"Astral Logo\" style=\"width: 100px;\"\u003e\n      \u003cp\u003eAstral\u003c/p\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd valign=\"top\" align=\"center\"\u003e\n    \u003ca href=\"https://github.com/DataDog\"\u003e\n      \u003cimg src=\"https://avatars.githubusercontent.com/u/365230?s=200\u0026v=4\" alt=\"Datadog, Inc. Logo\" style=\"width: 100px;\"\u003e\n      \u003cp\u003eDatadog, Inc.\u003c/p\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoxudaxi%2Fruff-pycharm-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoxudaxi%2Fruff-pycharm-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoxudaxi%2Fruff-pycharm-plugin/lists"}