docs(linter/plugins): fix JSDoc comments for tokens methods by overlookmotel · Pull Request #20004 · oxc-project/oxc

overlookmotel · 2026-03-04T14:13:51Z

JSDoc comments for tokens methods were wrong about the return types of these methods. Correct the docs.

overlookmotel · 2026-03-04T14:14:06Z

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

This PR corrects the JSDoc return-type documentation for the SourceCode token-related methods so the docs reflect that these APIs can return comments when includeComments: true is used.

Changes:

Updated @returns docs for token-collection methods to mention possible comment tokens when includeComments is enabled.
Updated @returns docs for single-token methods to mention possible comment tokens and clarified nullability wording.
Updated deprecated getTokenOrCommentBefore/After docs to match their TokenOrComment | null return types.

camc314 · 2026-03-04T21:41:11Z

Merge activity

Mar 4, 9:41 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Mar 4, 9:41 PM UTC: camc314 added this pull request to the Graphite merge queue.
Mar 4, 10:00 PM UTC: Merged by the Graphite merge queue.

JSDoc comments for tokens methods were wrong about the return types of these methods. Correct the docs.

# Oxlint ### 🚀 Features - e6b604f oxlint: Auto-enable gitlab formatter on GitLab (#20076) (camc314) - 2488a68 linter: Add .oxlintrc.jsonc config file support (#19870) (Scott S.) - 61bf388 linter: Add `options.reportUnusedDisableDirectives` to config file (#19799) (Peter Wagenet) - c92422b oxlint: Auto-enable github formatter on GitHub Actions (#19944) (Boshen) - 0337c6d linter: Implement typescript/no-unecessary-type-conversion (#19955) (camc314) - 2919313 linter: Introduce denyWarnings config options (#19926) (camc314) - a607119 linter: Introduce maxWarnings config option (#19777) (camc314) ### 🐛 Bug Fixes - 0861d9a linter/plugins: Remove getters from `Context` (#20115) (overlookmotel) - 92cfb14 linter/plugins: Fix types for `walkProgram` and `walkProgramWithCfg` (#20081) (overlookmotel) - 10e211f oxlint/lsp: Send other code actions besides `source.fixAll` if requested (#20042) (Sysix) - 602daaa linter/plugins: Fix type definition for `VisitorObject` (#20065) (overlookmotel) - ee0491e apps,napi: Explicitly specify libs in tsconfigs (#20071) (camc314) - b6e9499 linter: Fix the logic for `unicorn/prefer-dom-node-remove` to handle literal callees as well as arguments. (#20059) (connorshea) - 3874ae1 linter: Update `unicorn/prefer-query-selector` to also catch `getElementsByName()`. (#20060) (connorshea) - 77c93fb linter: Handle array-type shorthand inside union members (#20034) (camc314) - 50eb160 linter/no-unused-vars: Allow unused type params in ambient module blocks (#19615) (Don Isaac) - 1dd0d21 linter/no-restricted-imports: Apply regex pattern checks to side-effect imports (#20028) (camc314) - 7f3d735 linter: Error when --type-check is used without --type-aware (#20025) (camc314) - eea201c unicorn/prefer-string-slice: Avoid unsafe autofix for substr-to-slice (#20010) (camc314) - 50359dc oxlint/lsp: Detect `reportUnusedDisableDirectives` from oxlint config, change lsp `unusedDisableDirectives` default value to `None` (#20011) (Sysix) - 4bc84b1 linter/plugins: Allow `null` and `undefined` for `rule.meta.fixable` (#20008) (overlookmotel) - 753e27e linter/role-supports-aria-props: Add `aria-posinset` to supported `option` ARIA properties (#20003) (JongKyung Lee) - f57b2c9 linter/plugins: Fix return types of tokens methods (#19985) (overlookmotel) - 27ee4fc linter/no-loss-of-precision: Avoid double rounding for negative exponents (#19999) (camc314) - 77a94bb linter: Avoid no-loss-of-precision false positive for 3e-308 (#19992) (camc314) - 6245c56 linter/no-unused-private-class-members: Treat logical lhs access as usage (#19991) (camc314) - 65891e3 linter: Avoid prefer-const false positive for mixed-scope destructuring (#19982) (camc314) - 89991fe linter: Avoid prefer-const false positive for operator reassignments (#19975) (camc314) - 87318e7 oxlint/lsp: Load js config with reforcing fs read (#19551) (Sysix) - d40a942 linter/no-useless-constructor: Mark fixer as suggestion (#19961) (camc314) - ccbd959 linter/prefer-code-point: Report String.fromCharCode member references (#19931) (camc314) - 14fbbfc linter: Add help text to oxc/no-rest-spread-properties rule (#19900) (Subin Kim) ### ⚡ Performance - 2baa5fb napi: Unify build-test profile to coverage for cache sharing (#20090) (Boshen) - 77f1c71 linter/plugins: Make tokens class instances (#19980) (overlookmotel) - 758b424 linter/plugins: Reduce memory copies for tokens (#19979) (overlookmotel) - 236847f linter/plugins: Cache token objects (#19978) (overlookmotel) - 94b597a linter/plugins: Store tokens as a `Box<[Token]>` (#19969) (overlookmotel) ### 📚 Documentation - 2c0010a linter/plugins: Move comment about "bivariance hack" into generated code (#20082) (overlookmotel) - 7538f09 linter: Improve `import/extensions` and `import/no-named-as-default` rule docs. (#20053) (connorshea) - 1f909cf linter: Improve docs for `unicorn/require-post-message-target-origin` rule. (#20061) (connorshea) - 12ae35c oxlint/lsp: Remove outdated ToDo for `LintOptions.run` (#20012) (Sysix) - 3be73e6 linter/plugins: Fix JSDoc comments for tokens methods (#20004) (overlookmotel) - 48ef285 linter: Update `--config` docs (#19965) (camc314) - 6ea49a0 linter: Fix some identation issues for the generated types used in `oxlint.config.ts`. (#19942) (connorshea) - 6c0e0b5 linter: Add oxlint.config.ts to the config docs. (#19941) (connorshea) - 160e423 linter: Add a note that the typeAware and typeCheck options require oxlint-tsgolint (#19940) (connorshea) - d54c275 linter: Improve rule docs for 27 unicorn rules (#19903) (connorshea) # Oxfmt ### 🚀 Features - ee26215 oxfmt: Support css-in-js substitution (#20019) (leaysgur) - 0f0ff51 oxfmt: Display default settings was used message in cli stats (#19939) (leaysgur) - 88815b8 oxfmt: Reintroduce stats line for write mode (#19938) (leaysgur) ### 🐛 Bug Fixes - ee0491e apps,napi: Explicitly specify libs in tsconfigs (#20071) (camc314) - 92f4490 oxfmt: Apply `is_ignored_dir` for glob paths too (#20056) (leaysgur) - 114f974 oxfmt/lsp: Prefer language_id over file extension when formatting (#19977) (copilot-swe-agent) ### ⚡ Performance - 2baa5fb napi: Unify build-test profile to coverage for cache sharing (#20090) (Boshen) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>

