Skip to content

Commit 1b0bab5

Browse files
angelozerrangelozerr
committed
Add wiki Link for settings
Fixes #322 Signed-off-by: azerr <azerr@redhat.com>
1 parent 5d378b7 commit 1b0bab5

File tree

2 files changed

+113
-131
lines changed

2 files changed

+113
-131
lines changed

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,9 @@ The following settings are supported:
8080
* `xml.symbols.maxItemsComputed`: The maximum number of outline symbols and folding regions computed (limited for performance reasons). Default is `5000`.
8181
* `xml.codeLens.enabled`: Enable/disable XML CodeLens. Default is `false`.
8282
* `xml.symbols.excluded`: Disable document symbols (Outline) for the given file name patterns. Updating file name patterns does not automatically reload the Outline view for the relevant file(s). Each file must either be reopened or changed, in order to trigger an Outline view reload.
83-
* `files.trimTrailingWhitespace`: Now affects XML formatting. Enable/disable trailing whitespace trimming when formatting an XML document. Default is `false`.
84-
85-
Since 0.14.0:
8683

87-
* `xml.format.xsiSchemaLocationSplit`: Split `xsi:schemaLocation` content. Default is `none`.
84+
Since 0.13.0:
85+
* `files.trimTrailingWhitespace`: Now affects XML formatting. Enable/disable trailing whitespace trimming when formatting an XML document. Default is `false`.
8886

8987
## Articles
9088

‎package.json‎

