Add basic pinning test for jsdoc completions

For #82874

extensions/typescript-language-features/src/test/completions.test.ts

@@ -7,6 +7,8 @@ import * as assert from 'assert';
 import 'mocha';
 import * as vscode from 'vscode';
 import { disposeAll } from '../utils/dispose';
+import { createTestEditor, joinLines, wait } from './testUtils';
+import { acceptFirstSuggestion, typeCommitCharacter } from './suggestTestHelpers';
 
 const testDocumentUri = vscode.Uri.parse('untitled:test.ts');
 
@@ -292,71 +294,3 @@ suite('TypeScript Completions', () => {
 	});
 });
 
-const joinLines = (...args: string[]) => args.join('\n');
-
-const wait = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
-
-async function acceptFirstSuggestion(uri: vscode.Uri, _disposables: vscode.Disposable[], options?: { useLineRange?: boolean }) {
-	const didChangeDocument = onChangedDocument(uri, _disposables);
-	const didSuggest = onDidSuggest(_disposables, options);
-	await vscode.commands.executeCommand('editor.action.triggerSuggest');
-	await didSuggest;
-	// TODO: depends on reverting fix for https://github.com/Microsoft/vscode/issues/64257
-	// Make sure we have time to resolve the suggestion because `acceptSelectedSuggestion` doesn't
-	await wait(40);
-	await vscode.commands.executeCommand('acceptSelectedSuggestion');
-	return await didChangeDocument;
-}
-
-async function typeCommitCharacter(uri: vscode.Uri, character: string, _disposables: vscode.Disposable[]) {
-	const didChangeDocument = onChangedDocument(uri, _disposables);
-	const didSuggest = onDidSuggest(_disposables);
-	await vscode.commands.executeCommand('editor.action.triggerSuggest');
-	await didSuggest;
-	await vscode.commands.executeCommand('type', { text: character });
-	return await didChangeDocument;
-}
-
-function onChangedDocument(documentUri: vscode.Uri, disposables: vscode.Disposable[]) {
-	return new Promise<vscode.TextDocument>(resolve => vscode.workspace.onDidChangeTextDocument(e => {
-		if (e.document.uri.toString() === documentUri.toString()) {
-			resolve(e.document);
-		}
-	}, undefined, disposables));
-}
-
-async function createTestEditor(uri: vscode.Uri, ...lines: string[]) {
-	const document = await vscode.workspace.openTextDocument(uri);
-	await vscode.window.showTextDocument(document);
-	const activeEditor = vscode.window.activeTextEditor;
-	if (!activeEditor) {
-		throw new Error('no active editor');
-	}
-
-	await activeEditor.insertSnippet(new vscode.SnippetString(joinLines(...lines)), new vscode.Range(0, 0, 1000, 0));
-}
-
-function onDidSuggest(disposables: vscode.Disposable[], options?: { useLineRange?: boolean }) {
-	return new Promise(resolve =>
-		disposables.push(vscode.languages.registerCompletionItemProvider('typescript', new class implements vscode.CompletionItemProvider {
-			provideCompletionItems(doc: vscode.TextDocument, position: vscode.Position): vscode.ProviderResult<vscode.CompletionItem[] | vscode.CompletionList> {
-				// Return a fake item that will come first
-				const range = options && options.useLineRange
-					? new vscode.Range(new vscode.Position(position.line, 0), position)
-					: doc.getWordRangeAtPosition(position);
-				return [{
-					label: '🦄',
-					insertText: doc.getText(range),
-					filterText: doc.getText(range),
-					preselect: true,
-					sortText: '\0',
-					range: range
-				}];
-			}
-			async resolveCompletionItem(item: vscode.CompletionItem) {
-				await vscode.commands.executeCommand('selectNextSuggestion');
-				resolve();
-				return item;
-			}
-		})));
-}
\ No newline at end of file

extensions/typescript-language-features/src/test/jsDocCompletions.test.ts

