Skip to content

fix(completions): sort JSDoc @param suggestions by declaration order #63439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
creazyfrog wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −3
Open

fix(completions): sort JSDoc @param suggestions by declaration order #63439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/services/completions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,10 +944,13 @@ function getJSDocParameterCompletions(
const isJs = isSourceFileJS(sourceFile);
const isSnippet = preferences.includeCompletionsWithSnippetText || undefined;
const paramTagCount = countWhere(jsDoc.tags, tag => isJSDocParameterTag(tag) && tag.getEnd() <= position);
return mapDefined(func.parameters, param => {
return mapDefined(func.parameters, (param, paramIndex) => {
if (getJSDocParameterTags(param).length) {
return undefined; // Parameter is already annotated.
}
// Sort completions by the parameter's declaration order so that
// `@param` suggestions appear in the same order as the function signature.
const sortText = (SortText.LocationPriority + String(paramIndex).padStart(4, "0")) as SortText;
if (isIdentifier(param.name)) { // Named parameter
const tabstopCounter = { tabstop: 1 };
const paramName = param.name.text;
Expand Down Expand Up @@ -983,7 +986,7 @@ function getJSDocParameterCompletions(
return {
name: displayText,
kind: ScriptElementKind.parameterElement,
sortText: SortText.LocationPriority,
sortText,
insertText: isSnippet ? snippetText : undefined,
isSnippet,
};
Expand Down Expand Up @@ -1023,7 +1026,7 @@ function getJSDocParameterCompletions(
return {
name: displayText,
kind: ScriptElementKind.parameterElement,
sortText: SortText.LocationPriority,
sortText,
insertText: isSnippet ? snippetText : undefined,
isSnippet,
};
Expand Down