docs(oxlint/lsp): auto generate docs for LSP options by Sysix · Pull Request #22082 · oxc-project/oxc

Sysix · 2026-05-02T18:16:10Z

Pull request overview

This PR adds automated generation of website documentation for oxlint’s LSP linting options by exposing the LSP options schema, rendering it to markdown, and snapshot-testing the output.

An PR on oxc-project/website is needed. Will wait for the next release to improve the LSP & Editor docs too :)

Sysix · 2026-05-02T18:16:24Z

docs(oxlint/lsp): auto generate docs for LSP options #22082 👈 (View in Graphite)
main

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 changes, fast-track this PR to the front of the merge queue

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.

codspeed-hq · 2026-05-02T18:22:45Z

Merging this PR will not alter performance

✅ 48 untouched benchmarks
⏩ 3 skipped benchmarks¹

_{Comparing 05-02-docs_oxlint_lsp_auto_generate_docs_for_lsp_options (f6e4a19) with main (a77f0f7)}

3 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. ↩

Copilot

Pull request overview

This PR adds automated generation of website documentation for oxlint’s LSP linting options by exposing the LSP options schema, rendering it to markdown, and snapshot-testing the output.

Changes:

Export oxlint::lsp::options::LintOptions and derive JsonSchema so its schema can be rendered as markdown docs.
Add a new website_linter task (schema-markdown-lsp) plus an insta snapshot test for the generated LSP options markdown.
Improve markdown sanitization to pretty-print multiple embedded ```json code blocks (not just the first one).

Reviewed changes

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

Show a summary per file

File	Description
tasks/website_linter/src/snapshots/schema_markdown_lsp.snap	New snapshot for generated LSP options markdown
tasks/website_linter/src/main.rs	Adds `schema-markdown-lsp` task entrypoint
tasks/website_linter/src/json_schema.rs	Renders `LintOptions` schema to markdown + adds snapshot test/print function
tasks/website_common/src/schema_markdown.rs	Updates `sanitize` to format multiple JSON fenced blocks
justfile	Adds website generation step for `generated-lsp-config.md`
apps/oxlint/src/main.rs	Adjusts imports to use `oxlint::lsp::run_lsp` after module export changes
apps/oxlint/src/lsp/options.rs	Adds `JsonSchema` derives + documentation comments for schema-driven docs
apps/oxlint/src/lsp/mod.rs	Makes `options` a public module
apps/oxlint/src/lib.rs	Makes `lsp` a public module and adjusts CLI re-exports
apps/oxlint/Cargo.toml	Adds `schemars` dependency
Cargo.lock	Locks new dependency (`oxc-schemars`)

camc314 · 2026-05-02T19:59:18Z

Merge activity

May 2, 7:59 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
May 2, 7:59 PM UTC: camc314 added this pull request to the Graphite merge queue.
May 2, 8:04 PM UTC: Merged by the Graphite merge queue.

> ## Pull request overview > This PR adds automated generation of website documentation for oxlint’s LSP linting options by exposing the LSP options schema, rendering it to markdown, and snapshot-testing the output. An PR on `oxc-project/website` is needed. Will wait for the next release to improve the LSP & Editor docs too :)

# Oxlint ### 🚀 Features - 1d40d60 linter: Implement SARIF formatter (#22067) (camchenry) - c0982fe linter/eslint: Implement no-restricted-properties rule (#22080) (AJ Bienz) - 5699d53 linter: Add help text to `agent` formatter (#22064) (camchenry) - fe7194d oxlint: Add agent output mode (#21955) (Jovi De Croock) - fb2f052 linter: Suggest moving shared branch code (#22022) (camc314) - 5868335 linter/no-else-return: Improve nested if diagnostic spans (#22009) (camc314) - 8b4829b linter: Split `no-negated-condition` rule to unicorn & eslint (#21998) (Sysix) - fea301a linter: Split jest/prefer-to-be into separate vitest rule (#21977) (camchenry) - 44aa0d6 linter: Split jest/prefer-strict-equal into separate vitest rule (#21976) (camchenry) - 2262b27 linter: Split jest/prefer-spy-on into separate vitest rule (#21975) (camchenry) - fef9143 linter: Split jest/prefer-mock-return-shorthand into separate vitest rule (#21974) (camchenry) - 2bda504 linter: Split jest/prefer-mock-promise-shorthand into separate vitest rule (#21973) (camchenry) - 6ef6c7d linter: Split jest/prefer-lowercase into separate vitest rule (#21972) (camchenry) - f4d2498 linter: Split jest/prefer-hooks-on-top into separate vitest rule (#21971) (camchenry) - fb8e366 linter: Split jest/prefer-hooks-in-order into separate vitest rule (#21970) (camchenry) - adcd85c linter: Split jest/prefer-expect-resolves into separate vitest rule (#21969) (camchenry) - 8ddc7ec linter: Split jest/prefer-equality-matcher into separate vitest rule (#21968) (camchenry) - 46bb1f3 linter: Split jest/prefer-each into separate vitest rule (#21967) (camchenry) - bdbff66 linter: Implement interactive-supports-focus (#21767) (mehm8128) - 733b094 linter: Split `prefer-to-have-been-called-times` rule (#21898) (Said Atrahouch) - 8804425 linter/eslint: Implement `logical-assignment-operators` rule (#21900) (Mikhail Baev) - 296d147 linter: Split jest/prefer-comparison-matcher into separate vitest rule (#21929) (camchenry) - 38146b6 linter: Split jest/prefer-called-with into separate vitest rule (#21927) (camchenry) - 6f86175 linter/vue: Implement return-in-computed-property rule (#21909) (bab) - dc2d0e4 linter: Split jest/no-unneeded-async-expect-function into separate vitest rule (#21878) (camchenry) - a03fc37 linter: Split jest/no-test-return-statement into separate vitest rule (#21877) (camchenry) - f11313e linter: Split jest/no-test-prefixes into separate vitest rule (#21876) (camchenry) - 4380812 linter: Split `prefer-to-have-length` rule (#21893) (Said Atrahouch) - 511bcc1 linter: Split jest `require-hook` rule (#21889) (Said Atrahouch) - 64a8180 linter: Split `jest/prefer-snapshot-hint` into a Jest rule and a Vitest rule. (#21881) (connorshea) - ae7924a linter/vue: Implement no-deprecated-model-definition rule (#21886) (bab) - 0dfe8b3 linter: Split `jest/require-to-throw-message` into Jest and Vitest rules. (#21879) (connorshea) - 51229ff linter: Split jest `valid-describe-callback` rule (#21882) (Said Atrahouch) - 2d102fd linter: Split `no-standalone-expect` rule into jest and vitest (#21862) (Sysix) - ee46a29 linter: Split `no-restricted-matchers` rule into jest and vitest (#21860) (Sysix) - 1f29459 linter: Split `no-restricted-jest-methods` rule into jest and vitest (#21859) (Sysix) - e7f8d55 linter: Remove eslint prefixes from plugin names in diagnostics (#21806) (Connor Shea) - 89fff8b linter: Split valid-expect-in-promise/jest rule into jest and vitest rules (#21854) (Said Atrahouch) ### 🐛 Bug Fixes - 0b48848 linter/prefer-array-some: Make find rewrite a suggestion (#22103) (camc314) - d24027e linter/prefer-array-some: Preserve find comparison fixes (#22094) (camc314) - af2d26c linter/astro: Handle js `---` after frontmatter in .astro files (#22091) (Andrew Powell) - 78d4ff0 linter/jsdoc/require-returns: Only look at the nearest jsdoc block (#22077) (camc314) - fa88857 linter/no-map-spread: Use default codegen options for fix (#22074) (camc314) - 2047a35 linter: Treat adjacent fixes as overlapping (#22071) (camc314) - 75fc551 linter: Handle no-extra-boolean-cast edge cases (#22031) (camc314) - e9d5284 linter/sort-keys: Don't autofix if comment could be misplaced (#22052) (Amund Eggen Svandal) - d7230b0 linter/no-constant-condition: Handle generator yields (#22046) (camc314) - e8dbc56 linter/array-type: Enable edge case tests (#22047) (camc314) - d57b51f linter/no-constant-condition: Propagate config errors (#22045) (camc314) - bdb6d95 linter/typescript: Remove duplicate rule tests (#22044) (camc314) - 0beaffc linter: Print resolved extended config (#22040) (camc314) - 192ad0e linter/react/only-export-components: Align rule with upstream cases (#22039) (camc314) - cdf4c53 linter/only-export-components: Support tanstack router (#21937) (camc314) - 893e18f linter: Stop gitignore lookup at repo boundary (#22033) (camc314) - 7100712 linter/constructor-super: Clarify duplicate super diagnostics (#22035) (camc314) - fce5b7c linter/constructor-super: Improve invalid `super` calls diagnostic (#22032) (camc314) - b3de93c linter/rules-of-hooks: Clarify conditional diagnostics (#22030) (camc314) - 4f9f629 linter/rules-of-hooks: Clarify loop diagnostics (#22029) (camc314) - e6f0978 linter/rules-of-hooks: Clarify async component diagnostics (#22024) (camc314) - e262f51 linter/rules-of-hooks: Improve diagnostic for hook inside class component (#22023) (camc314) - 7b71b0d linter/no-restricted-imports: Report once per import declaration (#22021) (camc314) - 3d5ae3d linter/vitest/require-mock-type-parameters: Handle chained typed mocks (#22019) (camc314) - 959a2db linter/reporter/github: Omit empty `file` annotations (#22017) (camc314) - 16003a1 linter/unicorn: Remove duplicate rule tests (#22018) (camc314) - 86b7547 linter/no-unreachable: Suppress nested unreachable diagnostics (#22011) (camc314) - 1d92ae8 linter/oxc: Remove duplicate rule tests (#22013) (camc314) - f270246 linter/branches-sharing-code: Ignore empty statements (#22012) (camc314) - f1c25dd linter: Stabilize debug diagnostic comparison (#22010) (camc314) - b6bc421 linter: Skip linting astro scripts with non JS script types (#21954) (camc314) - a77547d linter: Support plugin-qualified disable directives (#21999) (camc314) - 079cfdd linter: Match disable directive rule names exactly, not by substring (#21906) (Christian Vuerings) - 11a4e67 linter: Comptibles rules need to be disabled in jest and vitest at same time (#21982) (Said Atrahouch) - ce62f16 linter: `jsx-a11y/prefer-tag-over-role` detect more roles (#21933) (bab) - 024c390 linter/jest/vitest: Padding around after all blocks not working as expected (#21952) (kapobajza) - 05a8f75 linter/jest/no-standalone-expect: False positive with expect in an `ObjectProperty` (#21948) (Said Atrahouch) - 6a37c98 linter/no-unused-vars: Report unused re-exported imports (#21938) (camc314) - 2d5fc16 linter: `jsx-a11y/media-has-caption` report only once for self-closing tags (#21934) (bab) - 5adca29 linter: `jsx-a11y/no-autofocus` ignore `false` attribute values (#21918) (Sysix) - 2e5c18e linter/max-nested-describe: Reset nested describe depth (#21891) (camc314) ### ⚡ Performance - a77f0f7 linter/require-returns: Avoid jsdoc tag vec allocation (#22081) (camc314) - d9a1b32 linter/plugins: Avoid array lookups where possible in CFG visitor (#21940) (overlookmotel) - fefefd8 linter/plugins: Replace addition with bitwise OR in CFG visitor (#21939) (overlookmotel) ### 📚 Documentation - d58f594 oxlint/lsp: Auto generate docs for LSP options (#22082) (Sysix) - 9adc3b3 linter/no-misused-new: Clarify construct signatures behaviour (#22016) (camc314) - 1caf5ad linter/plugins: Reformat comments (#21873) (overlookmotel) # Oxfmt ### 🐛 Bug Fixes - ef0db6b formatter: Sequence expression in arrow function body collapses onto one line (#21183) (Justin Mecham) - 5d5d808 formatter: Preserve blank line after directive with trailing comment (#21153) (Justin Mecham) ### ⚡ Performance - 2fd907d formatter: Sort imports during IR construction (#22065) (overlookmotel) --------- Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com> Co-authored-by: Cameron Clark <cameron.clark@hey.com>

Sysix force-pushed the 05-02-docs_oxlint_lsp_auto_generate_docs_for_lsp_options branch 2 times, most recently from e2b728d to c9c328f Compare May 2, 2026 19:03

Sysix requested a review from Copilot May 2, 2026 19:04

Copilot started reviewing on behalf of Sysix May 2, 2026 19:04 View session

Copilot AI reviewed May 2, 2026

View reviewed changes

Comment thread apps/oxlint/src/lsp/options.rs

Comment thread apps/oxlint/src/lsp/options.rs

Comment thread apps/oxlint/src/lsp/options.rs Outdated

Comment thread apps/oxlint/src/lsp/options.rs Outdated

Comment thread apps/oxlint/src/lsp/options.rs Outdated

Sysix force-pushed the 05-02-docs_oxlint_lsp_auto_generate_docs_for_lsp_options branch from c9c328f to f6e4a19 Compare May 2, 2026 19:25

Sysix marked this pull request as ready for review May 2, 2026 19:27

Sysix requested a review from camc314 as a code owner May 2, 2026 19:27

Sysix assigned camc314 May 2, 2026

Sysix added A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation A-editor Area - Editor and Language Server labels May 2, 2026

camc314 approved these changes May 2, 2026

View reviewed changes

camc314 added the 0-merge Merge with Graphite Merge Queue label May 2, 2026

graphite-app Bot force-pushed the 05-02-docs_oxlint_lsp_auto_generate_docs_for_lsp_options branch from f6e4a19 to d58f594 Compare May 2, 2026 20:00

graphite-app Bot merged commit d58f594 into main May 2, 2026
28 checks passed

graphite-app Bot removed the 0-merge Merge with Graphite Merge Queue label May 2, 2026

graphite-app Bot deleted the 05-02-docs_oxlint_lsp_auto_generate_docs_for_lsp_options branch May 2, 2026 20:04

oxc-guard Bot mentioned this pull request May 4, 2026

release(apps): oxlint v1.63.0 && oxfmt v0.48.0 #22109

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(oxlint/lsp): auto generate docs for LSP options#22082

docs(oxlint/lsp): auto generate docs for LSP options#22082
graphite-app[bot] merged 1 commit intomainfrom
05-02-docs_oxlint_lsp_auto_generate_docs_for_lsp_options

Sysix commented May 2, 2026 •

edited

Loading

Uh oh!

Sysix commented May 2, 2026

Uh oh!

codspeed-hq Bot commented May 2, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

camc314 commented May 2, 2026 •

edited by graphite-app Bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Sysix commented May 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request overview

Uh oh!

Sysix commented May 2, 2026

How to use the Graphite Merge Queue

Uh oh!

codspeed-hq Bot commented May 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

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!

Uh oh!

Uh oh!

Uh oh!

camc314 commented May 2, 2026 • 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!

3 participants

Sysix commented May 2, 2026 •

edited

Loading

codspeed-hq Bot commented May 2, 2026 •

edited

Loading

camc314 commented May 2, 2026 •

edited by graphite-app Bot

Loading