+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as assert from 'assert';
+import 'mocha';
+import * as vscode from 'vscode';
+import { disposeAll } from '../utils/dispose';
+import { createTestEditor, joinLines, wait } from './testUtils';
+import { acceptFirstSuggestion } from './suggestTestHelpers';
+
+const testDocumentUri = vscode.Uri.parse('untitled:test.ts');
+
+suite('JSDoc Completions', () => {
+	const _disposables: vscode.Disposable[] = [];
+
+	setup(async () => {
+		await wait(100);
+	});
+
+	teardown(async () => {
+		disposeAll(_disposables);
+	});
+
+	test('Should complete jsdoc inside single line comment', async () => {
+		await createTestEditor(testDocumentUri,
+			`/**$0 */`,
+			`function abcdef(x, y) { }`,
+		);
+
+		const document = await acceptFirstSuggestion(testDocumentUri, _disposables, { useLineRange: true});
+		assert.strictEqual(
+			document.getText(),
+			joinLines(
+				`/**`,
+				` *`,
+				` * @param {*} x `,
+				` * @param {*} y `,
+				` */`,
+				`function abcdef(x, y) { }`,
+			));
+	});
+});

extensions/typescript-language-features/src/test/suggestTestHelpers.ts

+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import 'mocha';
+import * as vscode from 'vscode';
+import { wait } from './testUtils';
+
+export async function acceptFirstSuggestion(uri: vscode.Uri, _disposables: vscode.Disposable[], options?: { useLineRange?: boolean }) {
+	const didChangeDocument = onChangedDocument(uri, _disposables);
+	const didSuggest = onDidSuggest(_disposables, options);
+	await vscode.commands.executeCommand('editor.action.triggerSuggest');
+	await didSuggest;
+	// TODO: depends on reverting fix for https://github.com/Microsoft/vscode/issues/64257
+	// Make sure we have time to resolve the suggestion because `acceptSelectedSuggestion` doesn't
+	await wait(40);
+	await vscode.commands.executeCommand('acceptSelectedSuggestion');
+	return await didChangeDocument;
+}
+
+export async function typeCommitCharacter(uri: vscode.Uri, character: string, _disposables: vscode.Disposable[]) {
+	const didChangeDocument = onChangedDocument(uri, _disposables);
+	const didSuggest = onDidSuggest(_disposables);
+	await vscode.commands.executeCommand('editor.action.triggerSuggest');
+	await didSuggest;
+	await vscode.commands.executeCommand('type', { text: character });
+	return await didChangeDocument;
+}
+
+export function onChangedDocument(documentUri: vscode.Uri, disposables: vscode.Disposable[]) {
+	return new Promise<vscode.TextDocument>(resolve => vscode.workspace.onDidChangeTextDocument(e => {
+		if (e.document.uri.toString() === documentUri.toString()) {
+			resolve(e.document);
+		}
+	}, undefined, disposables));
+}
+
+
+function onDidSuggest(disposables: vscode.Disposable[], options?: { useLineRange?: boolean }) {
+	return new Promise(resolve =>
+		disposables.push(vscode.languages.registerCompletionItemProvider('typescript', new class implements vscode.CompletionItemProvider {
+			provideCompletionItems(doc: vscode.TextDocument, position: vscode.Position): vscode.ProviderResult<vscode.CompletionItem[] | vscode.CompletionList> {
+				// Return a fake item that will come first
+				const range = options && options.useLineRange
+					? new vscode.Range(new vscode.Position(position.line, 0), position)
+					: doc.getWordRangeAtPosition(position.translate({ characterDelta: -1 }));
+				return [{
+					label: '🦄',
+					insertText: doc.getText(range),
+					filterText: doc.getText(range),
+					preselect: true,
+					sortText: 'a',
+					range: range
+				}];
+			}
+			async resolveCompletionItem(item: vscode.CompletionItem) {
+				await vscode.commands.executeCommand('selectNextSuggestion');
+				resolve();
+				return item;
+			}
+		})));
+}

extensions/typescript-language-features/src/test/testUtils.ts

@@ -65,4 +65,19 @@ export function withRandomFileEditor(
 			});
 		});
 	});
-}
\ No newline at end of file
+}
+
+export const wait = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
+
+export const joinLines = (...args: string[]) => args.join('\n');
+
+export async function createTestEditor(uri: vscode.Uri, ...lines: string[]) {
+	const document = await vscode.workspace.openTextDocument(uri);
+	await vscode.window.showTextDocument(document);
+	const activeEditor = vscode.window.activeTextEditor;
+	if (!activeEditor) {
+		throw new Error('no active editor');
+	}
+
+	await activeEditor.insertSnippet(new vscode.SnippetString(joinLines(...lines)), new vscode.Range(0, 0, 1000, 0));
+}