fix(linter/plugins): apply defaults from `meta.schema` to options by overlookmotel · Pull Request #16930 · oxc-project/oxc

overlookmotel · 2025-12-16T03:33:24Z

ESLint has 2 different ways to define default options for a rule - rule.meta.defaultOptions, or rule.meta.schema containing a schema which defines default values.

We previously supported the former, but not the latter. This PR implements support for defining defaults via rule.meta.schema.

We compile the schema and apply it to options on JS side, using ajv, which is what ESLint uses. But this process only happens once before the start of linting, not once for every file, so the perf hit should be small.

This also prepares the way for validating options against the schema (#15631).

overlookmotel · 2025-12-16T03:33:38Z

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

0-merge - adds this PR to the back of the merge queue
hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

…ions (#16929) `RuleTester` call `setOptions` to set up rule options, same as linter does. This makes sure the rule tester's behavior matches actual linter exactly. It also prepares the way for applying defaults from `rule.meta.schema` (#16930).

Copilot

Pull request overview

This PR adds support for applying default values to rule options from rule.meta.schema definitions, complementing the existing rule.meta.defaultOptions support. The implementation uses AJV v6 (matching ESLint's behavior) to compile schemas and apply defaults during option processing, with proper precedence: config options > defaultOptions > schema defaults.

Key Changes:

Schema compilation infrastructure using AJV v6 with ESLint-compatible configuration
Refactored options merging logic to support schema-based defaults while maintaining immutability guarantees
Test coverage demonstrating the interaction between schema defaults, defaultOptions, and config-provided options

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
apps/oxlint/src-js/plugins/options.ts	Implements schema compilation and refactors options processing to apply schema defaults after merging with defaultOptions
apps/oxlint/src-js/plugins/load.ts	Integrates schema validator compilation into rule registration and applies schema defaults to defaultOptions
apps/oxlint/package.json	Adds ajv and @types/json-schema dependencies
apps/oxlint/test/fixtures/options/plugin.ts	Adds test rules demonstrating schema defaults, both alone and combined with defaultOptions
apps/oxlint/test/fixtures/options/.oxlintrc.json	Configures test cases for the new schema-default rules
apps/oxlint/test/fixtures/options/output.snap.md	Updates snapshots to include test output for schema defaults functionality
apps/oxlint/conformance/snapshot.md	Shows improved test pass rate (computed-property-spacing now fully passing)

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

apps/oxlint/src-js/plugins/options.ts

overlookmotel · 2025-12-16T17:28:31Z

Looks like VSCode CI fail is unrelated to this PR. This task started failing on #16881. It's just not been run on any other PRs until this PR.

overlookmotel · 2025-12-16T23:03:09Z

Merge activity

Dec 16, 11:03 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Dec 16, 11:03 PM UTC: overlookmotel added this pull request to the Graphite merge queue.
Dec 16, 11:10 PM UTC: Merged by the Graphite merge queue.

…6930) ESLint has 2 different ways to define default options for a rule - `rule.meta.defaultOptions`, or `rule.meta.schema` containing a schema which defines default values. We previously supported the former, but not the latter. This PR implements support for defining defaults via `rule.meta.schema`. We compile the schema and apply it to options on JS side, using [`ajv`](https://www.npmjs.com/package/ajv), which is what ESLint uses. But this process only happens once before the start of linting, not once for every file, so the perf hit should be small. This also prepares the way for validating options against the schema (#15631).

…ues (#16962) Add methods for deep cloning JSON values, objects, and arrays. These are used in the next PR (#16930).

Fixes #15631. #16930 implemented options validation against `rule.meta.schema`, for the purpose of supporting default options added by schema. But it didn't actually do anything if validation failed. Implement validation of options against schema, and pass any errors back to Rust to print.

# Oxlint ### 🚀 Features - 6cc3fdf linter/no-inferrable-types: Implement fixer (#17090) (camc314) - 2067997 linter/no-negation-in-equality-check: Implement suggestion (#17084) (camc314) - 552f9ef vscode: Auto-generate VSCode README configuration from package.json (#16970) (Copilot) - 9190c4b linter/no-unnecessary-array-flat-depth: Implement fixer (#17057) (camc314) - ed789de linter/misrefactored-assign-op: Implement fixer (#17056) (camc314) - a0f74a0 linter/config: Allow aliasing plugin names to allow names the same as builtin plugins (#15569) (Cameron) - a43d251 linter/plugins: `RuleTester` support `languageOptions.globals` (#17009) (overlookmotel) - 35070d9 linter/bad-bitwise-operator: Implement fixer (#17006) (camc314) - 322d995 linter/prefer-enum-initializers: Implement fixer (#17004) (camc314) - ae1e5bc vscode: Add support for tsgolint binary configuration (#16921) (ColemanDunn) - 3bfe31e linter/eslint-plugin-vitest: Add prefer-called-with as vitest compatible jest rule (#16993) (Said Atrahouch) - 0cd075f linter/eslint-plugin-jest: Add fix capabilities to prefer-called-with rule (#16987) (Said Atrahouch) - 357564b linter: Add options for `typescript/require-array-sort-compare` rule. (#16980) (connorshea) - 2b0ffba linter: Add options for `typescript/no-meaningless-void-operator` rule. (#16981) (connorshea) - 8bc4287 linter/plugins: Validate options against schema (#16974) (overlookmotel) - fdc7d08 linter: Implement eslint/capitalized-comments (#16896) (Tu Shaokun) - f8b6561 linter: Add support for `test.for` in vitest (#16925) (camchenry) - 7ee0379 linter/eslint-plugin-vitest: Implement prefer-spy-on (#16426) (Said Atrahouch) - fc96ee0 linter: Implement jest/prefer-to-have-been-called-times (#16938) (秦宇航) - 291b57b ast_tools: Generate TS declaration files for deserializer and walk files (#16912) (camc314) - e31da2a linter: Implement jest/perfer-to-have-been-called (#16899) (秦宇航) - 1a31306 linter/eslint-plugin-vitest: Add require-hook as vitest compatible jest rule (#16880) (Said Atrahouch) - cd3db21 linter: Add ignoredTypeNames option to no-base-to-string rule (#16898) (camc314) - 763b25a linter: Implement eslint/no-inline-comments (#16885) (Tu Shaokun) ### 🐛 Bug Fixes - fb9e193 linter: OOM problems with custom plugins (#17082) (overlookmotel) - 005ec25 linter: Permit `$schema` `.oxlintrc.json` struct (#17060) (Copilot) - fd03131 linter/plugins: Handle plugin names containing slashes (#17073) (overlookmotel) - b2a4fac linter/plugins: Error if plugin name alias is not normalized (#17071) (overlookmotel) - e046c4e linter/no-misused-spread: Add rule options support (#17054) (camc314) - 5c1a9e0 linter/no-deprecated: Add rule options support (#17053) (camc314) - 8c9cafe linter: `import/consistent-type-specifier-style`: add support for declaration files (#16979) (camchenry) - dab4780 linter/no-empty-pattern: Misleading help message for arrays (#17039) (Copilot) - 67f8c5d linter/plugins: Get correct plugin name in all cases (#17033) (overlookmotel) - 674dab9 linter/plugins: Fix indentation in error message (#17018) (overlookmotel) - 6524f72 linter/plugins: Add `@types/node` dev dependency to `oxlint` package (#17016) (overlookmotel) - 7a35513 linter/plugins: Better error for `null` in `globals` in `RuleTester` (#17011) (overlookmotel) - 42603ba linter/plugins: Always define `languageOptions.globals` (#17008) (overlookmotel) - 4cdc2f8 linter: Fix VITEST override rule list and add test for alphabetizing the two lists (#16975) (Connor Shea) - e466562 linter/consistent-type-definitions: Handle parenthesized types in rule (#16998) (camc314) - fce267c linter: Correct vitest plugin source to be `@vitest/eslint-plugin` (#16976) (connorshea) - 477bb57 linter: Fix `vitest/no-restricted-vi-methods` and add tests for it. (#16971) (connorshea) - 7d6974d linter: Ignore oxlint directive comments in capitalized-comments (#16989) (Tu Shaokun) - 23ac6b1 linter/plugins: Apply defaults from `meta.schema` to options (#16930) (overlookmotel) - 2f946cf linter/plugins: Error if `defaultOptions` is not JSON-serializable (#16959) (overlookmotel) - d8b8a57 linter/plugins: Freeze whole of merged options (#16958) (overlookmotel) - d446c43 linter: Prevent extra fields from being present on oxlint config file (#16874) (connorshea) - b845871 linter/plugins: Correctly handle object with `__proto__` keys in options merging (#16928) (overlookmotel) - c897794 linter: Fix eslint/sort-imports allowSeparatedGroups not working with single empty line (#16012) (Duc Nghiem Xuan) - 0c347a1 linter/array-type: Handle satisfies expression (#16903) (camc314) ### ⚡ Performance - 70d853c linter: Avoid cloning source text when cloning AST into fixed-size allocator (#17088) (overlookmotel) - 4d389f7 linter: Less bounds checks in `normalize_plugin_name` (#17030) (overlookmotel) - fd8e9c6 linter/plugins: Speed up cloning JSON objects (#16997) (overlookmotel) - d77e22d linter/plugins: Use `DEFAULT_OPTIONS` for rules with empty array as default options (#16913) (overlookmotel) ### 📚 Documentation - 6d053b4 linter: Fix typo in doc comment (#17091) (overlookmotel) - b5f3c91 linter: Document intentional exclusion of ignoreCase option in jsx-no-duplicate-props (#17046) (Copilot) - a0bf5d8 linter: Fix the config option docs for no-inline-comments rule. (#16983) (connorshea) - ca26a11 linter/plugins: Fix typo in doc comment (#16966) (overlookmotel) - 3183bf8 linter/plugins: Fix typo in JSDoc comment (#16900) (overlookmotel) # Oxfmt ### 🚀 Features - 15dfb55 oxfmt: Respect single nearest `.editorconfig` (#17043) (leaysgur) - 8c33ff4 oxfmt: Expose Node.js API: `format(fileName, sourceText, options?)` (#16939) (leaysgur) ### 🐛 Bug Fixes - d340c87 oxfmt: Update api `FormatOptions` type with `& Record<string, unknown>` (#17036) (leaysgur) - 827a256 oxfmt: Place ignorePatterns at bottom of JSON in --migrate prettier (#16926) (Boshen) Co-authored-by: overlookmotel <557937+overlookmotel@users.noreply.github.com>

…ues (oxc-project#16962) Add methods for deep cloning JSON values, objects, and arrays. These are used in the next PR (oxc-project#16930).

…c-project#16930) ESLint has 2 different ways to define default options for a rule - `rule.meta.defaultOptions`, or `rule.meta.schema` containing a schema which defines default values. We previously supported the former, but not the latter. This PR implements support for defining defaults via `rule.meta.schema`. We compile the schema and apply it to options on JS side, using [`ajv`](https://www.npmjs.com/package/ajv), which is what ESLint uses. But this process only happens once before the start of linting, not once for every file, so the perf hit should be small. This also prepares the way for validating options against the schema (oxc-project#15631).

) Fixes oxc-project#15631. oxc-project#16930 implemented options validation against `rule.meta.schema`, for the purpose of supporting default options added by schema. But it didn't actually do anything if validation failed. Implement validation of options against schema, and pass any errors back to Rust to print.

github-actions bot added A-linter Area - Linter A-cli Area - CLI A-linter-plugins Area - Linter JS plugins labels Dec 16, 2025

This was referenced Dec 16, 2025

refactor(linter/plugins): rename var #16927

Merged

fix(linter/plugins): correctly handle object with __proto__ keys in options merging #16928

Merged

github-actions bot added the C-bug Category - Bug label Dec 16, 2025

overlookmotel mentioned this pull request Dec 16, 2025

refactor(linter/plugins): RuleTester use setOptions to set up options #16929

Merged

overlookmotel self-assigned this Dec 16, 2025

overlookmotel force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from 7ff114a to 2eb44fe Compare December 16, 2025 03:39

graphite-app bot changed the base branch from 12-15-refactor_linter_plugins_ruletester_use_setoptions_to_set_up_options to graphite-base/16930 December 16, 2025 03:42

graphite-app bot force-pushed the graphite-base/16930 branch from 0772a71 to 0c799e2 Compare December 16, 2025 03:49

graphite-app bot force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from 2eb44fe to 17ede84 Compare December 16, 2025 03:49

graphite-app bot changed the base branch from graphite-base/16930 to main December 16, 2025 03:49

graphite-app bot force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from 17ede84 to 1708ca6 Compare December 16, 2025 03:50

overlookmotel changed the base branch from main to graphite-base/16930 December 16, 2025 15:53

overlookmotel changed the base branch from graphite-base/16930 to main December 16, 2025 15:53

overlookmotel changed the base branch from main to graphite-base/16930 December 16, 2025 15:54

overlookmotel force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from 1708ca6 to 14da4fb Compare December 16, 2025 15:54

overlookmotel changed the base branch from graphite-base/16930 to 12-16-refactor_linter_plugins_introduce_methods_for_deep_cloning_json_values December 16, 2025 15:54

overlookmotel marked this pull request as ready for review December 16, 2025 16:13

overlookmotel requested a review from camc314 as a code owner December 16, 2025 16:13

Copilot AI review requested due to automatic review settings December 16, 2025 16:13

Copilot AI reviewed Dec 16, 2025

View reviewed changes

apps/oxlint/src-js/plugins/options.ts Show resolved Hide resolved

apps/oxlint/src-js/plugins/options.ts Outdated Show resolved Hide resolved

overlookmotel force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from 14da4fb to 9cca8d0 Compare December 16, 2025 16:27

overlookmotel force-pushed the 12-16-refactor_linter_plugins_introduce_methods_for_deep_cloning_json_values branch from dfb2fbc to 2763b8f Compare December 16, 2025 16:27

overlookmotel marked this pull request as draft December 16, 2025 16:39

overlookmotel mentioned this pull request Dec 16, 2025

Linter plugins: Validate user-provided options against rule.meta.schema #15631

Closed

graphite-app bot force-pushed the 12-16-refactor_linter_plugins_introduce_methods_for_deep_cloning_json_values branch from 2763b8f to 220c326 Compare December 16, 2025 16:47

graphite-app bot force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from 9cca8d0 to dfb896d Compare December 16, 2025 16:47

overlookmotel marked this pull request as ready for review December 16, 2025 17:26

graphite-app bot force-pushed the 12-16-refactor_linter_plugins_introduce_methods_for_deep_cloning_json_values branch 2 times, most recently from b27b3c1 to b1a8ac2 Compare December 16, 2025 17:41

graphite-app bot force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from dfb896d to 3837a78 Compare December 16, 2025 17:41

overlookmotel added the 0-merge Merge with Graphite Merge Queue label Dec 16, 2025

graphite-app bot pushed a commit that referenced this pull request Dec 16, 2025

refactor(linter/plugins): introduce methods for deep cloning JSON val…

4c4de62

…ues (#16962) Add methods for deep cloning JSON values, objects, and arrays. These are used in the next PR (#16930).

graphite-app bot force-pushed the 12-16-refactor_linter_plugins_introduce_methods_for_deep_cloning_json_values branch from b1a8ac2 to 4c4de62 Compare December 16, 2025 23:03

graphite-app bot force-pushed the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch from 3837a78 to 23ac6b1 Compare December 16, 2025 23:04

Base automatically changed from 12-16-refactor_linter_plugins_introduce_methods_for_deep_cloning_json_values to main December 16, 2025 23:09

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Dec 16, 2025

graphite-app bot merged commit 23ac6b1 into main Dec 16, 2025
19 of 20 checks passed

graphite-app bot deleted the 12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options branch December 16, 2025 23:10

overlookmotel mentioned this pull request Dec 17, 2025

feat(linter/plugins): validate options against schema #16974

Merged

Boshen mentioned this pull request Dec 19, 2025

release(apps): oxlint v1.34.0 && oxfmt v0.19.0 #17097

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

fix(linter/plugins): apply defaults from `meta.schema` to options#16930

fix(linter/plugins): apply defaults from `meta.schema` to options#16930
graphite-app[bot] merged 1 commit intomainfrom
12-15-fix_linter_plugins_apply_defaults_from_meta.schema_to_options

overlookmotel commented Dec 16, 2025 •

edited

Loading

Uh oh!

overlookmotel commented Dec 16, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

overlookmotel commented Dec 16, 2025 •

edited

Loading

Uh oh!

overlookmotel commented Dec 16, 2025 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Comments

Conversation

overlookmotel commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

overlookmotel commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

overlookmotel commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

overlookmotel commented Dec 16, 2025 • edited by graphite-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

overlookmotel commented Dec 16, 2025 •

edited

Loading

overlookmotel commented Dec 16, 2025 •

edited

Loading

overlookmotel commented Dec 16, 2025 •

edited

Loading

overlookmotel commented Dec 16, 2025 •

edited by graphite-app bot

Loading