fix(linter): avoid applying object-level docs to nested object methods in require-param by camc314 · Pull Request #19231 · oxc-project/oxc

camc314 · 2026-02-10T17:08:06Z

fixes #19139

camc314 · 2026-02-10T17:08:28Z

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 hot fixes, skip the queue and merge this PR next

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

Fixes jsdoc/require-param false-positives where a JSDoc attached to an object assignment/initializer was incorrectly treated as applying to functions nested inside the object literal (e.g., object methods), addressing #19139.

Changes:

Stop JSDoc lookup when walking up the AST at ObjectExpression to prevent object-level JSDoc from “leaking” into nested object methods.
Add a regression test for a typed object literal (ShikiTransformer) with an undocumented method that should no longer trigger require-param.
Add a test + snapshot coverage for a method that does have its own JSDoc but is missing @param (expected to warn).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
crates/oxc_linter/src/utils/jsdoc.rs	Adjusts nearest-JSDoc resolution to avoid applying object-level docs to nested object-literal functions.
crates/oxc_linter/src/rules/jsdoc/require_param.rs	Adds regression coverage for the reported scenario and a related failing case.
crates/oxc_linter/src/snapshots/jsdoc_require_param.snap	Updates snapshot output to include the new failing diagnostic case.

crates/oxc_linter/src/utils/jsdoc.rs

codspeed-hq · 2026-02-10T17:14:15Z

Merging this PR will not alter performance

✅ 47 untouched benchmarks
⏩ 3 skipped benchmarks¹

_{Comparing c/02-10-fix_jsdoc_avoid_applying_object-level_docs_to_nested_object_methods_in_require-param (2d0fb96) with main (ffe9b2e)}

3 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. ↩

graphite-app · 2026-02-10T17:16:56Z

Merge activity

Feb 10, 5:16 PM UTC: camc314 added this pull request to the Graphite merge queue.
Feb 10, 5:18 PM UTC: The Graphite merge queue couldn't merge this PR because it was in draft mode.
Feb 10, 5:36 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Feb 10, 5:36 PM UTC: camc314 added this pull request to the Graphite merge queue.
Feb 10, 5:43 PM UTC: Merged by the Graphite merge queue.

