docs(linter): Add oxlint.config.ts to the config docs.

[connorshea]

Previously we were not showing the oxlint.config.ts format at all in the config reference docs. This at least fixes that and removes an inaccurate warning message.

Helps fix part of oxc-project/website#950

[Copilot]

Pull request overview

Updates the Oxlint configuration reference docs to include the oxlint.config.ts format (in addition to .oxlintrc.json) and removes outdated guidance about JSON-only configs.

Changes:

• Removes the “Only the .json format is supported” warning and drops --import-plugin from the documented usage line.
• Adds an oxlint.config.ts example to the config schema description so it flows through to rendered docs.
• Regenerates derived artifacts (website schema markdown/json snapshots and generated TS typings docs).

Reviewed changes

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

Show a summary per file

File	Description
tasks/website_linter/src/snapshots/schema_markdown.snap	Updates rendered schema markdown to remove the JSON-only warning and include an oxlint.config.ts example.
tasks/website_linter/src/snapshots/schema_json.snap	Updates the schema JSON snapshot to match the new schema description content.
npm/oxlint/configuration_schema.json	Updates the published JSON schema description/markdownDescription to include oxlint.config.ts docs and revised usage text.
crates/oxc_linter/src/config/oxlintrc.rs	Updates the Rust doc comment that feeds schema/docs, including the new TS config example.
apps/oxlint/src-js/package/config.generated.ts	Regenerated TS types/docs from the updated schema.

Comments suppressed due to low confidence (4)

crates/oxc_linter/src/config/oxlintrc.rs:75

• The usage line references oxlintrc.json, but the example immediately below uses .oxlintrc.json and the CLI default config name is .oxlintrc.json (see DEFAULT_OXLINTRC_NAME). Consider updating the usage text to match the default filename to avoid confusing users.

/// Usage: `oxlint -c oxlintrc.json`

crates/oxc_linter/src/config/oxlintrc.rs:146

• The oxlint.config.ts example has an extra closing } right before });, which makes the sample TypeScript invalid. Remove the standalone } line so the call ends with a single });.

///  }
/// });

npm/oxlint/configuration_schema.json:4

• The embedded oxlint.config.ts snippet in the schema strings ends with }\n});, which includes an extra } before }); and makes the sample invalid TypeScript. Also, the usage text mentions oxlintrc.json while the documented/default filename is .oxlintrc.json; consider aligning the usage line with the default/example name.

  "description": "Oxlint Configuration File\n\nThis configuration is aligned with ESLint v8's configuration schema (`eslintrc.json`).\n\nUsage: `oxlint -c oxlintrc.json`\n\nExample\n\n`.oxlintrc.json`\n\n```json\n{\n\"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n\"plugins\": [\"import\", \"typescript\", \"unicorn\"],\n\"env\": {\n\"browser\": true\n},\n\"globals\": {\n\"foo\": \"readonly\"\n},\n\"settings\": {\n\"react\": {\n\"version\": \"18.2.0\"\n},\n\"custom\": { \"option\": true }\n},\n\"rules\": {\n\"eqeqeq\": \"warn\",\n\"import/no-cycle\": \"error\",\n\"react/self-closing-comp\": [\"error\", { \"html\": false }]\n},\n\"overrides\": [\n{\n\"files\": [\"*.test.ts\", \"*.spec.ts\"],\n\"rules\": {\n\"@typescript-eslint/no-explicit-any\": \"off\"\n}\n}\n]\n}\n```\n\n`oxlint.config.ts`\n\n```ts\nimport { defineConfig } from \"oxlint\";\n\nexport default defineConfig({\nplugins: [\"import\", \"typescript\", \"unicorn\"],\nenv: {\n\"browser\": true\n},\nglobals: {\n\"foo\": \"readonly\"\n},\nsettings: {\nreact: {\nversion: \"18.2.0\"\n},\ncustom: { option: true }\n},\nrules: {\n\"eqeqeq\": \"warn\",\n\"import/no-cycle\": \"error\",\n\"react/self-closing-comp\": [\"error\", { \"html\": false }]\n},\noverrides: [\n{\nfiles: [\"*.test.ts\", \"*.spec.ts\"],\nrules: {\n\"@typescript-eslint/no-explicit-any\": \"off\"\n}\n}\n]\n}\n});\n```",

apps/oxlint/src-js/package/config.generated.ts:165

• The oxlint.config.ts example in this generated JSDoc ends with a standalone } followed by });, which makes the sample invalid TypeScript. Fix the source schema/doc template so the snippet ends with a single });, then regenerate this file.

 * ]
 * }
 * });
 * ```

[codspeed-hq]

Merging this PR will not alter performance

✅ 4 untouched benchmarks
⏩ 52 skipped benchmarks¹

---

_{Comparing update-config-docs (6cd004c) with main (ccbd959)²}

Footnotes

1. 52 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. ↩

2. No successful run was found on main (ec91dce) during the generation of this report, so ccbd959 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

[camc314]

Thanks!

[camc314]

Merge activity

• Mar 3, 12:34 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• Mar 3, 12:34 PM UTC: camc314 added this pull request to the Graphite merge queue.
• Mar 3, 12:42 PM UTC: Merged by the Graphite merge queue.