Skip to content

fix(linter/plugins): Handle false as a technically-allowed value for rule.meta.fixable. #18011

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

Closed
connorshea wants to merge 3 commits into from
Closed

fix(linter/plugins): Handle false as a technically-allowed value for rule.meta.fixable. #18011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
122b735
fix(linter/plugins): Handle `false` as a technically-allowed value fo…
connorshea Jan 14, 2026
3139d17
Update apps/oxlint/src-js/plugins/load.ts
connorshea Jan 14, 2026
991c503
Update RuleMeta doc comment.
connorshea Jan 14, 2026
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
6 changes: 5 additions & 1 deletion apps/oxlint/src-js/plugins/load.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ export async function loadPlugin(
* @throws {Error} If `plugin.meta.name` is `null` / `undefined` and `packageName` not provided
* @throws {TypeError} If one of plugin's rules is malformed, or its `createOnce` method returns invalid visitor
* @throws {TypeError} If `plugin.meta.name` is not a string
* @throws {TypeError} If the plugin has a rule with an invalid `meta.fixable` value.
*/
export function registerPlugin(
plugin: Plugin,
Expand Down Expand Up @@ -169,7 +170,10 @@ export function registerPlugin(
if (typeof ruleMeta !== "object") throw new TypeError("Invalid `rule.meta`");

const { fixable } = ruleMeta;
if (fixable != null) {
// ESLint technically only allows `null`, unset, or "code" / "whitespace" for `fixable`. Unfortunately,
// it doesn't actually enforce this meaningfully, and so some plugins use `false` by accident.
// So we have to handle `false` as well.
if (fixable != null && (fixable as any) !== false) {
if (fixable !== "code" && fixable !== "whitespace") {
throw new TypeError("Invalid `rule.meta.fixable`");
}
Expand Down
1 change: 1 addition & 0 deletions apps/oxlint/src-js/plugins/rule_meta.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export interface RuleMeta {
/**
* Type of fixes that the rule provides.
* Must be `'code'` or `'whitespace'` if the rule provides fixes.
* Must be `null` or omitted entirely, if the rule does not provide fixes.
*/
fixable?: "code" | "whitespace";
/**
Expand Down
Loading