docs(linter): Avoid linebreaks for markdown links and update plugins docs in the configuration schema.#15246
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via 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. |
There was a problem hiding this comment.
Pull Request Overview
This PR improves the formatting of a documentation string in the OxlintEnv struct by consolidating a markdown link that was previously split across multiple lines.
- Reformatted the ESLint environments documentation link to be on a single line for better readability
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/env.rs | Updated the doc comment formatting for OxlintEnv struct to keep the markdown link on one line |
| crates/oxc_linter/src/snapshots/schema_json.snap | Updated snapshot to reflect the documentation formatting change |
| npm/oxlint/configuration_schema.json | Updated generated JSON schema to reflect the documentation formatting change |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CodSpeed Performance ReportMerging #15246 will not alter performanceComparing Summary
Footnotes
|
Previously it had no hover info in VS Code.
This bothered me:
Although I think this may not fix the problem anyway because we aren't serializing the values in the configuration_schema.json file as
markdownDescription? So VS Code may not render it as markdown anyway.Also updated the docs for the
pluginsfield, which previously had no docs: