docs(vscode): Use markdownDescription for better formatting in VSCode Settings #15889

connorshea · 2025-11-20T00:32:42Z

Also add more context for the type-aware config option.

Before:

After:

graphite-app · 2025-11-20T00:32:48Z

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.}

editors/vscode/package.json

Copilot

Pull Request Overview

This PR improves the VSCode extension settings UI by replacing description fields with markdownDescription to enable better formatting in VSCode Settings. It also enhances the oxc.typeAware configuration option by adding context about the required package and a link to documentation.

Converts all description fields to markdownDescription for consistent formatting support
Adds package requirement and documentation link for the oxc.typeAware setting
Updates deprecationMessage to markdownDeprecationMessage for the oxc.flags setting

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

editors/vscode/package.json

camc314 · 2025-11-21T15:38:39Z

Merge activity

Nov 21, 3:38 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Nov 21, 3:44 PM UTC: camc314 added this pull request to the Graphite merge queue.
Nov 21, 3:52 PM UTC: Merged by the Graphite merge queue.

… Settings (#15889) Also add more context for the type-aware config option. Before: <img width="729" height="163" alt="Screenshot 2025-11-19 at 5 19 08 PM" src="https://github.com/user-attachments/assets/6cc9cbac-cd7f-474c-b464-0a940509d35b" /> After: <img width="703" height="148" alt="Screenshot 2025-11-19 at 5 31 24 PM" src="https://github.com/user-attachments/assets/d2dabb53-f633-4ece-8ec0-e9d00d401ed9" />

# Oxlint ### 💥 BREAKING CHANGES - cbb27fd ast: [**BREAKING**] Add `TSGlobalDeclaration` type (#15712) (overlookmotel) ### 🚀 Features - 72660f7 linter: Support auto generate config document for tuple lint option (#15904) (Duc Nghiem Xuan) - 0c1f82b linter/plugins: Add `tokens` property to `Program` (#16020) (overlookmotel) - 9e61beb linter/plugins: Implement `SourceCode#getFirstToken()` (#16002) (Arsh) - 9a548dd linter/plugins: Implement `SourceCode#getLastTokens()` (#16000) (Arsh) - 0b6cb11 linter/plugins: Implement `SourceCode#getFirstTokens()` (#15976) (Arsh) - 166781e linter/plugins: Implement `SourceCode#getTokenAfter()` (#15973) (Arsh) - 6ae232b linter: Expose type errors via tsgolint (#15917) (camc314) - 2bfdd26 linter/plugins: Implement `SourceCode#getTokensAfter()` (#15971) (Arsh) - 45fffc1 linter/plugins: Implement `SourceCode#getTokenBefore()` (#15956) (Arsh) - 776e473 linter/plugins: Implement `SourceCode#getTokensBefore()` (#15955) (Arsh) - 595867a oxlint: Generate markdownDescription fields for oxlint JSON schema. (#15959) (connorshea) - 5569317 vscode: Add quick actions to status bar tooltip (#15962) (Sysix) - 986cac1 linter/plugins: Token-related `SourceCode` APIs (TS ESLint implementation) (#15861) (Arsh) - a21f9e4 linter: Implement unicorn/prefer-bigint-literals rule (#15923) (Michiel Vrins) - 4b9d8d2 linter/type-aware: Include range with tsconfig diagnostics (#15916) (camc314) - 220d01e editor: Improve the status bar item for the VS Code extension by adding a tooltip. (#15819) (connorshea) ### 🐛 Bug Fixes - 2bd3cb6 apps, editors, napi: Fix `oxlint-disable` comments (#16014) (overlookmotel) - 81f5360 linter/prefer-number-properties: Get fixer to replace entire call expr (#15979) (camc314) - e4ba07f language_server: Always write to memory file system (#15975) (Sysix) - a8a2032 linter: Support missing `range` for internal diagnostics (#15964) (camc314) - 619a226 oxlint/lsp: Don't register `textDocument/formatting` capability (#15882) (Sysix) - 6ab1a20 linter: Fix no_useless_spread producing invalid syntax when removing empty object spreads (#15905) (camc314) - be4b6df linter: Unicorn/prefer-string-replace-all incorrectly escapes backslashes (#15901) (camc314) - 9fa9ef2 linter: Gracefully fail when using import plugin, large file counf and JS plugins (#15864) (camc314) - c027398 linter/plugins: Correct bindings package names glob in TSDown config (#15871) (overlookmotel) - b622ef8 linter: Fix `oxc/bad_array_method_on_arguments` rule behavior. (#15854) (connorshea) - aa06c3f linter: Recognize NewExpression as value context in no-unused-private-class-members (#15843) (camc314) - e89c5ba typescript/prefer-namespace-keyword: Skip nested `TSModuleDeclaration`s (#15806) (overlookmotel) - 646d020 linter/exhaustive-dependencies: Prevent is_callee_of_call_expr flag from leaking into nested expressions (#15832) (camc314) - 46bd6bd linter/plugins: Pin `@typescript-eslint/scope-manager` dependency (#15807) (overlookmotel) - fba31fa linter: Patch `@typescript-eslint/scope manager` (#15214) (Arsh) - 50307c1 linter/jest: Ignore `expect` identifier in argument position (#15785) (camc314) ### ⚡ Performance - 024b48a linter/plugins: Lazy-load tokens parsing code (#16011) (overlookmotel) - 15365c9 linter/plugins: Reduce var assignments (#15953) (overlookmotel) - 84d1f4f linter/plugins: Downgrade some checks to debug-only (#15922) (overlookmotel) - a49f704 linter/typescript: Avoid searching source text unless required (#15805) (overlookmotel) ### 📚 Documentation - ceffa5a linter: Add config option docs for various rules. (#16024) (connorshea) - 9a0ed13 linter: Fix config option docs for eslint/operator-assignment rule. (#16030) (connorshea) - 0b18005 linter: Add config docs generation for rules with Regex arguments (#15978) (connorshea) - 48d18e0 linter: Improve diagnostic message for promise/catch-or-return rule (#15980) (connorshea) - 6c72e84 linter: Use backticks for code elements across more rule diagnostics (#15958) (connorshea) - a63dad7 linter/plugins: Add comment (#15952) (overlookmotel) - 81ea642 vscode: Use markdownDescription for better formatting in VSCode Settings (#15889) (connorshea) - db6a110 linter/plugins: Fix JSDoc comment (#15884) (overlookmotel) - 1487271 linter: Add config option docs for `jsdoc/require-param` and `jsdoc/require-returns` rules (#15857) (connorshea) - fbf0fd4 linter/plugins: Add JSDoc comments to `Plugin` and `Rule` types (#15815) (overlookmotel) - ac5e4b5 linter/plugins: Add JSDoc comments and improve comments (#15814) (overlookmotel) - 9b7b083 linter: Fix error in `curly` `"all"` example (#15801) (camc314) - 65a3520 linter: Improve diagnostic for consistent-type-definitions rule. (#15752) (connorshea) ### 🛡️ Security - f9b9276 deps: Update dependency rolldown to v1.0.0-beta.51 (#15856) (renovate[bot]) # Oxfmt ### 💥 BREAKING CHANGES - a937890 formatter: [**BREAKING**] Default to `lineWidth: 100` (#15933) (leaysgur) - 03d5f5a formatter/sort-imports: [**BREAKING**] Change default order to `natural` with `natord` crate (#15828) (leaysgur) - cbb27fd ast: [**BREAKING**] Add `TSGlobalDeclaration` type (#15712) (overlookmotel) ### 🚀 Features - 7818e22 formatter/sort-imports: Support `options.groups` (#15831) (leaysgur) - f9a502c oxfmt: `oxfmt --lsp` support (#15765) (leaysgur) ### 🐛 Bug Fixes - 4817486 formatter: Revert `FormatElement::BestFitting` printing logic (#16028) (Dunqing) - 5562dd6 formatter: Incorrect formatting method chain with trailing comments (#16027) (Dunqing) - 6d14c8b formatter: Comments in export class decorators are printing incorrectly (#15897) (Dunqing) - 683c764 formatter: Correct a few minor mismatched typescript tests (#15894) (Dunqing) - c11cc07 formatter: Improve formatting for default type on type parameters (#15893) (Dunqing) - 0bff596 formatter: Handle JSX expresssion dangling comment (#15890) (leaysgur) - 16a9dc8 formatter: Inconsistent printing of class extends and interface extends (#15892) (Dunqing) - 300b496 formatter: Inconsistent CallExpression and NewExpression around member chain and logical expression (#15858) (Dunqing) ### ⚡ Performance - 65174cc formatter: Reduce the size of `TextWidth` to 4 byte (#15827) (Dunqing) - 4fe3aac formatter: Use `ArenaVec` and `ArenaBox` (#15420) (Dunqing) Co-authored-by: overlookmotel <557937+overlookmotel@users.noreply.github.com>

Copilot AI review requested due to automatic review settings November 20, 2025 00:32

connorshea requested a review from camc314 as a code owner November 20, 2025 00:32

github-actions bot added the A-editor Area - Editor and Language Server label Nov 20, 2025

connorshea requested review from Sysix and removed request for camc314 and Copilot November 20, 2025 00:32

github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Nov 20, 2025

Copilot started reviewing on behalf of connorshea November 20, 2025 00:33 View session

connorshea requested review from camc314 and Copilot November 20, 2025 00:33

Copilot started reviewing on behalf of connorshea November 20, 2025 00:33 View session

connorshea commented Nov 20, 2025

View reviewed changes

editors/vscode/package.json Outdated Show resolved Hide resolved

Copilot finished reviewing on behalf of connorshea November 20, 2025 00:33

Copilot finished reviewing on behalf of connorshea November 20, 2025 00:34

Copilot AI reviewed Nov 20, 2025

View reviewed changes

editors/vscode/package.json Show resolved Hide resolved

Sysix approved these changes Nov 20, 2025

View reviewed changes

connorshea requested a review from Sysix November 20, 2025 00:59

Sysix reviewed Nov 21, 2025

View reviewed changes

editors/vscode/package.json Outdated Show resolved Hide resolved

camc314 force-pushed the md-description-in-vscode-package branch from 19a8c86 to 84210f2 Compare November 21, 2025 15:38

camc314 approved these changes Nov 21, 2025

View reviewed changes

camc314 added the 0-merge Merge with Graphite Merge Queue label Nov 21, 2025

camc314 self-assigned this Nov 21, 2025

graphite-app bot force-pushed the md-description-in-vscode-package branch from 84210f2 to 81ea642 Compare November 21, 2025 15:48

graphite-app bot merged commit 81ea642 into main Nov 21, 2025
19 checks passed

graphite-app bot deleted the md-description-in-vscode-package branch November 21, 2025 15:52

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Nov 21, 2025

Boshen mentioned this pull request Nov 24, 2025

release(apps): oxlint v1.30.0 && oxfmt v0.15.0 #16039

Closed

Boshen mentioned this pull request Nov 24, 2025

release(apps): oxlint v1.30.0 && oxfmt v0.15.0 #16047

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(vscode): Use markdownDescription for better formatting in VSCode Settings #15889

docs(vscode): Use markdownDescription for better formatting in VSCode Settings #15889

Uh oh!

connorshea commented Nov 20, 2025

Uh oh!

graphite-app bot commented Nov 20, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

camc314 commented Nov 21, 2025 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

docs(vscode): Use markdownDescription for better formatting in VSCode Settings #15889

docs(vscode): Use markdownDescription for better formatting in VSCode Settings #15889

Uh oh!

Conversation

connorshea commented Nov 20, 2025

Uh oh!

graphite-app bot commented Nov 20, 2025

How to use the Graphite Merge Queue

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

camc314 commented Nov 21, 2025 • 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!

4 participants

camc314 commented Nov 21, 2025 •

edited by graphite-app bot

Loading