Skip to content

docs(linter/plugins): clarify JSDoc comments for tokens methods #16062

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 24, 2025
Merged

docs(linter/plugins): clarify JSDoc comments for tokens methods #16062

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
49 changes: 34 additions & 15 deletions apps/oxlint/src-js/plugins/tokens.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ export function resetTokens() {
/**
* Get all tokens that are related to the given node.
* @param node - The AST node.
* @param countOptions? - Options object. If this is a function then it's `countOptions.filter`.
* @param countOptions? - Options object. If is a function, equivalent to `{ filter: fn }`.
* @returns Array of `Token`s.
*/
/**
Expand Down Expand Up @@ -293,8 +293,9 @@ export function getTokens(
/**
* Get the first token of the given node.
* @param node - The AST node.
* @param skipOptions? - Options object. If this is a number then it's `options.skip`.
* If this is a function then it's `options.filter`.
* @param skipOptions? - Options object.
* If is a number, equivalent to `{ skip: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns `Token`, or `null` if all were skipped.
*/
export function getFirstToken(node: Node, skipOptions?: SkipOptions | number | FilterFn | null): Token | null {
Expand Down Expand Up @@ -399,8 +400,9 @@ export function getFirstToken(node: Node, skipOptions?: SkipOptions | number | F
/**
* Get the first tokens of the given node.
* @param node - The AST node.
* @param countOptions? - Options object. If this is a number then it's `options.count`.
* If this is a function then it's `options.filter`.
* @param countOptions? - Options object.
* If is a number, equivalent to `{ count: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns Array of `Token`s.
*/
export function getFirstTokens(node: Node, countOptions?: CountOptions | number | FilterFn | null): Token[] {
Expand Down Expand Up @@ -500,7 +502,9 @@ export function getFirstTokens(node: Node, countOptions?: CountOptions | number
/**
* Get the last token of the given node.
* @param node - The AST node.
* @param skipOptions? - Options object. Same options as `getFirstToken()`.
* @param skipOptions? - Options object.
* If is a number, equivalent to `{ skip: n }`.
Copy link

Copilot AI Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar error: "If is a number" should be "If it is a number".

Suggested change
* If is a number, equivalent to `{ skip: n }`.
* If it is a number, equivalent to `{ skip: n }`.

Copilot uses AI. Check for mistakes.
* If is a function, equivalent to `{ filter: fn }`.
* @returns `Token`, or `null` if all were skipped.
*/
export function getLastToken(node: Node, skipOptions?: SkipOptions | number | FilterFn | null): Token | null {
Expand Down Expand Up @@ -596,7 +600,9 @@ export function getLastToken(node: Node, skipOptions?: SkipOptions | number | Fi
/**
* Get the last tokens of the given node.
* @param node - The AST node.
* @param countOptions? - Options object. Same options as `getFirstTokens()`.
* @param countOptions? - Options object.
* If is a number, equivalent to `{ count: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns Array of `Token`s.
*/
export function getLastTokens(node: Node, countOptions?: CountOptions | number | FilterFn | null): Token[] {
Expand Down Expand Up @@ -701,7 +707,9 @@ export function getLastTokens(node: Node, countOptions?: CountOptions | number |
/**
* Get the token that precedes a given node or token.
* @param nodeOrToken - The AST node or token.
* @param skipOptions? - Options object. Same options as `getFirstToken()`.
* @param skipOptions? - Options object.
* If is a number, equivalent to `{ skip: n }`.
Copy link

Copilot AI Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar error: "If is a number" should be "If it is a number".

Suggested change
* If is a number, equivalent to `{ skip: n }`.
* If it is a number, equivalent to `{ skip: n }`.

Copilot uses AI. Check for mistakes.
* If is a function, equivalent to `{ filter: fn }`.
Copy link

Copilot AI Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar error: "If is a function" should be "If it is a function".

Copilot uses AI. Check for mistakes.
* @returns `Token`, or `null` if all were skipped.
*/
export function getTokenBefore(
Expand Down Expand Up @@ -812,7 +820,9 @@ export function getTokenOrCommentBefore(nodeOrToken: NodeOrToken | Comment, skip
/**
* Get the tokens that precede a given node or token.
* @param nodeOrToken - The AST node or token.
* @param countOptions? - Options object. Same options as `getFirstTokens()`.
* @param countOptions? - Options object.
* If is a number, equivalent to `{ count: n }`.
Copy link

Copilot AI Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar error: "If is a number" should be "If it is a number".

Suggested change
* If is a number, equivalent to `{ count: n }`.
* If it is a number, equivalent to `{ count: n }`.

Copilot uses AI. Check for mistakes.
* If is a function, equivalent to `{ filter: fn }`.
* @returns Array of `Token`s.
*/
export function getTokensBefore(
Expand Down Expand Up @@ -907,7 +917,8 @@ export function getTokensBefore(
/**
* Get the token that follows a given node or token.
* @param nodeOrToken - The AST node or token.
* @param skipOptions? - Options object. Same options as `getFirstToken()`.
* If is a number, equivalent to `{ skip: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns `Token`, or `null` if all were skipped.
*/
export function getTokenAfter(
Expand Down Expand Up @@ -1015,7 +1026,9 @@ export function getTokenOrCommentAfter(nodeOrToken: NodeOrToken | Comment, skip?
/**
* Get the tokens that follow a given node or token.
* @param nodeOrToken - The AST node or token.
* @param countOptions? - Options object. Same options as `getFirstTokens()`.
* @param countOptions? - Options object.
* If is a number, equivalent to `{ count: n }`.
* If is a function, equivalent to `{ filter: fn }`.
Copy link

Copilot AI Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar error: "If is a function" should be "If it is a function".

Suggested change
* If is a function, equivalent to `{ filter: fn }`.
* If it is a function, equivalent to `{ filter: fn }`.

Copilot uses AI. Check for mistakes.
* @returns Array of `Token`s.
*/
export function getTokensAfter(
Expand Down Expand Up @@ -1129,7 +1142,8 @@ export function getTokensBetween(
* Get the first token between two non-overlapping nodes.
* @param nodeOrToken1 - Node before the desired token range.
* @param nodeOrToken2 - Node after the desired token range.
* @param skipOptions? - Options object. Same options as `getFirstToken()`.
* If is a number, equivalent to `{ skip: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns `Token`, or `null` if all were skipped.
*/
/* oxlint-disable no-unused-vars */
Expand All @@ -1146,7 +1160,9 @@ export function getFirstTokenBetween(
* Get the first tokens between two non-overlapping nodes.
* @param nodeOrToken1 - Node before the desired token range.
* @param nodeOrToken2 - Node after the desired token range.
* @param countOptions? - Options object. Same options as `getFirstTokens()`.
* @param countOptions? - Options object.
* If is a number, equivalent to `{ count: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns Array of `Token`s between `nodeOrToken1` and `nodeOrToken2`.
*/
/* oxlint-disable no-unused-vars */
Expand All @@ -1163,7 +1179,8 @@ export function getFirstTokensBetween(
* Get the last token between two non-overlapping nodes.
* @param nodeOrToken1 - Node before the desired token range.
* @param nodeOrToken2 - Node after the desired token range.
* @param skipOptions? - Options object. Same options as `getFirstToken()`.
* If is a number, equivalent to `{ skip: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns `Token`, or `null` if all were skipped.
*/
/* oxlint-disable no-unused-vars */
Expand All @@ -1180,7 +1197,9 @@ export function getLastTokenBetween(
* Get the last tokens between two non-overlapping nodes.
* @param nodeOrToken1 - Node before the desired token range.
* @param nodeOrToken2 - Node after the desired token range.
* @param countOptions? - Options object. Same options as `getFirstTokens()`.
* @param countOptions? - Options object.
* If is a number, equivalent to `{ count: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns Array of `Token`s between `nodeOrToken1` and `nodeOrToken2`.
*/
/* oxlint-disable no-unused-vars */
Expand Down
Loading