Skip to content

Comments

fix(linter): permit $schema .oxlintrc.json struct#17060

Merged
camc314 merged 6 commits intomainfrom
copilot/fix-linter-schema-issue
Dec 18, 2025
Merged

fix(linter): permit $schema .oxlintrc.json struct#17060
camc314 merged 6 commits intomainfrom
copilot/fix-linter-schema-issue

Conversation

Copy link
Contributor

Copilot AI commented Dec 18, 2025

Fix: Allow $schema in .oxlintrc.json while maintaining deny_unknown_fields

Problem

  • The Oxlintrc struct has #[serde(deny_unknown_fields)] which rejects all unknown fields
  • Users commonly use $schema in their .oxlintrc.json files for IDE support (as shown in documentation examples)
  • This causes deserialization to fail

Solution

Added a schema field to the Oxlintrc struct that:

  • Is properly named $schema via #[serde(rename = "$schema")]
  • Is optional (Option<String>) and skips serialization when None
  • Maintains deny_unknown_fields for other unknown properties
  • Follows the same merge behavior as other optional fields (self takes priority)

Changes

  1. Added schema field to Oxlintrc struct with appropriate serde attributes
  2. Removed manual $schema injection from generate_schema_json() - now auto-generated
  3. Updated merge() function to handle the new field correctly
  4. Added comprehensive tests for deserialization, serialization, and merge behavior
  5. Updated schema JSON - $schema now appears first and has correct type ["string", "null"]
  6. Fixed CI failures:
    • Resolved clippy warning about unnecessary raw string hashes
    • Updated website_linter snapshot to include $schema field

Testing

✅ Config files with $schema are now accepted
✅ Config files without $schema still work
✅ Unknown fields are still properly rejected
✅ Merge behavior gives priority to self over other
✅ All existing tests pass (878 tests)
✅ Schema generation produces correct output
✅ Clippy checks pass
✅ Website linter tests pass

Original prompt

This section details on the original issue you should resolve

<issue_title>linter: $schema in .oxlintrc.json causes failure to deserailize</issue_title>
<issue_description>cc @connorshea

https://github.com/oxc-project/oxc-ecosystem-ci/actions/runs/20336440475/job/58424680576</issue_description>

<agent_instructions>This broke in d446c43, we should keep deny unknonw fields, but allow $schema</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 18, 2025 13:40
…deny_unknown_fields

Add schema field to Oxlintrc struct to accept $schema in config files.
Remove manual $schema injection from generate_schema_json as it's now auto-generated.
Add test for $schema field deserialization and serialization.

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
Add tests to verify merge priority: self takes priority over other.

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
@camc314 camc314 changed the title [WIP] Fix linter issue with $schema in .oxlintrc.json fix(linter): permit $schema .oxlintrc.json struct Dec 18, 2025
@github-actions github-actions bot added A-linter Area - Linter C-bug Category - Bug labels Dec 18, 2025
@camc314 camc314 marked this pull request as ready for review December 18, 2025 13:46
Copilot AI review requested due to automatic review settings December 18, 2025 13:46
@camc314
Copy link
Contributor

camc314 commented Dec 18, 2025

@copilot fix lint and test CI jobs

@codspeed-hq
Copy link

codspeed-hq bot commented Dec 18, 2025

CodSpeed Performance Report

Merging #17060 will not alter performance

Comparing copilot/fix-linter-schema-issue (bbea0fe) with main (fd03131)

Summary

✅ 4 untouched
⏩ 41 skipped1

Footnotes

  1. 41 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a deserialization failure when $schema is present in .oxlintrc.json configuration files by adding explicit support for the field while maintaining strict validation of other unknown fields.

Key Changes:

  • Added schema field to Oxlintrc struct with proper serde configuration
  • Updated merge logic to handle the new optional field
  • Removed manual schema injection in favor of auto-generation

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
crates/oxc_linter/src/config/oxlintrc.rs Added schema field to Oxlintrc struct with appropriate serde attributes, updated merge logic, and added comprehensive tests
npm/oxlint/configuration_schema.json Updated schema with auto-generated $schema property definition (now positioned first with correct type)
crates/oxc_linter/src/snapshots/schema_json.snap Updated snapshot to reflect schema changes

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

@camc314
Copy link
Contributor

camc314 commented Dec 18, 2025

@copilot CI is failing. fix it

@camc314
Copy link
Contributor

camc314 commented Dec 18, 2025

@copilot fix the failing CI

- Fix clippy warning: remove unnecessary hashes from raw string literal
- Update website_linter snapshot to include $schema field in schema markdown

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 18, 2025

@copilot fix the failing CI

Fixed in 679492d. Resolved:

  • Clippy warning: removed unnecessary hashes from raw string literal
  • Website linter snapshot: updated to include $schema field documentation

@camc314 camc314 merged commit 005ec25 into main Dec 18, 2025
20 checks passed
@camc314 camc314 deleted the copilot/fix-linter-schema-issue branch December 18, 2025 22:02
overlookmotel added a commit that referenced this pull request Dec 19, 2025
# 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

linter: $schema property in .oxlintrc.json causes serde failure to deserailize

2 participants