fix(43796): sort deprecated completions lower than others

a-tarasyuk · a-tarasyuk · commit e7d55be2b7cd · 2021-05-06T23:20:54.000+03:00
diff --git a/src/services/completions.ts b/src/services/completions.ts
diff --git a/src/services/symbolDisplay.ts b/src/services/symbolDisplay.ts
@@ -100,10 +100,6 @@ namespace ts.SymbolDisplay {
         return ScriptElementKind.unknown;
     }
 
-    function isDeprecatedDeclaration(decl: Declaration) {
-        return !!(getCombinedNodeFlagsAlwaysIncludeJSDoc(decl) & ModifierFlags.Deprecated);
-    }
-
     function getNormalizedSymbolModifiers(symbol: Symbol) {
         if (symbol.declarations && symbol.declarations.length) {
             const [declaration, ...declarations] = symbol.declarations;
diff --git a/src/services/utilities.ts b/src/services/utilities.ts
@@ -3352,5 +3352,9 @@ namespace ts {
             || (!!globalCachePath && startsWith(getCanonicalFileName(globalCachePath), toNodeModulesParent));
     }
 
+    export function isDeprecatedDeclaration(decl: Declaration) {
+        return !!(getCombinedNodeFlagsAlwaysIncludeJSDoc(decl) & ModifierFlags.Deprecated);
+    }
+
     // #endregion
 }
diff --git a/tests/baselines/reference/completionsSalsaMethodsOnAssignedFunctionExpressions.baseline b/tests/baselines/reference/completionsSalsaMethodsOnAssignedFunctionExpressions.baseline
@@ -302,21 +302,21 @@
           "name": "a",
           "kind": "warning",
           "kindModifiers": "",
-          "sortText": "7",
+          "sortText": "14",
           "isFromUncheckedFile": true
         },
         {
           "name": "prototype",
           "kind": "warning",
           "kindModifiers": "",
-          "sortText": "7",
+          "sortText": "14",
           "isFromUncheckedFile": true
         },
         {
           "name": "m",
           "kind": "property",
           "kindModifiers": "",
-          "sortText": "7",
+          "sortText": "14",
           "isFromUncheckedFile": true,
           "displayParts": [
             {
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag1.ts b/tests/cases/fourslash/completionsWithDeprecatedTag1.ts
@@ -25,27 +25,26 @@
 verify.completions({
     marker: "1",
     includes: [
-      { name: "Foo", kind: "interface", kindModifiers: "deprecated" }
+      { name: "Foo", kind: "interface", kindModifiers: "deprecated", sortText: completion.SortText.DeprecatedLocationPriority }
     ]
 }, {
     marker: "2",
     includes: [
-      { name: "bar", kind: "method", kindModifiers: "deprecated" }
+      { name: "bar", kind: "method", kindModifiers: "deprecated", sortText: completion.SortText.DeprecatedLocationPriority }
     ]
 }, {
     marker: "3",
     includes: [
-      { name: "prop", kind: "property", kindModifiers: "deprecated" }
+      { name: "prop", kind: "property", kindModifiers: "deprecated", sortText: completion.SortText.DeprecatedLocationPriority }
     ]
 }, {
     marker: "4",
     includes: [
-      { name: "foobar", kind: "function", kindModifiers: "export,deprecated" }
+      { name: "foobar", kind: "function", kindModifiers: "export,deprecated", sortText: completion.SortText.DeprecatedLocationPriority }
     ]
 }, {
     marker: "5",
     includes: [
-      { name: "foobar", kind: "alias", kindModifiers: "export,deprecated" }
+      { name: "foobar", kind: "alias", kindModifiers: "export,deprecated", sortText: completion.SortText.DeprecatedLocationPriority }
     ]
-}
-);
+});
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag10.ts b/tests/cases/fourslash/completionsWithDeprecatedTag10.ts
@@ -0,0 +1,24 @@
+/// <reference path="fourslash.ts" />
+
+// @Filename: /foo.ts
+/////** @deprecated foo */
+////export const foo = 0;
+
+// @Filename: /index.ts
+/////**/
+
+verify.completions({
+    marker: "",
+    includes: [{
+        name: "foo",
+        source: "/foo",
+        sourceDisplay: "./foo",
+        hasAction: true,
+        kind: "const",
+        kindModifiers: "export,deprecated",
+        sortText: completion.SortText.DeprecatedAutoImportSuggestions
+    }],
+    preferences: {
+        includeCompletionsForModuleExports: true,
+    },
+});
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag2.ts b/tests/cases/fourslash/completionsWithDeprecatedTag2.ts
@@ -9,7 +9,10 @@
 
 verify.completions({
     marker: "",
-    includes: [
-        { name: "foo", kind: "function", kindModifiers: "deprecated,declare" }
-    ]
+    includes: [{
+        name: "foo",
+        kind: "function",
+        kindModifiers: "deprecated,declare",
+        sortText: completion.SortText.DeprecatedLocationPriority
+    }]
 });
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag3.ts b/tests/cases/fourslash/completionsWithDeprecatedTag3.ts
@@ -9,7 +9,10 @@
 
 verify.completions({
     marker: "",
-    includes: [
-      { name: "foo", kind: "function", kindModifiers: "declare" }
-    ]
+    includes: [{
+        name: "foo",
+        kind: "function",
+        kindModifiers: "declare",
+        sortText: completion.SortText.LocationPriority
+    }]
 });
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag4.ts b/tests/cases/fourslash/completionsWithDeprecatedTag4.ts
@@ -0,0 +1,23 @@
+/// <reference path="fourslash.ts" />
+
+// @noLib: true
+
+////f({
+////    a/**/
+////    xyz: ``,
+////});
+////declare function f(options: {
+////    /** @deprecated abc */
+////    abc?: number,
+////    xyz?: string
+////}): void;
+
+verify.completions({
+    marker: "",
+    exact: [{
+        name: "abc",
+        kind: "property",
+        kindModifiers: "deprecated,declare,optional",
+        sortText: completion.SortText.DeprecatedOptionalMember
+    }],
+});
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag5.ts b/tests/cases/fourslash/completionsWithDeprecatedTag5.ts
@@ -0,0 +1,24 @@
+/// <reference path="fourslash.ts"/>
+
+////class Foo {
+////    /** @deprecated m */
+////    static m() {}
+////}
+////Foo./**/
+
+verify.completions({
+    marker: "",
+    exact: [
+        {
+            name: "prototype",
+            sortText: completion.SortText.LocationPriority
+        },
+        {
+            name: "m",
+            kind: "method",
+            kindModifiers: "static,deprecated",
+            sortText: completion.SortText.DeprecatedLocalDeclarationPriority
+        },
+        ...completion.functionMembers
+    ]
+});
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag6.ts b/tests/cases/fourslash/completionsWithDeprecatedTag6.ts
@@ -0,0 +1,17 @@
+/// <reference path="fourslash.ts"/>
+
+////module Foo {
+////    /** @deprecated foo */
+////    export var foo: number;
+////}
+////Foo./**/
+
+verify.completions({
+    marker: "",
+    exact: [{
+        name: "foo",
+        kind: "var",
+        kindModifiers: "export,deprecated",
+        sortText: completion.SortText.DeprecatedLocationPriority
+    }]
+});
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag7.ts b/tests/cases/fourslash/completionsWithDeprecatedTag7.ts
@@ -0,0 +1,27 @@
+/// <reference path="fourslash.ts" />
+
+// @strict: true
+
+////interface I {
+////    /** @deprecated a */
+////    a: number;
+////}
+
+////const foo = {
+////    a: 1
+////}
+
+////const i: I = {
+////    ...foo,
+////    /**/
+////}
+
+verify.completions({
+    marker: "",
+    exact: [{
+        name: "a",
+        sortText: completion.SortText.DeprecatedMemberDeclaredBySpreadAssignment,
+        kind: 'property',
+        kindModifiers: "deprecated"
+    }]
+});
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag8.ts b/tests/cases/fourslash/completionsWithDeprecatedTag8.ts
@@ -0,0 +1,25 @@
+/// <reference path="fourslash.ts" />
+
+////class C {
+////    /** @deprecated */
+////    p: number;
+////    m() {
+////        return (/**/)
+////    }
+////}
+
+verify.completions({
+    marker: "",
+    includes: [{
+        name: "p",
+        kind: "property",
+        kindModifiers: "deprecated",
+        insertText: "this.p",
+        sortText: completion.SortText.DeprecatedSuggestedClassMembers,
+        source: completion.CompletionSource.ThisProperty
+    }],
+    preferences: {
+        includeInsertTextCompletions: true
+    },
+    isNewIdentifierLocation: true
+});
diff --git a/tests/cases/fourslash/completionsWithDeprecatedTag9.ts b/tests/cases/fourslash/completionsWithDeprecatedTag9.ts
@@ -0,0 +1,30 @@
+/// <reference path="fourslash.ts" />
+
+// @lib: dom
+// @allowJs: true
+
+// @Filename: globals.d.ts
+/////** @deprecated foo */
+////declare var foo: string;
+
+// @Filename: index.ts
+////class Foo {
+////    foo: number;
+////    m() {
+////        foo/**/
+////    }
+////}
+
+verify.completions({
+    marker: "",
+    includes: [{
+        name: "foo",
+        kind: "var",
+        kindModifiers: "deprecated,declare",
+        sortText: completion.SortText.DeprecatedGlobalsOrKeywords
+    }]
+}, {
+    preferences: {
+        includeInsertTextCompletions: true
+    }
+});
diff --git a/tests/cases/fourslash/fourslash.ts b/tests/cases/fourslash/fourslash.ts
@@ -796,7 +796,14 @@ declare namespace completion {
         SuggestedClassMembers = "4",
         GlobalsOrKeywords = "5",
         AutoImportSuggestions = "6",
-        JavascriptIdentifiers = "7"
+        DeprecatedLocalDeclarationPriority = "7",
+        DeprecatedLocationPriority = "8",
+        DeprecatedOptionalMember = "9",
+        DeprecatedMemberDeclaredBySpreadAssignment = "10",
+        DeprecatedSuggestedClassMembers = "11",
+        DeprecatedGlobalsOrKeywords = "12",
+        DeprecatedAutoImportSuggestions = "13",
+        JavascriptIdentifiers = "14"
     }
     export const enum CompletionSource {
         ThisProperty = "ThisProperty/"

Original file line number	Diff line number	Diff line change
`@@ -3352,5 +3352,9 @@ namespace ts {`
`3352`	`3352`	`\|\| (!!globalCachePath && startsWith(getCanonicalFileName(globalCachePath), toNodeModulesParent));`
`3353`	`3353`	`}`
`3354`	`3354`
	`3355`	`+ export function isDeprecatedDeclaration(decl: Declaration) {`
	`3356`	`+ return !!(getCombinedNodeFlagsAlwaysIncludeJSDoc(decl) & ModifierFlags.Deprecated);`
	`3357`	`+ }`
	`3358`	`+`
`3355`	`3359`	`// #endregion`
`3356`	`3360`	`}`