Skip to content

Sort JSDoc @param completions by argument position #63306

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

Closed
Vi-Ku wants to merge 1 commit into from
+70 −39
Closed

Sort JSDoc @param completions by argument position #63306

Show file tree
Hide file tree
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
6 changes: 3 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,7 +944,7 @@ 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, parameterIndex) => {
if (getJSDocParameterTags(param).length) {
return undefined; // Parameter is already annotated.
}
Expand Down Expand Up @@ -983,7 +983,7 @@ function getJSDocParameterCompletions(
return {
name: displayText,
kind: ScriptElementKind.parameterElement,
sortText: SortText.LocationPriority,
sortText: SortText.LocationPriority + String(parameterIndex) as SortText,
insertText: isSnippet ? snippetText : undefined,
isSnippet,
};
Expand Down Expand Up @@ -1023,7 +1023,7 @@ function getJSDocParameterCompletions(
return {
name: displayText,
kind: ScriptElementKind.parameterElement,
sortText: SortText.LocationPriority,
sortText: SortText.LocationPriority + String(parameterIndex) as SortText,
insertText: isSnippet ? snippetText : undefined,
isSnippet,
};
Expand Down
2 changes: 1 addition & 1 deletion src/services/jsDoc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ export function getJSDocParameterNameCompletions(tag: JSDocParameterTag): Comple
return undefined;
}

return { name, kind: ScriptElementKind.parameterElement, kindModifiers: "", sortText: Completions.SortText.LocationPriority };
return { name, kind: ScriptElementKind.parameterElement, kindModifiers: "", sortText: Completions.SortText.LocationPriority + String(fn.parameters.indexOf(param)) as Completions.SortText };
});
}