overlookmotel mentioned this pull request Mar 4, 2026

fix(linter/plugins): fix return types of tokens methods #19985

Merged

github-actions bot added A-linter Area - Linter A-cli Area - CLI A-linter-plugins Area - Linter JS plugins C-docs Category - Documentation. Related to user-facing or internal documentation labels Mar 4, 2026

overlookmotel marked this pull request as ready for review March 4, 2026 14:14

overlookmotel requested a review from camc314 as a code owner March 4, 2026 14:14

Copilot AI review requested due to automatic review settings March 4, 2026 14:14

overlookmotel assigned camc314 Mar 4, 2026

Copilot started reviewing on behalf of overlookmotel March 4, 2026 14:15 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

camc314 approved these changes Mar 4, 2026

View reviewed changes

camc314 added the 0-merge Merge with Graphite Merge Queue label Mar 4, 2026

graphite-app bot changed the base branch from om/03-03-fix_linter_plugins_fix_return_types_of_tokens_methods to graphite-base/20004 March 4, 2026 21:41

graphite-app bot changed the base branch from graphite-base/20004 to main March 4, 2026 21:48

graphite-app bot pushed a commit that referenced this pull request Mar 4, 2026

docs(linter/plugins): fix JSDoc comments for tokens methods (#20004)

4bb4a20

JSDoc comments for tokens methods were wrong about the return types of these methods. Correct the docs.

graphite-app bot force-pushed the om/03-04-docs_linter_plugins_fix_jsdoc_comments_for_tokens_methods branch from 3d6de83 to 4bb4a20 Compare March 4, 2026 21:49

docs(linter/plugins): fix JSDoc comments for tokens methods (#20004)

3be73e6

JSDoc comments for tokens methods were wrong about the return types of these methods. Correct the docs.

graphite-app bot force-pushed the om/03-04-docs_linter_plugins_fix_jsdoc_comments_for_tokens_methods branch from 4bb4a20 to 3be73e6 Compare March 4, 2026 21:52

graphite-app bot merged commit 3be73e6 into main Mar 4, 2026
19 checks passed

graphite-app bot deleted the om/03-04-docs_linter_plugins_fix_jsdoc_comments_for_tokens_methods branch March 4, 2026 22:00

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Mar 4, 2026

Boshen mentioned this pull request Mar 9, 2026

release(apps): oxlint v1.52.0 && oxfmt v0.37.0 #20143

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(linter/plugins): fix JSDoc comments for tokens methods#20004

docs(linter/plugins): fix JSDoc comments for tokens methods#20004
graphite-app[bot] merged 1 commit intomainfrom
om/03-04-docs_linter_plugins_fix_jsdoc_comments_for_tokens_methods

overlookmotel commented Mar 4, 2026 •

edited

Loading

Uh oh!

overlookmotel commented Mar 4, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

camc314 commented Mar 4, 2026 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

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!

camc314 commented Mar 4, 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 Mar 4, 2026 •

edited

Loading

overlookmotel commented Mar 4, 2026 •

edited

Loading

camc314 commented Mar 4, 2026 •

edited by graphite-app bot

Loading