… in require-param (#19231) fixes #19139

…s in require-param (#19231) fixes #19139

…s in require-param (oxc-project#19231) fixes oxc-project#19139

# Oxlint ### 🚀 Features - ebb80b3 ast: Add `node_id` field to all AST struct nodes (#18138) (Boshen) - 2879fc5 linter: Implement fixer for unicorn/prefer-math-trunc (#19275) (camc314) - a204eda linter: Implement fixer for unicorn/no-typeof-undefined (#19274) (camc314) - ab46d9c linter: Implement typescript/class-literal-property-style (#19252) (Vincent R) - 1a61f58 linter: Implement typescript/no-invalid-void-type (#19242) (Vincent R) ### 🐛 Bug Fixes - 45adda2 oxlint/lsp: Use blocking stdio in Oxlint (#19292) (overlookmotel) - 05bc855 linter/import: Count unique module sources in max-dependencies (#19270) (camc314) - 8566b44 linter: Check for preceeding token in math trunc fixer (#19277) (camc314) - f16f2b6 linter/import-no-cycle: Avoid traversal-order false negatives with type-only edges (#19267) (camc314) - d4937e7 linter: Recognize module-scoped callback refs as stable in exhaustive-deps (#19220) (Sreetam Das) - 140c9bd linter: Detect fallthrough from `default` when it is not the last case (#19261) (Boshen) - 740a009 linter: Accept digits after 'use' in hook names (#19254) (Sreetam Das) - 31b562f linter: Update `import/no-named-as-default` to allow named import if equivalent to the default import (#19100) (connorshea) - 79c82cc linter: Avoid applying object-level docs to nested object methods in require-param (#19231) (camc314) ### ⚡ Performance - 5670291 linter/class-literal-property-style: Avoid unneeded string allocations (#19262) (camc314) # Oxfmt ### 🚀 Features - ebb80b3 ast: Add `node_id` field to all AST struct nodes (#18138) (Boshen) ### 🐛 Bug Fixes - 1957908 formatter: Avoid unnecessary parentheses for string literal in labeled statement (#19272) (Dunqing) Co-authored-by: camc314 <[email protected]>

…s in require-param (oxc-project#19231) fixes oxc-project#19139

# Oxlint ### 🚀 Features - ebb80b3 ast: Add `node_id` field to all AST struct nodes (oxc-project#18138) (Boshen) - 2879fc5 linter: Implement fixer for unicorn/prefer-math-trunc (oxc-project#19275) (camc314) - a204eda linter: Implement fixer for unicorn/no-typeof-undefined (oxc-project#19274) (camc314) - ab46d9c linter: Implement typescript/class-literal-property-style (oxc-project#19252) (Vincent R) - 1a61f58 linter: Implement typescript/no-invalid-void-type (oxc-project#19242) (Vincent R) ### 🐛 Bug Fixes - 45adda2 oxlint/lsp: Use blocking stdio in Oxlint (oxc-project#19292) (overlookmotel) - 05bc855 linter/import: Count unique module sources in max-dependencies (oxc-project#19270) (camc314) - 8566b44 linter: Check for preceeding token in math trunc fixer (oxc-project#19277) (camc314) - f16f2b6 linter/import-no-cycle: Avoid traversal-order false negatives with type-only edges (oxc-project#19267) (camc314) - d4937e7 linter: Recognize module-scoped callback refs as stable in exhaustive-deps (oxc-project#19220) (Sreetam Das) - 140c9bd linter: Detect fallthrough from `default` when it is not the last case (oxc-project#19261) (Boshen) - 740a009 linter: Accept digits after 'use' in hook names (oxc-project#19254) (Sreetam Das) - 31b562f linter: Update `import/no-named-as-default` to allow named import if equivalent to the default import (oxc-project#19100) (connorshea) - 79c82cc linter: Avoid applying object-level docs to nested object methods in require-param (oxc-project#19231) (camc314) ### ⚡ Performance - 5670291 linter/class-literal-property-style: Avoid unneeded string allocations (oxc-project#19262) (camc314) # Oxfmt ### 🚀 Features - ebb80b3 ast: Add `node_id` field to all AST struct nodes (oxc-project#18138) (Boshen) ### 🐛 Bug Fixes - 1957908 formatter: Avoid unnecessary parentheses for string literal in labeled statement (oxc-project#19272) (Dunqing) Co-authored-by: camc314 <[email protected]>

camc314 marked this pull request as ready for review February 10, 2026 17:08

Copilot AI review requested due to automatic review settings February 10, 2026 17:08

github-actions bot added A-linter Area - Linter C-bug Category - Bug labels Feb 10, 2026

camc314 self-assigned this Feb 10, 2026

Copilot started reviewing on behalf of camc314 February 10, 2026 17:08 View session

Copilot AI reviewed Feb 10, 2026

View reviewed changes

crates/oxc_linter/src/utils/jsdoc.rs Show resolved Hide resolved

graphite-app bot pushed a commit that referenced this pull request Feb 10, 2026

fix(jsdoc): avoid applying object-level docs to nested object methods…

b4b9469

… in require-param (#19231) fixes #19139

graphite-app bot force-pushed the c/02-10-fix_jsdoc_avoid_applying_object-level_docs_to_nested_object_methods_in_require-param branch from 9bafa76 to b4b9469 Compare February 10, 2026 17:17

camc314 changed the title ~~fix(jsdoc): avoid applying object-level docs to nested object methods in require-param~~ fix(linter): avoid applying object-level docs to nested object methods in require-param Feb 10, 2026

camc314 marked this pull request as draft February 10, 2026 17:18

camc314 marked this pull request as ready for review February 10, 2026 17:18

camc314 force-pushed the c/02-10-fix_jsdoc_avoid_applying_object-level_docs_to_nested_object_methods_in_require-param branch from b4b9469 to 2d0fb96 Compare February 10, 2026 17:18

camc314 added the 0-merge Merge with Graphite Merge Queue label Feb 10, 2026

fix(linter): avoid applying object-level docs to nested object method…

79c82cc

…s in require-param (#19231) fixes #19139

graphite-app bot force-pushed the c/02-10-fix_jsdoc_avoid_applying_object-level_docs_to_nested_object_methods_in_require-param branch from 2d0fb96 to 79c82cc Compare February 10, 2026 17:36

graphite-app bot merged commit 79c82cc into main Feb 10, 2026
21 checks passed

graphite-app bot deleted the c/02-10-fix_jsdoc_avoid_applying_object-level_docs_to_nested_object_methods_in_require-param branch February 10, 2026 17:43

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Feb 10, 2026

owjs3901 pushed a commit to owjs3901/oxc that referenced this pull request Feb 11, 2026

fix(linter): avoid applying object-level docs to nested object method…

f6b6a4d

…s in require-param (oxc-project#19231) fixes oxc-project#19139

Boshen mentioned this pull request Feb 12, 2026

release(apps): oxlint v1.47.0 && oxfmt v0.32.0 #19315

Merged

OskarLebuda pushed a commit to OskarLebuda/oxc that referenced this pull request Feb 17, 2026

fix(linter): avoid applying object-level docs to nested object method…

4709ed4

…s in require-param (oxc-project#19231) fixes oxc-project#19139

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(linter): avoid applying object-level docs to nested object methods in require-param#19231

fix(linter): avoid applying object-level docs to nested object methods in require-param#19231
graphite-app[bot] merged 1 commit intomainfrom
c/02-10-fix_jsdoc_avoid_applying_object-level_docs_to_nested_object_methods_in_require-param

camc314 commented Feb 10, 2026 •

edited

Loading

Uh oh!

camc314 commented Feb 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

codspeed-hq bot commented Feb 10, 2026 •

edited

Loading

Uh oh!

graphite-app bot commented Feb 10, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

Uh oh!

Conversation

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

Uh oh!

Uh oh!

camc314 commented Feb 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

Reviewed changes

Uh oh!

Uh oh!

codspeed-hq bot commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

graphite-app bot commented Feb 10, 2026 • edited 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!

1 participant

Comments

camc314 commented Feb 10, 2026 •

edited

Loading

codspeed-hq bot commented Feb 10, 2026 •

edited

Loading

graphite-app bot commented Feb 10, 2026 •

edited

Loading