Expand Down
42 changes: 21 additions & 21 deletions tests/baselines/reference/jsdocParameterTagSnippetCompletion1.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2740,7 +2740,7 @@
{
"name": "param value ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand All @@ -2753,7 +2753,7 @@
{
"name": "param maximumFractionDigits ",
"kind": "",
"sortText": "11",
"sortText": "111",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -3877,7 +3877,7 @@
{
"name": "param param0 ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand All @@ -3890,7 +3890,7 @@
{
"name": "param b ",
"kind": "",
"sortText": "11",
"sortText": "111",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -5014,7 +5014,7 @@
{
"name": "@param b ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -6138,7 +6138,7 @@
{
"name": "param param0 ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -7262,7 +7262,7 @@
{
"name": "param param0 ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -8386,7 +8386,7 @@
{
"name": "param {Object} param0 \r\n* @param {number} [param0.a=1] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand All @@ -8399,7 +8399,7 @@
{
"name": "param {*} b ",
"kind": "",
"sortText": "11",
"sortText": "111",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -9523,7 +9523,7 @@
{
"name": "@param {*} b ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -10647,7 +10647,7 @@
{
"name": "param {Object} param0 \r\n* @param {Object} [param0.b={ a: 1, c: 3 }] \r\n* @param {*} param0.b.a \r\n* @param {*} param0.b.c ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -11771,7 +11771,7 @@
{
"name": "param {Object} param0 \r\n* @param {Object} param0.a \r\n* @param {*} param0.a.b \r\n* @param {*} param0.a.c \r\n* @param {*} param0.d ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -12895,7 +12895,7 @@
{
"name": "param {*} param0 ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -14019,7 +14019,7 @@
{
"name": "param {Object} param0 \r\n* @param {*} param0.a ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -15143,7 +15143,7 @@
{
"name": "param {*} a ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -16267,7 +16267,7 @@
{
"name": "param {Object} param1 \r\n* @param {*} param1.b ",
"kind": "",
"sortText": "11",
"sortText": "111",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -17391,7 +17391,7 @@
{
"name": "param {Object} param0 \r\n* @param {*} param0.b \r\n* @param {...*} param0.c ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand All @@ -17404,7 +17404,7 @@
{
"name": "param {...*} a ",
"kind": "",
"sortText": "11",
"sortText": "111",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -18528,7 +18528,7 @@
{
"name": "param {...*} param0 ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -19652,7 +19652,7 @@
{
"name": "param {...*} a ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -20776,7 +20776,7 @@
{
"name": "param {*} [a] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down
10 changes: 5 additions & 5 deletions tests/baselines/reference/jsdocParameterTagSnippetCompletion2.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1580,7 +1580,7 @@
{
"name": "@param b ",
"kind": "",
"sortText": "11",
"sortText": "110",
"insertText": "@param b ${1}",
"isSnippet": true,
"kindModifiers": "",
Expand Down Expand Up @@ -2706,7 +2706,7 @@
{
"name": "@param {*} b ",
"kind": "",
"sortText": "11",
"sortText": "110",
"insertText": "@param {${1:*}} b ${2}",
"isSnippet": true,
"kindModifiers": "",
Expand Down Expand Up @@ -3832,7 +3832,7 @@
{
"name": "param {Object} param0 \r\n* @param {Object} [param0.b={ a: 1, c: 3 }] \r\n* @param {*} param0.b.a \r\n* @param {*} param0.b.c ",
"kind": "",
"sortText": "11",
"sortText": "110",
"insertText": "param {Object} param0 ${1}\r\n* @param {Object} [param0.b={ a: 1, c: 3 }] ${2}\r\n* @param {${3:*}} param0.b.a ${4}\r\n* @param {${5:*}} param0.b.c ${6}",
"isSnippet": true,
"kindModifiers": "",
Expand Down Expand Up @@ -4958,7 +4958,7 @@
{
"name": "param {...*} a ",
"kind": "",
"sortText": "11",
"sortText": "110",
"insertText": "param {...${1:*}} a ${2}",
"isSnippet": true,
"kindModifiers": "",
Expand Down Expand Up @@ -6084,7 +6084,7 @@
{
"name": "param {number} [a=3] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"insertText": "param {number} [a=3] ${1}",
"isSnippet": true,
"kindModifiers": "",
Expand Down
12 changes: 6 additions & 6 deletions tests/baselines/reference/jsdocParameterTagSnippetCompletion3.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1672,7 +1672,7 @@
{
"name": "param {number} [a=3] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -2796,7 +2796,7 @@
{
"name": "param {Object} param0 \r\n* @param {number} [param0.a=3] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -3920,7 +3920,7 @@
{
"name": "param {Object} param0 \r\n* @param {*} param0.a \r\n* @param {Object} param0.o \r\n* @param {*} param0.o.b \r\n* @param {*} param0.o.c ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -5044,7 +5044,7 @@
{
"name": "param {Object} param0 \r\n* @param {*} param0.a \r\n* @param {Object} param0.o \r\n* @param {*} param0.o.b \r\n* @param {[number, boolean]} [param0.o.c=[1, true]] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -6168,7 +6168,7 @@
{
"name": "param {Object} param0 \r\n* @param {(number | boolean)[]} [param0.a=[1, true]] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down Expand Up @@ -7292,7 +7292,7 @@
{
"name": "param {Object} param0 \r\n* @param {*} [param0.a=random()] ",
"kind": "",
"sortText": "11",
"sortText": "110",
"kindModifiers": "",
"displayParts": [
{
Expand Down
21 changes: 18 additions & 3 deletions tests/cases/fourslash/jsdocParameterNameCompletion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,22 @@
////function i(foo, bar) {}

verify.completions(
{ marker: ["0", "3", "4"], exact: ["foo", "bar"] },
{ marker: "1", exact: "bar" },
{ marker: "2", exact: ["canary", "canoodle"] },
{
marker: ["0", "3", "4"],
exact: [
{ name: "foo", kind: "parameter", sortText: completion.SortText.LocationPriority + "0" },
{ name: "bar", kind: "parameter", sortText: completion.SortText.LocationPriority + "1" },
],
},
{
marker: "1",
exact: { name: "bar", kind: "parameter", sortText: completion.SortText.LocationPriority + "1" },
},
{
marker: "2",
exact: [
{ name: "canary", kind: "parameter", sortText: completion.SortText.LocationPriority + "1" },
{ name: "canoodle", kind: "parameter", sortText: completion.SortText.LocationPriority + "2" },
],
},
);
16 changes: 16 additions & 0 deletions tests/cases/fourslash/jsdocParameterNameSortOrder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/// <reference path="fourslash.ts" />

// @Filename: /a.ts
/////**
//// * @param /**/
//// */
////function foo(z: string, a: number, m: boolean) {}

verify.completions({
marker: "",
exact: [
{ name: "z", kind: "parameter", sortText: completion.SortText.LocationPriority + "0" },
{ name: "a", kind: "parameter", sortText: completion.SortText.LocationPriority + "1" },
{ name: "m", kind: "parameter", sortText: completion.SortText.LocationPriority + "2" },
],
});