Skip to content

Conversation

@connorshea
Copy link
Collaborator

@connorshea connorshea commented Nov 4, 2025

This bothered me: Screenshot 2025-11-03 at 5 27 07 PM

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 plugins field, which previously had no docs:

Screenshot 2025-11-03 at 7 28 25 PM

Copilot AI review requested due to automatic review settings November 4, 2025 00:37
@connorshea connorshea requested a review from camc314 as a code owner November 4, 2025 00:37
@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 4, 2025

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.

@github-actions github-actions bot added A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation labels Nov 4, 2025
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 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-hq
Copy link

codspeed-hq bot commented Nov 4, 2025

CodSpeed Performance Report

Merging #15246 will not alter performance

Comparing connorshea:fix-env (5f3b95c) with main (ec6721c)

Summary

✅ 4 untouched
⏩ 33 skipped1

Footnotes

  1. 33 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.

Previously it had no hover info in VS Code.
@connorshea connorshea changed the title docs(linter): Avoid linebreaks for markdown links in the configuration schema. docs(linter): Avoid linebreaks for markdown links and update plugins docs in the configuration schema. Nov 4, 2025
@camc314 camc314 merged commit 84ef5ab into oxc-project:main Nov 4, 2025
23 checks passed
@Boshen Boshen mentioned this pull request Nov 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants