Skip to content

Commit 81ea642

Browse files
committed
docs(vscode): Use markdownDescription for better formatting in VSCode 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" />
1 parent 0ade564 commit 81ea642

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

editors/vscode/package.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@
7272
"onType"
7373
],
7474
"default": "onType",
75-
"description": "Run the linter on save (onSave) or on type (onType)"
75+
"markdownDescription": "Run the linter on save (onSave) or on type (onType)"
7676
},
7777
"oxc.enable": {
7878
"type": "boolean",
7979
"default": true,
8080
"scope": "window",
81-
"description": "Enable oxc language server"
81+
"markdownDescription": "Enable oxc language server"
8282
},
8383
"oxc.requireConfig": {
8484
"scope": "resource",
8585
"type": "boolean",
8686
"default": false,
87-
"description": "Start the language server only when a `.oxlintrc.json` file exists in one of the workspaces."
87+
"markdownDescription": "Start the language server only when a `.oxlintrc.json` file exists in one of the workspaces."
8888
},
8989
"oxc.trace.server": {
9090
"type": "string",
@@ -100,7 +100,7 @@
100100
"Full log"
101101
],
102102
"default": "off",
103-
"description": "Traces the communication between VS Code and the language server."
103+
"markdownDescription": "Traces the communication between VS Code and the language server."
104104
},
105105
"oxc.configPath": {
106106
"type": [
@@ -109,7 +109,7 @@
109109
],
110110
"scope": "resource",
111111
"default": null,
112-
"description": "Path to oxlint configuration. Keep it empty to enable nested configuration."
112+
"markdownDescription": "Path to oxlint configuration. Keep it empty to enable nested configuration."
113113
},
114114
"oxc.tsConfigPath": {
115115
"type": [
@@ -118,7 +118,7 @@
118118
],
119119
"scope": "resource",
120120
"default": null,
121-
"description": "Path to TypeScript configuration. If your `tsconfig.json` is not at the root, alias paths will not be resolve correctly for the `import` plugin."
121+
"markdownDescription": "Path to the project's TypeScript config file. \n\nIf your `tsconfig.json` is not at the root, you will need this set for the `import` plugin rules to resolve imports correctly."
122122
},
123123
"oxc.unusedDisableDirectives": {
124124
"type": "string",
@@ -134,19 +134,19 @@
134134
"Deny"
135135
],
136136
"default": "allow",
137-
"description": "Define how directive comments like `// oxlint-disable-line` should be reported, when no errors would have been reported on that line anyway."
137+
"markdownDescription": "Define how directive comments like `// oxlint-disable-line` should be reported, when no errors would have been reported on that line anyway."
138138
},
139139
"oxc.typeAware": {
140140
"type": "boolean",
141141
"scope": "resource",
142142
"default": false,
143-
"description": "Enable type-aware linting."
143+
"markdownDescription": "Enable type-aware linting. Requires the `oxlint-tsgolint` package.\n\n See [the oxc website](https://oxc.rs/docs/guide/usage/linter/type-aware.html) for more information."
144144
},
145145
"oxc.disableNestedConfig": {
146146
"type": "boolean",
147147
"scope": "resource",
148148
"default": false,
149-
"description": "Disable searching for nested configuration files. When set to true, only the configuration file specified in `oxc.configPath` (if any) will be used."
149+
"markdownDescription": "Disable searching for nested configuration files. When set to true, only the configuration file specified in `oxc.configPath` (if any) will be used."
150150
},
151151
"oxc.fixKind": {
152152
"type": "string",
@@ -168,20 +168,20 @@
168168
"All fixes and suggestions will be applied"
169169
],
170170
"default": "safe_fix",
171-
"description": "Specify the kind of fixes to suggest/apply."
171+
"markdownDescription": "Specify the kind of fixes to suggest/apply."
172172
},
173173
"oxc.flags": {
174174
"type": "object",
175175
"scope": "resource",
176176
"default": {},
177-
"deprecationMessage": "deprecated since 1.25.0, use `oxc.fixKind` or `oxc.disableNestedConfig` instead.",
178-
"description": "Specific Oxlint flags to pass to the language server."
177+
"markdownDeprecationMessage": "deprecated since 1.25.0, use `oxc.fixKind` or `oxc.disableNestedConfig` instead.",
178+
"markdownDescription": "Specific Oxlint flags to pass to the language server."
179179
},
180180
"oxc.fmt.experimental": {
181181
"type": "boolean",
182182
"scope": "resource",
183183
"default": false,
184-
"description": "Enable experimental formatting support. This feature is experimental and might not work as expected."
184+
"markdownDescription": "Enable experimental formatting support. This feature is experimental and might not work as expected."
185185
},
186186
"oxc.fmt.configPath": {
187187
"type": [
@@ -190,17 +190,17 @@
190190
],
191191
"scope": "resource",
192192
"default": null,
193-
"description": "Path to an oxfmt configuration file"
193+
"markdownDescription": "Path to an oxfmt configuration file"
194194
},
195195
"oxc.path.server": {
196196
"type": "string",
197197
"scope": "window",
198-
"description": "Path to Oxc language server binary. Mostly for testing the language server."
198+
"markdownDescription": "Path to Oxc language server binary. Mostly for testing the language server."
199199
},
200200
"oxc.path.node": {
201201
"type": "string",
202202
"scope": "window",
203-
"description": "Path to a Node.js binary. Will be added to the language server `PATH` environment."
203+
"markdownDescription": "Path to a Node.js binary. Will be added to the language server `PATH` environment."
204204
}
205205
}
206206
},

0 commit comments

Comments
 (0)