refactor(formatter): clarify jsdoc embedded formatting#23807
Merged
graphite-app[bot] merged 1 commit intoJun 29, 2026
Merged
Conversation
This was referenced Jun 26, 2026
This was referenced Jun 26, 2026
Member
Author
This was referenced Jun 26, 2026
Merging this PR will improve performance by 4.55%
|
| Mode | Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|---|
| ⚡ | Simulation | formatter[errors.ts] |
616.6 µs | 574.1 µs | +7.4% |
| ⚡ | Simulation | isolated-declarations[vue-id.ts] |
52.8 ms | 49.7 ms | +6.28% |
| ⚡ | Simulation | formatter[handle-comments.js] |
2.9 ms | 2.8 ms | +4.09% |
| ⚡ | Simulation | formatter[index.tsx] |
3.9 ms | 3.8 ms | +3.59% |
| ⚡ | Simulation | formatter[next.ts] |
2.4 ms | 2.3 ms | +3.02% |
| ⚡ | Simulation | formatter[core.js] |
1.6 ms | 1.6 ms | +3.02% |
Tip
Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.
Comparing 06-26-refactor_formatter_clarify_jsdoc_embedded_formatting (e2b6b3b) with 06-26-refactor_oxfmt_formatter_move_gql-in-js_escape_logic_to_formatter_js (10c88b1)2
Footnotes
-
19 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
-
No successful run was found on
06-26-refactor_oxfmt_formatter_move_gql-in-js_escape_logic_to_formatter_js(edbb9ee) during the generation of this report, so 0cf3f5d was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
This was referenced Jun 26, 2026
60bf9fe to
d3f3837
Compare
10c88b1 to
dea8a75
Compare
This was referenced Jun 29, 2026
bf01e94 to
1c3294d
Compare
fa23271 to
859924f
Compare
Contributor
Merge activity
|
1c3294d to
edbb9ee
Compare
859924f to
e2b6b3b
Compare
480b500 to
f90838c
Compare
e2b6b3b to
86adbd1
Compare
It might not be widely known, but you can embed multiple languages within JSDoc(Markdown code fence, `@example` tag), and those will be formatted as well. However, because it works a bit differently from other embedded formattings and can be confusing, I will clarify how it works here.
f90838c to
4e2a194
Compare
86adbd1 to
96b48a3
Compare
Base automatically changed from
06-26-refactor_oxfmt_formatter_move_gql-in-js_escape_logic_to_formatter_js
to
main
June 29, 2026 04:11
camc314
pushed a commit
that referenced
this pull request
Jul 3, 2026
It might not be widely known, but you can embed multiple languages within JSDoc(Markdown code fence, `@example` tag), and those will be formatted as well. However, because it works a bit differently from other embedded formattings and can be confusing, I will clarify how it works here.
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
1 participant
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.
It might not be widely known, but you can embed multiple languages within JSDoc(Markdown code fence,
@exampletag), and those will be formatted as well.However, because it works a bit differently from other embedded formattings and can be confusing, I will clarify how it works here.