Skip to content

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

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): fix JSDoc comments for tokens methods #16063

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
11 changes: 9 additions & 2 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 @@ -917,6 +917,7 @@ export function getTokensBefore(
/**
* Get the token that follows a given node or token.
* @param nodeOrToken - The AST node or token.
* @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.
Expand Down Expand Up @@ -1142,6 +1143,7 @@ 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.
* If is a number, equivalent to `{ skip: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns `Token`, or `null` if all were skipped.
Expand All @@ -1150,8 +1152,10 @@ export function getTokensBetween(
export function getFirstTokenBetween(
nodeOrToken1: NodeOrToken | Comment,
nodeOrToken2: NodeOrToken | Comment,
skipOptions?: SkipOptions | null,
skipOptions?: SkipOptions | number | FilterFn | null,
): Token | null {
// TODO: Check that `skipOptions` being a number or a function is supported by ESLint in this method.
// Original type def was `SkipOptions | null`. I (@overlookmotel) assume that was a mistake.
throw new Error('`sourceCode.getFirstTokenBetween` not implemented yet'); // TODO
}
/* oxlint-enable no-unused-vars */
Expand Down Expand Up @@ -1179,6 +1183,7 @@ 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.
* If is a number, equivalent to `{ skip: n }`.
* If is a function, equivalent to `{ filter: fn }`.
* @returns `Token`, or `null` if all were skipped.
Expand All @@ -1187,8 +1192,10 @@ export function getFirstTokensBetween(
export function getLastTokenBetween(
nodeOrToken1: NodeOrToken | Comment,
nodeOrToken2: NodeOrToken | Comment,
skipOptions?: SkipOptions | null,
skipOptions?: SkipOptions | number | FilterFn | null,
): Token | null {
// TODO: Check that `skipOptions` being a number or a function is supported by ESLint in this method.
// Original type def was `SkipOptions | null`. I (@overlookmotel) assume that was a mistake.
throw new Error('`sourceCode.getLastTokenBetween` not implemented yet'); // TODO
}
/* oxlint-enable no-unused-vars */
Expand Down
Loading