astral-sh / astral-sh/ruff-vscode

Show rule explanation popup on hover in `pyproject.toml`

Open
#239 6 comments 10 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
1.7k
Forks
80
Avg merge
8h 22m
Merged PRs (30d)
22

Description

I noticed that when I hover my cursor over a `# noqa: ABC123` comment in a `.py` file, it shows a popup explaining what the `ABC123` rule is.

My suggestion is to have this popup also on the `pyproject.toml` file, when you hover over rules in the `tool.ruff.[select|ignore|unfixable]` sections, for example.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the existing hover handling for `# noqa: ABC123` comments in Python files, then inspect how language features are registered for `pyproject.toml`. The change is complete when hovering rules in the `tool.ruff.select`, `ignore`, and `unfixable` sections displays the corresponding rule explanation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.