Skip formatting code blocks wrapped in HTML skip comments#22962
Closed
amyreese wants to merge 5 commits intoamy/ruffen-docs-extensionfrom
Closed
Skip formatting code blocks wrapped in HTML skip comments#22962amyreese wants to merge 5 commits intoamy/ruffen-docs-extensionfrom
amyreese wants to merge 5 commits intoamy/ruffen-docs-extensionfrom
Conversation
Typing conformance resultsNo changes detected ✅ |
|
|
amyreese
added
formatter
ntBre
reviewed
Jan 30, 2026
Contributor
ntBre
left a comment
ntBre
left a comment
There was a problem hiding this comment.
This makes sense to me functionally, but I'm really starting to wonder if we should take a different parsing approach. I believe this now means we're iterating over the whole source code twice, first to find suppression comments, and then a second time to extract code blocks for formatting. Combined with the perf hit we saw in the fancy-regex branch, I'm sort of inclined at least to experiment with a different approach. What do you think?
I guess I'm sort of hopeful that we can reuse some of the logic from the docstring formatting even if we have to copy-paste it instead of factoring out and sharing it directly.
| ``` | ||
| "#); | ||
| } | ||
| #[test] |
Contributor
There was a problem hiding this comment.
tiny nit:
Suggested change
| #[test] | |
| #[test] |
Member
Author
There was a problem hiding this comment.
sigh, why doesn't rustfmt take care of that for me 😅
Member
Author
|
I had started toying with that (as maybe evidenced by the branch name 🙈) but wanted to get the simple version first to prompt discussion around the comment form, etc. I'll try to put together a line-by-line variant. |
amyreese
added a commit
that referenced
this pull request
Jan 31, 2026
amyreese
force-pushed
the
amy/ruffen-docs-extension
branch
from
3eebdf9 to
cefa871
Compare
amyreese
added a commit
that referenced
this pull request
Feb 3, 2026
Format markdown with line-by-line regex parse - Uses basic `regex` crate, so no backtracking or backreferences needed - Supports `~~~` and arbitrary length code fences - Supports `<!-- fmt:off -->` to skip formatting code blocks - Includes test cases from previous PRs, as well as new ones Obviates #22962 and #22937
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
2 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.
Skips formatting markdown code blocks wrapped in HTML comments like:
<!-- blacken-docs:off -->or
<!-- ruff:off -->