Conversation
- Use `SourceType` in formatting related functions - Defer to `ruff_markdown` when formatting `SourceType::Markdown` - A bunch of `todos` around how to handle errors/etc Tested against a local build of `ruff-vscode` extension modified to declare support for markdown files, pointed at a local build of `ruff` Issue #22640
amyreese
added
formatter
Typing conformance resultsNo changes detected ✅ |
|
|
Contributor
|
This looks like a good start to me! It would be a good idea to get Dhruv's review once the todos are resolved too. |
amyreese
force-pushed
the
amy/lsp-markdown-formatting
branch
from
4764eb2 to
abe3115
Compare
Member
Author
|
Todos resolved by adding warnings and return |
amyreese
changed the title
ntBre
approved these changes
Feb 5, 2026
Contributor
ntBre
left a comment
ntBre
left a comment
There was a problem hiding this comment.
Makes sense to me, just two nits! It might be cool to have a screenshot or brief recording in the PR summary in lieu of a normal test plan.
amyreese
force-pushed
the
amy/lsp-markdown-formatting
branch
from
abe3115 to
96a237e
Compare
Member
Author
|
Addressed feedback, added quick screen recording to summary |
ntBre
reviewed
Feb 5, 2026
dhruvmanila
reviewed
Feb 9, 2026
Member
There was a problem hiding this comment.
This looks good.
Is the intention to skip Jupyter Notebooks for the initial version as currently it won't work? To make it work, you'd need to add "markdown" cell syncing in
ruff/crates/ruff_server/src/server.rs
Lines 195 to 204 in cdbe553
Edit: It isn't supported from the CLI either so I'm assuming that it's planned as a follow-up instead.
Comment on lines
+76
to
+80
| } else if let Some(LanguageId::Markdown) = language_id | ||
| && formatter_settings.is_some() | ||
| { | ||
| tracing::debug!("Included path via Markdown language ID: {}", path.display()); | ||
| false |
Member
There was a problem hiding this comment.
Can you say why there's an additional check for whether formatter_settings.is_some() or not? Or is it because to check whether preview mode is enabled or not?
Member
Author
There was a problem hiding this comment.
This was primarily to include Markdown files when formatting, but exclude them when linting (where the linter settings would be provided and formatter settings would be None).
dhruvmanila
approved these changes
Feb 9, 2026
Member
Author
|
Since we aren't formatting the Markdown style itself (only Python code blocks embedded in Markdown documents) formatting within notebook cells is not on the roadmap. I think it would be interesting to see if there are ecosystem cases where notebooks actually contain Markdown cells with embedded Python code blocks, and if they expect that ruff would format those embedded code blocks. |
carljm
added a commit
to Hugo-Polloli/ruff
that referenced
this pull request
Feb 9, 2026
* main: (45 commits) [ty] Fix wrong inlay hints for overloaded function arguments (astral-sh#23179) [ty] Respect `@no_type_check` when combined with other decorators (astral-sh#23177) [ty] Use type context when inferring constructor argument types (astral-sh#23139) [`airflow`] Add ruff rules to catch deprecated attribute access from context key for Airflow 3.0 (`AIR301`) (astral-sh#22850) Support formatting `pycon` markdown code blocks (astral-sh#23112) Markdown formatting in LSP (astral-sh#23063) Instruct Claude to use comments more sparingly (astral-sh#23181) [`flake8-gettext`] Fix false negatives for plural argument of ngettext (`INT001`, `INT002`, `INT003`) (astral-sh#21078) [ty] Invoking goto-def on parentheses of a class constructor call takes you too constructor method [ty] Make goto definition on class constructor always go to class definition [ty] Assign lower completions ranking to deprecated functions and classes (astral-sh#23089) [ty] Fix parameter references across files via keyword args (astral-sh#23012) [ty] Exclude enclosing class for base completions (astral-sh#23141) [`pyupgrade`] Fix syntax error on string with newline escape and comment (`UP037`) (astral-sh#22968) [ty] Improve documentation for `expect_single_definition` method (astral-sh#23175) [ty] Configure check mode for all projects Add `home-assistant` to ecosystem projects (astral-sh#23132) Add tabbed shell completion documentation (astral-sh#23169) Bump typing conformance-suite pin (astral-sh#23174) [ty] Fix invalid diagnostic location for a sub-call to a specialized ParamSpec (astral-sh#23036) ...
Member
Yeah, that seems reasonable. I do realize that now as there wouldn't be too many examples of notebooks with markdown cells containing Python code in it 😅 |
amyreese
added a commit
to astral-sh/ruff-vscode
that referenced
this pull request
Feb 10, 2026
Changes necessary to support markdown formatting in ruff's LSP in vscode: astral-sh/ruff#23063
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SourceTypein formatting related functionsruff_markdownwhen formattingSourceType::Markdowntodosaround how to handle errors/etcTested against a local build of
ruff-vscodeextension modified todeclare support for markdown files, pointed at a local build of
ruffDemo:
2026-02-05.13-48-10.mov
Issue #22640