|
72 | 72 | "onType" |
73 | 73 | ], |
74 | 74 | "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)" |
76 | 76 | }, |
77 | 77 | "oxc.enable": { |
78 | 78 | "type": "boolean", |
79 | 79 | "default": true, |
80 | 80 | "scope": "window", |
81 | | - "description": "Enable oxc language server" |
| 81 | + "markdownDescription": "Enable oxc language server" |
82 | 82 | }, |
83 | 83 | "oxc.requireConfig": { |
84 | 84 | "scope": "resource", |
85 | 85 | "type": "boolean", |
86 | 86 | "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." |
88 | 88 | }, |
89 | 89 | "oxc.trace.server": { |
90 | 90 | "type": "string", |
|
100 | 100 | "Full log" |
101 | 101 | ], |
102 | 102 | "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." |
104 | 104 | }, |
105 | 105 | "oxc.configPath": { |
106 | 106 | "type": [ |
|
109 | 109 | ], |
110 | 110 | "scope": "resource", |
111 | 111 | "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." |
113 | 113 | }, |
114 | 114 | "oxc.tsConfigPath": { |
115 | 115 | "type": [ |
|
118 | 118 | ], |
119 | 119 | "scope": "resource", |
120 | 120 | "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." |
122 | 122 | }, |
123 | 123 | "oxc.unusedDisableDirectives": { |
124 | 124 | "type": "string", |
|
134 | 134 | "Deny" |
135 | 135 | ], |
136 | 136 | "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." |
138 | 138 | }, |
139 | 139 | "oxc.typeAware": { |
140 | 140 | "type": "boolean", |
141 | 141 | "scope": "resource", |
142 | 142 | "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." |
144 | 144 | }, |
145 | 145 | "oxc.disableNestedConfig": { |
146 | 146 | "type": "boolean", |
147 | 147 | "scope": "resource", |
148 | 148 | "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." |
150 | 150 | }, |
151 | 151 | "oxc.fixKind": { |
152 | 152 | "type": "string", |
|
168 | 168 | "All fixes and suggestions will be applied" |
169 | 169 | ], |
170 | 170 | "default": "safe_fix", |
171 | | - "description": "Specify the kind of fixes to suggest/apply." |
| 171 | + "markdownDescription": "Specify the kind of fixes to suggest/apply." |
172 | 172 | }, |
173 | 173 | "oxc.flags": { |
174 | 174 | "type": "object", |
175 | 175 | "scope": "resource", |
176 | 176 | "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." |
179 | 179 | }, |
180 | 180 | "oxc.fmt.experimental": { |
181 | 181 | "type": "boolean", |
182 | 182 | "scope": "resource", |
183 | 183 | "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." |
185 | 185 | }, |
186 | 186 | "oxc.fmt.configPath": { |
187 | 187 | "type": [ |
|
190 | 190 | ], |
191 | 191 | "scope": "resource", |
192 | 192 | "default": null, |
193 | | - "description": "Path to an oxfmt configuration file" |
| 193 | + "markdownDescription": "Path to an oxfmt configuration file" |
194 | 194 | }, |
195 | 195 | "oxc.path.server": { |
196 | 196 | "type": "string", |
197 | 197 | "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." |
199 | 199 | }, |
200 | 200 | "oxc.path.node": { |
201 | 201 | "type": "string", |
202 | 202 | "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." |
204 | 204 | } |
205 | 205 | } |
206 | 206 | }, |
|
0 commit comments