Add multiline description support in user snippets

[jamesgeorge007]

Closes #66036

Present scenario

Inorder to show a lot of description, it is required must write a huge string which includes many escape characters the one given below.

"toctree": {
	"prefix": ".. toctree::",
	"body": [
		".. toctree::",
		"$0"
	],
	"description": "A toctree item, have these options:\n\t:maxdepth: para\n\t:caption: para
\n\t:numbered:\n\t:titlesonly:\n\t:glob:\n\t:reversed:\n\t:hidden:\n\t:includehidden:",
	"scope": "text.restructuredtext"
},

Proposed solution

"toctree": {
	"prefix": ".. toctree::",
	"body": [
		".. toctree::",
		"$0"
	],
	"description": [
		"A toctree item, have these options:",
		":maxdepth: para",
		":caption: para",
		":numbered:",
		":titlesonly:",
		":glob:",
		":reversed:",
		":hidden:",
		":includehidden:"
	],
	"scope": "text.restructuredtext"
},

[jrieken]

Please fix strict null error first: yarn run strict-null-check-watch

[jamesgeorge007]

@jrieken It says that string[] can't be assigned to string on line 275 in which the description field is passed as an argument to the Snippet instance.
What's going wrong?

[usernamehw]

What about changing Snippet types to match string | string[]:

vscode/src/vs/workbench/parts/snippets/electron-browser/snippetsFile.ts

Line 28 in c9a3668

readonly description: string,

[usernamehw]

vscode/src/vs/workbench/parts/snippets/electron-browser/snippetsFile.ts

Line 28 in c9a3668

readonly description: string,

Wait, it shouldn't be string | string[]. It should stay the same string. You need to change types, so that new Snippet receives only description with type string.

[jamesgeorge007]

vscode/src/vs/workbench/parts/snippets/electron-browser/snippetsFile.ts

Line 235 in f7890c7

if (Array.isArray(description)) {

@usernamehw Here, the description field is converted to string type just as it is done for body before passing it to the Snippet instance.

[usernamehw]

And here should probably be the same check for description as for body:

vscode/src/vs/workbench/parts/snippets/electron-browser/snippetsFile.ts

Line 239 in f7890c7

if ((typeof prefix !== 'string' && !Array.isArray(prefix)) || typeof body !== 'string') {

if ((typeof prefix !== 'string' && !Array.isArray(prefix)) || typeof body !== 'string' || typeof description !== 'string') {
	return;
}

[jamesgeorge007]

@usernamehw @jrieken Is it fine now?

[jamesgeorge007]

@jrieken Still the Build is failing!

[jrieken]

@jrieken Still the Build is failing!

Yeah, but that was an unrelated issue... Should be fixed in master now - in case you wanna rebase

[jrieken]

What's also needed is to update the schema:

vscode/src/vs/workbench/parts/snippets/electron-browser/snippets.contribution.ts

Lines 52 to 55 in 5aba426

	description: {
	description: nls.localize('snippetSchema.json.description', 'The snippet description.'),
	type: 'string'
	}

[jrieken]

What's also needed is to update the schema:

vscode/src/vs/workbench/parts/snippets/electron-browser/snippets.contribution.ts

Lines 52 to 55 in 5aba426

	description: {
	description: nls.localize('snippetSchema.json.description', 'The snippet description.'),
	type: 'string'
	}

[jamesgeorge007]

@jrieken Hope it's fine now 👍

[jrieken]

lgtm

[jrieken]

lgtm