Skip to content

fix(linter/plugins): allow fix function to return undefined #14182

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
merged 1 commit into from
Sep 27, 2025
Merged

fix(linter/plugins): allow fix function to return undefined #14182

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
7 changes: 4 additions & 3 deletions apps/oxlint/src-js/plugins/fix.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ const { prototype: ArrayPrototype, from: ArrayFrom } = Array,
// Type of `fix` function.
// `fix` can return a single fix, an array of fixes, or any iterator that yields fixes.
// e.g. `(function*() { yield fix1; yield fix2; })()`
export type FixFn = (fixer: Fixer) => Fix | Array<Fix | null> | IterableIterator<Fix | null> | null;
export type FixFn = (
fixer: Fixer,
) => Fix | Array<Fix | null | undefined> | IterableIterator<Fix | null | undefined> | null | undefined;

// Type of a fix, as returned by `fix` function.
export type Fix = { range: Range; text: string };
Expand Down Expand Up @@ -106,10 +108,9 @@ export function getFixes(diagnostic: Diagnostic, internal: InternalContext): Fix
// Check prototype instead of using `Array.isArray()`, to ensure it is a native `Array`,
// not a subclass which may have overridden `toJSON()` in a way which could make `JSON.stringify()` throw
if (getPrototypeOf(fixes) !== ArrayPrototype || hasOwn(fixes, 'toJSON')) {
fixes = ArrayFrom(fixes as IterableIterator<Fix>);
fixes = ArrayFrom(fixes);
isCloned = true;
}
assertIs<Array<Fix | null>>(fixes);

const fixesLen = fixes.length;
if (fixesLen === 0) return null;
Expand Down
Loading