docs(formatter): add TODO comment about unsound code by overlookmotel · Pull Request #24372 · oxc-project/oxc

overlookmotel · 2026-07-10T21:37:59Z

Add a TODO comment about some unsound code in formatter.

I'm not sure how we'd fix this, so just adding a comment for now.

overlookmotel · 2026-07-10T21:38:19Z

docs(formatter): add TODO comment about unsound code #24372 👈 (View in Graphite)
main

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

0-merge - adds this PR to the back of the merge queue
hotfix - for urgent changes, fast-track this PR to the front of the merge queue

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copilot

Pull request overview

This PR updates the formatter’s AST node helper documentation to flag a known-unsound unsafe conversion in ImportExpression::to_arguments, clarifying that the current approach duplicates an arena Box via transmute_copy.

Changes:

Adds a TODO comment calling out that transmute_copy-based Expression → Argument conversion is unsound due to duplicating ArenaBox/oxc_allocator::Box.
Minor comment formatting change (backticks around transmute_copy).

codspeed-hq · 2026-07-10T21:41:57Z

Merging this PR will not alter performance

✅ 52 untouched benchmarks
⏩ 19 skipped benchmarks¹

_{Comparing om/06-30-docs_formatter_add_todo_comment_about_unsound_code (9619e05) with main (ddab89a)²}

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 main (8da0402) during the generation of this report, so ddab89a was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

Dunqing · 2026-07-13T01:48:31Z

I don't know how to fix it 🥲

Dunqing · 2026-07-13T01:48:39Z

Merge activity

Jul 13, 1:48 AM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Jul 13, 1:48 AM UTC: Dunqing added this pull request to the Graphite merge queue.
Jul 13, 1:53 AM UTC: Merged by the Graphite merge queue.

Add a TODO comment about some unsound code in formatter. I'm not sure how we'd fix this, so just adding a comment for now.

# Oxlint ### 🚀 Features - 0433a83 linter/eslint/no-inner-declarations: Add `namespaces` option (#24044) (Boshen) - 92f154a oxlint,oxfmt: Auto-discover `.mts` config files (#24357) (camc314) - 8c1d74b linter/import/no-duplicates: Add autofix logic (#24273) (Cole Ellison) ### 🐛 Bug Fixes - 0b086de linter/jest/prefer-lowercase-title: False positive when `lowercaseFirstCharacterOnly` is false (#24414) (Connor Shea) - 097cb95 linter: Allow `vite-plus/test` and `@effect as Vitest source (#24196) (Liang) - 8337835 linter: Error on `ignorePatterns` that cannot match files aoutside the config directory (#24341) (leaysgur) - 9ba30e5 linter/oxc/bad-replace-all-arg: Add note to enhance diagnostic (#24346) (camc314) - 2ce5a33 linter: Resolve `ignorePatterns` relative to the config dir (#24339) (leaysgur) - ab90eed linter/eslint/no-loop-func: Do not error on catch variables (#24316) (Chris Opperwall) - b67f0a6 linter/eslint/no-unused-vars: Count default parameter updates as usage (#24323) (camc314) - d193f8e linter: Detect Junie agent env vars (#24277) (Jeevan Mohan Pawar) - 2aecf60 linter/eslint/no-unreachable: Handle `break` in switch stmts correctly (#24260) (camc314) ### ⚡ Performance - 7f80cac linter/vue/prop-name-casing: Precompile `ignoreProps` regex pattern (#24413) (connorshea) - 6272051 linter/typescript/no-require-imports: Compile allow patterns once (#24417) (connorshea) - fb1edf1 linter: Compute comment fix span only for directive comments (#24419) (connorshea) - 33805b9 linter/jsdoc/require-param: Compile checkTypesPattern regex once (#24420) (connorshea) - 8de6fca linter/jest/valid-title: Compile disallowedWords regex once (#24412) (Connor Shea) - 4a0d8dc linter/eslint/no-underscore-dangle: Avoid String clone per identifier (#24371) (Ian Macalinao) - f3ab04c linter/typescript/consistent-type-imports: Remove redundant Vec per violation (#24370) (Ian Macalinao) - 4d2d78d linter/typescript/prefer-ts-expect-error: Avoid String clone per comment (#24369) (Ian Macalinao) # Oxfmt ### 🚀 Features - 3a7fe74 formatter_css: Update oxc-css-parser to 0.0.7 (#24434) (leaysgur) - 0173cd3 formatter_css: Format Less :extend and merge props (#24358) (leaysgur) - 92f154a oxlint,oxfmt: Auto-discover `.mts` config files (#24357) (camc314) - df250df formatter: Support `quoteProps` for TS enum and methods (#24309) (leaysgur) - a9a5cd6 formatter_core: Expose `SourceText::as_str()` (#24281) (leaysgur) ### 🐛 Bug Fixes - 162bddf formatter: Add required parens for conditional type in type parameter constraint (#24450) (leaysgur) - 2d22a91 formatter: Determine type cast target from span instead of lexical scan (#24447) (leaysgur) - 25306e9 formatter: Do not add extra parens with type cast comment (#24444) (leaysgur) - bd6edfe formatter: Break arrow signature that exactly fills the line when cond body may hug (#24440) (leaysgur) - a99ef41 formatter: Keep quotes on method signature named new (#24432) (leaysgur) - fcc28df formatter_css: Keep glued-braket-value tight (#24352) (leaysgur) - 8337835 linter: Error on `ignorePatterns` that cannot match files aoutside the config directory (#24341) (leaysgur) - b7c7e15 formatter: Add parens for import and private field in new callee chain (#24320) (leaysgur) - 0c8f6e4 formatter: Update detect_code_removal for #24309 (#24314) (leaysgur) - a85aad0 formatter: Fix member-chain and non-null parens (#24312) (leaysgur) - 1c29c73 formatter: Preserve `TSNonNullExpression` in chain expression (#24311) (leaysgur) - 8933c0e formatter: Keep comment inside of empty `switch` block (#24308) (leaysgur) - ec26af2 formatter: Preserve blank lines between JSX attrs (#24290) (leaysgur) - 70bd54d formatter: Keep arrow function body comment (#24287) (leaysgur) - 415fe1e oxfmt: Error on ignorePatterns that cannot match files outside the config directory (#24286) (leaysgur) - eeabc4a formatter_css: Bail on EOF-recovered parse errors (#24282) (leaysgur) - 42ec8de formatter: Keep comments inside surviving parens and suppressed statement terminators (#24253) (leaysgur) - 1343779 formatter: Keep comment inline for empty statements (#24249) (leaysgur) - b996579 formatter: Print ; before trailing comments part 2 (#24246) (leaysgur) - 4f86e8c formatter: Print `;` before trailing comments (#24244) (leaysgur) - 01252e4 formatter: Add or remove parens for `let` declaration (#24215) (leaysgur) ### ⚡ Performance - eeb1913 formatter_core: Avoid per-call `Vec` work-stack in soft-line removal (#23775) (Marius Schulz) - a2f255b formatter: Use `SmallVec` for `MemberChain` collections (#23776) (Marius Schulz) ### 📚 Documentation - b52d0f5 formatter: Add TODO comment about unsound code (#24372) (overlookmotel) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>

github-actions Bot added the A-formatter Area - Formatter label Jul 10, 2026

overlookmotel marked this pull request as ready for review July 10, 2026 21:38

overlookmotel requested a review from leaysgur as a code owner July 10, 2026 21:38

Copilot AI review requested due to automatic review settings July 10, 2026 21:38

Copilot started reviewing on behalf of overlookmotel July 10, 2026 21:39 View session

Copilot AI reviewed Jul 10, 2026

View reviewed changes

Comment thread crates/oxc_formatter/src/ast_nodes/node.rs

overlookmotel requested a review from Dunqing July 11, 2026 12:02

overlookmotel assigned Dunqing Jul 12, 2026

Dunqing approved these changes Jul 13, 2026

View reviewed changes

Dunqing added the 0-merge Merge with Graphite Merge Queue label Jul 13, 2026

docs(formatter): add TODO comment about unsound code (#24372)

b52d0f5

Add a TODO comment about some unsound code in formatter. I'm not sure how we'd fix this, so just adding a comment for now.

graphite-app Bot force-pushed the om/06-30-docs_formatter_add_todo_comment_about_unsound_code branch from 9619e05 to b52d0f5 Compare July 13, 2026 01:49

graphite-app Bot merged commit b52d0f5 into main Jul 13, 2026
29 checks passed

graphite-app Bot removed the 0-merge Merge with Graphite Merge Queue label Jul 13, 2026

graphite-app Bot deleted the om/06-30-docs_formatter_add_todo_comment_about_unsound_code branch July 13, 2026 01:53

oxc-guard Bot mentioned this pull request Jul 13, 2026

release(apps): oxlint v1.74.0 && oxfmt v0.59.0 #24454

Merged

overlookmotel mentioned this pull request Jul 14, 2026

Fix unsound code in formatter oxc-project/backlog#208

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(formatter): add TODO comment about unsound code#24372

docs(formatter): add TODO comment about unsound code#24372
graphite-app[bot] merged 1 commit into
mainfrom
om/06-30-docs_formatter_add_todo_comment_about_unsound_code

overlookmotel commented Jul 10, 2026 •

edited

Loading

Uh oh!

overlookmotel commented Jul 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

codspeed-hq Bot commented Jul 10, 2026

Uh oh!

Dunqing commented Jul 13, 2026

Uh oh!

Dunqing commented Jul 13, 2026 •

edited by graphite-app Bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

overlookmotel commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

overlookmotel commented Jul 10, 2026

How to use the Graphite Merge Queue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

codspeed-hq Bot commented Jul 10, 2026

Merging this PR will not alter performance

Footnotes

Uh oh!

Dunqing commented Jul 13, 2026

Uh oh!

Dunqing commented Jul 13, 2026 • edited by graphite-app Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

overlookmotel commented Jul 10, 2026 •

edited

Loading

Dunqing commented Jul 13, 2026 •

edited by graphite-app Bot

Loading