Lines changed: 111 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,30 @@
8080
"type": "object",
8181
"title": "XML configuration",
8282
"properties": {
83+
"xml.java.home": {
84+
"type": [
85+
"string",
86+
"null"
87+
],
88+
"default": null,
89+
"markdownDescription": "Specifies the folder path to the JDK (8 or more recent) used to launch the XML Language Server.\nOn Windows, backslashes must be escaped, i.e.\n`\"xml.java.home\": \"C:\\\\Program Files\\\\Java\\\\jdk1.8.0_161\"`",
90+
"scope": "window"
91+
},
92+
"xml.server.vmargs": {
93+
"type": [
94+
"string",
95+
"null"
96+
],
97+
"default": "-Xmx64M -XX:+UseG1GC -XX:+UseStringDeduplication",
98+
"markdownDescription": "Specifies extra VM arguments used to launch the XML Language Server. Eg. use `-Xmx1G -XX:+UseG1GC -XX:+UseStringDeduplication` to bypass class verification, increase the heap size to 1GB and enable String deduplication with the G1 Garbage collector.",
99+
"scope": "window"
100+
},
101+
"xml.server.workDir": {
102+
"type": "string",
103+
"default": "~/.lemminx",
104+
"markdownDescription": "Set a custom folder path for cached XML Schemas. An absolute path is expected, although the ~ prefix (for the user home directory) is supported. Default is `~/.lemminx`.",
105+
"scope": "window"
106+
},
83107
"xml.trace.server": {
84108
"type": "string",
85109
"enum": [
@@ -88,22 +112,51 @@
88112
"verbose"
89113
],
90114
"default": "off",
91-
"description": "Traces the communication between VS Code and the XML language server.",
115+
"markdownDescription": "Traces the communication between VS Code and the XML language server. Default is `off`.",
92116
"scope": "window"
93117
},
118+
"xml.logs.client": {
119+
"type": "boolean",
120+
"default": true,
121+
"markdownDescription": "Should the server log to client output. Default is `true`."
122+
},
94123
"xml.catalogs": {
95124
"type": "array",
96125
"default": [],
97126
"items": {
98127
"type": "string"
99128
},
100-
"description": "Array of XML Catalogs.",
129+
"markdownDescription": "Array of XML Catalogs. See how to configure [XML catalog with XSD](https://github.com/redhat-developer/vscode-xml/wiki/XMLValidation#xml-catalog-with-xsd) or [XML catalog with DTD](https://github.com/redhat-developer/vscode-xml/wiki/XMLValidation#xml-catalog-with-dtd) for more information",
101130
"scope": "window"
102131
},
103-
"xml.logs.client": {
132+
"xml.fileAssociations": {
133+
"type": "array",
134+
"default": [],
135+
"items": {
136+
"type": "object",
137+
"properties": {
138+
"systemId": {
139+
"type": "string",
140+
"description": "The path or URL to the XML schema (XSD or DTD)."
141+
},
142+
"pattern": {
143+
"type": "string",
144+
"markdownDescription": "File glob pattern. Example: `**/*.Format.ps1xml`\n\nMore information on the glob syntax: https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"
145+
}
146+
},
147+
"required": [
148+
"systemId",
149+
"pattern"
150+
]
151+
},
152+
"markdownDescription": "Allows XML schemas to be associated to file name patterns.\n\nExample:\n```json\n[{\n \"systemId\": \"path/to/file.xsd\",\n \"pattern\": \"file1.xml\"\n},\n{\n \"systemId\": \"http://www.w3.org/2001/XMLSchema.xsd\",\n \"pattern\": \"**/*.xsd\"\n}]\n```",
153+
"scope": "window"
154+
},
155+
"xml.format.enabled": {
104156
"type": "boolean",
105157
"default": true,
106-
"description": "Should the server log to client output."
158+
"markdownDescription": "Enable/disable ability to format document. Default is `true`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatenabled-) for more information.",
159+
"scope": "window"
107160
},
108161
"xml.format.emptyElements": {
109162
"type": "string",
@@ -113,49 +166,53 @@
113166
"expand"
114167
],
115168
"default": "ignore",
116-
"description": "Expand/collapse empty elements.",
169+
"markdownDescription": "Expand/collapse empty elements. Default is `ignore`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatemptyelements) for more information.",
117170
"scope": "window"
118171
},
119-
"xml.format.preserveAttributeLineBreaks": {
120-
"type": "boolean",
121-
"default": false,
122-
"markdownDescription": "Preserve line breaks that appear before and after attributes. This setting is overridden if `#xml.format.splitAttributes#` is set to `true`.",
123-
"scope": "window"
124-
},
125-
"xml.format.splitAttributes": {
126-
"type": "boolean",
127-
"default": false,
128-
"description": "Split multiple attributes each onto a new line.",
172+
"xml.format.enforceQuoteStyle": {
173+
"type": "string",
174+
"enum": [
175+
"preferred",
176+
"ignore"
177+
],
178+
"markdownEnumDescriptions": [
179+
"Use preferred quote style set by `xml.preferences.quoteStyle` when formatting.",
180+
"Ignore quote style formatting."
181+
],
182+
"default": "ignore",
183+
"markdownDescription":
184+
"Enforce `preferred` quote style (set by `#xml.preferences.quoteStyle#`) or `ignore` quote style when formatting. Default is `ignore`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatenforcequotestyle) for more information."
185+
,
129186
"scope": "window"
130187
},
131188
"xml.format.joinCDATALines": {
132189
"type": "boolean",
133190
"default": false,
134-
"description": "Join lines in a CDATA tag's content.",
191+
"markdownDescription": "Join lines in a CDATA tag's content. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincdatalines-) for more information.",
135192
"scope": "window"
136193
},
137194
"xml.format.joinCommentLines": {
138195
"type": "boolean",
139196
"default": false,
140-
"description": "Join comment content on format.",
197+
"markdownDescription": "Join comment content on format. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincommentlines-) for more information.",
141198
"scope": "window"
142199
},
143-
"xml.format.spaceBeforeEmptyCloseTag": {
200+
"xml.format.joinContentLines": {
144201
"type": "boolean",
145-
"default": true,
146-
"description": "Insert space before end of self closing tag. \nExample:\n <tag/> -> <tag />",
202+
"default": false,
203+
"markdownDescription": "Normalize the whitespace of content inside an element. Newlines and excess whitespace are removed. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatjoincontentlines) for more information.",
147204
"scope": "window"
148205
},
149-
"xml.format.joinContentLines": {
206+
"xml.format.preserveAttributeLineBreaks": {
150207
"type": "boolean",
151208
"default": false,
152-
"description": "Normalize the whitespace of content inside an element. Newlines and excess whitespace are removed.",
209+
"markdownDescription": "Preserve line breaks that appear before and after attributes. This setting is overridden if `#xml.format.splitAttributes#` is set to `true`. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatpreserveattributelinebreaks) for more information.",
153210
"scope": "window"
154211
},
155212
"xml.format.preserveEmptyContent": {
156213
"type": "boolean",
157214
"default": false,
158-
"description": "Preserve empty content/whitespace in a tag.",
215+
"markdownDescription": "Preserve empty content/whitespace in a tag. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatpreserveemptycontent-) for more information.",
159216
"scope": "window"
160217
},
161218
"xml.format.preservedNewlines": {
@@ -167,43 +224,19 @@
167224
3
168225
],
169226
"default": 2,
170-
"description": "Preserve new lines that separate tags. The value represents the maximum number of new lines per section. A value of 0 removes all new lines.",
227+
"markdownDescription": "Preserve new lines that separate tags. The value represents the maximum number of new lines per section. A value of 0 removes all new lines. Default is `2`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatpreservednewlines) for more information.",
171228
"scope": "window"
172229
},
173-
"xml.format.enabled": {
230+
"xml.format.spaceBeforeEmptyCloseTag": {
174231
"type": "boolean",
175232
"default": true,
176-
"description": "Enable/disable ability to format document.",
177-
"scope": "window"
178-
},
179-
"xml.format.enforceQuoteStyle": {
180-
"type": "string",
181-
"enum": [
182-
"preferred",
183-
"ignore"
184-
],
185-
"markdownEnumDescriptions": [
186-
"Use preferred quote style set by `xml.preferences.quoteStyle` when formatting.",
187-
"Ignore quote style formatting."
188-
],
189-
"default": "ignore",
190-
"markdownDescription": "Enforce `preferred` quote style (set by `#xml.preferences.quoteStyle#`) or `ignore` quote style when formatting. Default is `ignore`",
233+
"markdownDescription": "Insert space before end of self closing tag. \nExample:\n ```<tag/> -> <tag />```. Default is `true`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatspacebeforeemptyclosetag-) for more information.",
191234
"scope": "window"
192235
},
193-
"xml.format.xsiSchemaLocationSplit": {
194-
"type": "string",
195-
"enum": [
196-
"onNamespace",
197-
"onLocation",
198-
"none"
199-
],
200-
"markdownEnumDescriptions": [
201-
"Split `xsi:schemaLocation` content after each namespace declaration",
202-
"Split `xsi:schemaLocation` content after each location declaration",
203-
"Ignore `xsi:schemaLocation` content formatting."
204-
],
205-
"default": "none",
206-
"markdownDescription": "Split `xsi:schemaLocation` content. Default is `none`",
236+
"xml.format.splitAttributes": {
237+
"type": "boolean",
238+
"default": false,
239+
"markdownDescription": "Split multiple attributes each onto a new line. Default is `false`. See [here](https://github.com/redhat-developer/vscode-xml/wiki/Formatting#xmlformatsplitattributes-) for more information.",
207240
"scope": "window"
208241
},
209242
"xml.preferences.quoteStyle": {
@@ -213,44 +246,19 @@
213246
"double"
214247
],
215248
"default": "double",
216-
"markdownDescription": "Preferred quote style to use for completion: `single` quotes, `double` quotes.",
217-
"scope": "window"
218-
},
219-
"xml.fileAssociations": {
220-
"type": "array",
221-
"default": [],
222-
"items": {
223-
"type": "object",
224-
"properties": {
225-
"systemId": {
226-
"type": "string",
227-
"description": "The path or URL to the XML schema (XSD or DTD)."
228-
},
229-
"pattern": {
230-
"type": "string",
231-
"description": "File glob pattern. Example: **/*.Format.ps1xml\n\nMore information on the glob syntax: https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob",
232-
"markdownDescription": "File glob pattern. Example: `**/*.Format.ps1xml`\n\nMore information on the glob syntax: https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"
233-
}
234-
},
235-
"required": [
236-
"systemId",
237-
"pattern"
238-
]
239-
},
240-
"description": "Allows XML schemas to be associated to file name patterns.\n\nExample:\n[{\n \"systemId\": \"path/to/file.xsd\",\n \"pattern\": \"file1.xml\"\n},\n{\n \"systemId\": \"http://www.w3.org/2001/XMLSchema.xsd\",\n \"pattern\": \"**/*.xsd\"\n}]",
241-
"markdownDescription": "Allows XML schemas to be associated to file name patterns.\n\nExample:\n```json\n[{\n \"systemId\": \"path/to/file.xsd\",\n \"pattern\": \"file1.xml\"\n},\n{\n \"systemId\": \"http://www.w3.org/2001/XMLSchema.xsd\",\n \"pattern\": \"**/*.xsd\"\n}]\n```",
249+
"markdownDescription": "Preferred quote style to use for completion: `single` quotes, `double` quotes. Default is `double`.",
242250
"scope": "window"
243251
},
244252
"xml.completion.autoCloseTags": {
245253
"type": "boolean",
246254
"default": true,
247-
"description": "Enable/disable autoclosing of XML tags. \n\nIMPORTANT: Turn off editor.autoClosingTags for this to work.",
255+
"markdownDescription": "Enable/disable autoclosing of XML tags. Default is `true`. \n\nIMPORTANT: Turn off `#editor.autoClosingTags#` for this to work.",
248256
"scope": "window"
249257
},
250258
"xml.codeLens.enabled": {
251259
"type": "boolean",
252260
"default": false,
253-
"description": "Enable/disable XML CodeLens."
261+
"description": "Enable/disable XML CodeLens. Default is `false`."
254262
},
255263
"xml.preferences.showSchemaDocumentationType": {
256264
"type": "string",
@@ -267,74 +275,50 @@
267275
"Documentation comes from the `xs:documentation` and `xs:appinfo` elements.",
268276
"Displays no documentation."
269277
],
270-
"description": "Specifies the source of the XML schema documentation displayed on hover and completion.",
271-
"scope": "window"
272-
},
273-
"xml.java.home": {
274-
"type": [
275-
"string",
276-
"null"
277-
],
278-
"default": null,
279-
"description": "Specifies the folder path to the JDK (8 or more recent) used to launch the XML Language Server.\nOn Windows, backslashes must be escaped, i.e.\n\"xml.java.home\": \"C:\\\\Program Files\\\\Java\\\\jdk1.8.0_161\"",
280-
"scope": "window"
281-
},
282-
"xml.server.vmargs": {
283-
"type": [
284-
"string",
285-
"null"
286-
],
287-
"default": "-Xmx64M -XX:+UseG1GC -XX:+UseStringDeduplication",
288-
"description": "Specifies extra VM arguments used to launch the XML Language Server. Eg. use `-Xmx1G -XX:+UseG1GC -XX:+UseStringDeduplication` to bypass class verification, increase the heap size to 1GB and enable String deduplication with the G1 Garbage collector.",
289-
"scope": "window"
290-
},
291-
"xml.server.workDir": {
292-
"type": "string",
293-
"default": "~/.lemminx",
294-
"description": "Set a custom folder path for cached XML Schemas. An absolute path is expected, although the ~ prefix (for the user home directory) is supported.",
295-
"scope": "window"
296-
},
297-
"xml.validation.noGrammar": {
298-
"type": "string",
299-
"enum": [
300-
"ignore",
301-
"hint",
302-
"info",
303-
"warning",
304-
"error"
305-
],
306-
"default": "hint",
307-
"description": "The message severity when a document has no associated grammar.",
278+
"markdownDescription": "Specifies the source of the XML schema documentation displayed on hover and completion. Default is `all`.",
308279
"scope": "window"
309280
},
310281
"xml.validation.enabled": {
311282
"type": "boolean",
312283
"default": true,
313-
"description": "Enable/disable all validation.",
284+
"markdownDescription": "Enable/disable all validation. Default is `true`.",
314285
"scope": "window"
315286
},
316287
"xml.validation.schema": {
317288
"type": "boolean",
318289
"default": true,
319-
"description": "Enable/disable schema based validation. Ignored if \"xml.validation.enabled\": false.",
290+
"markdownDescription": "Enable/disable schema based validation. Default is `true`. Ignored if `#xml.validation.enabled#` is set to `false`",
320291
"scope": "window"
321292
},
322293
"xml.validation.disallowDocTypeDecl": {
323294
"type": "boolean",
324295
"default": false,
325-
"description": "Enable/disable if a fatal error is thrown if the incoming document contains a DOCTYPE declaration.",
296+
"markdownDescription": "Enable/disable if a fatal error is thrown if the incoming document contains a DOCTYPE declaration. Default is `false`.",
326297
"scope": "window"
327298
},
328299
"xml.validation.resolveExternalEntities": {
329300
"type": "boolean",
330301
"default": false,
331-
"description": "Enable/disable resolve of external entities.",
302+
"markdownDescription": "Enable/disable resolve of external entities. Default is `true`.",
303+
"scope": "window"
304+
},
305+
"xml.validation.noGrammar": {
306+
"type": "string",
307+
"enum": [
308+
"ignore",
309+
"hint",
310+
"info",
311+
"warning",
312+
"error"
313+
],
314+
"default": "hint",
315+
"markdownDescription": "The message severity when a document has no associated grammar. Default is `hint`.",
332316
"scope": "window"
333317
},
334318
"xml.symbols.enabled": {
335319
"type": "boolean",
336320
"default": true,
337-
"description": "Enable/disable document symbols (Outline). No symbols are given if `\"xml.symbol.enabled\": false`.",
321+
"markdownDescription": "Enable/disable document symbols (Outline). Default is `true`. No symbols are given if `\"xml.symbol.enabled\": false`.",
338322
"scope": "window"
339323
},
340324
"xml.symbols.excluded": {
@@ -343,13 +327,13 @@
343327
"items": {
344328
"type": "string"
345329
},
346-
"description": "Disable document symbols (Outline) for the given file name patterns. Updating file name patterns does not automatically reload the Outline view for the relevant file(s). Each file must either be reopened or changed, in order to trigger an Outline view reload.\n\nExample:\n[\n \"**/*LargeFile.xml\"\n]",
330+
"markdownDescription": "Disable document symbols (Outline) for the given file name patterns. Updating file name patterns does not automatically reload the Outline view for the relevant file(s). Each file must either be reopened or changed, in order to trigger an Outline view reload.\n\nExample:\n```\n[\n \"**/*LargeFile.xml\"\n]```.",
347331
"scope": "window"
348332
},
349333
"xml.symbols.maxItemsComputed": {
350334
"type": "integer",
351335
"default": 5000,
352-
"description": "The maximum number of outline symbols and folding regions computed (limited for performance reasons)."
336+
"markdownDescription": "The maximum number of outline symbols and folding regions computed (limited for performance reasons). Default is `5000`."
353337
}
354338
}
355339
},

0 commit comments

Comments
 (0)
⚡