Skip to content

feat(linter/plugins): implement deprecated SourceCode#getJSDocComment method #15653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graphite-app merged 1 commit into from
Nov 12, 2025
Merged

feat(linter/plugins): implement deprecated SourceCode#getJSDocComment method #15653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions apps/oxlint/src-js/plugins/comments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,17 @@ export function commentsExistBetween(nodeOrToken1: NodeOrToken, nodeOrToken2: No
comments[firstCommentBetween].end <= nodeOrToken2.range[0]
);
}

/**
* Retrieve the JSDoc comment for a given node.
*
* @deprecated
*
* @param node - The AST node to get the comment for.
* @returns The JSDoc comment for the given node, or `null` if not found.
*/
/* oxlint-disable no-unused-vars */
export function getJSDocComment(node: Node): Comment | null {
throw new Error('`sourceCode.getJSDocComment` is not supported at present (and deprecated)'); // TODO
}
/* oxlint-enable no-unused-vars */
1 change: 1 addition & 0 deletions apps/oxlint/src-js/plugins/source_code.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ export const SOURCE_CODE = Object.freeze({
getCommentsAfter: commentMethods.getCommentsAfter,
getCommentsInside: commentMethods.getCommentsInside,
commentsExistBetween: commentMethods.commentsExistBetween,
getJSDocComment: commentMethods.getJSDocComment,

// Scope methods
isGlobalReference: scopeMethods.isGlobalReference,
Expand Down
Loading