Unify nodeKind implementations for navigationBar and navigateTo

2026-05-09 07:55:10 -05:00 · 2016-07-26 10:41:20 -07:00
parent acb003adce
commit 30761ef659
34 changed files with 68 additions and 105 deletions
--- a/src/services/navigationBar.ts
+++ b/src/services/navigationBar.ts
@@ -506,7 +506,7 @@ namespace ts.NavigationBar {
    function convertToTopLevelItem(n: NavigationBarNode): NavigationBarItem {
        return {
            text: getItemName(n.node),
-            kind: nodeKind(n.node),
+            kind: getNodeKind(n.node),
            kindModifiers: getNodeModifiers(n.node),
            spans: getSpans(n),
            childItems: map(n.children, convertToChildItem) || emptyChildItemArray,
@@ -518,7 +518,7 @@ namespace ts.NavigationBar {
        function convertToChildItem(n: NavigationBarNode): NavigationBarItem {
            return {
                text: getItemName(n.node),
-                kind: nodeKind(n.node),
+                kind: getNodeKind(n.node),
                kindModifiers: getNodeModifiers(n.node),
                spans: getSpans(n),
                childItems: emptyChildItemArray,
@@ -539,57 +539,6 @@ namespace ts.NavigationBar {
        }
    }

-    // TODO: GH#9145: We should just use getNodeKind. No reason why navigationBar and navigateTo should have different behaviors.
-    function nodeKind(node: Node): string {
-        switch (node.kind) {
-            case SyntaxKind.SourceFile:
-                return ScriptElementKind.moduleElement;
-
-            case SyntaxKind.EnumMember:
-                return ScriptElementKind.memberVariableElement;
-
-            case SyntaxKind.VariableDeclaration:
-            case SyntaxKind.BindingElement:
-                let variableDeclarationNode: Node;
-                let name: Node;
-
-                if (node.kind === SyntaxKind.BindingElement) {
-                    name = (<BindingElement>node).name;
-                    variableDeclarationNode = node;
-                    // binding elements are added only for variable declarations
-                    // bubble up to the containing variable declaration
-                    while (variableDeclarationNode && variableDeclarationNode.kind !== SyntaxKind.VariableDeclaration) {
-                        variableDeclarationNode = variableDeclarationNode.parent;
-                    }
-                    Debug.assert(!!variableDeclarationNode);
-                }
-                else {
-                    Debug.assert(!isBindingPattern((<VariableDeclaration>node).name));
-                    variableDeclarationNode = node;
-                    name = (<VariableDeclaration>node).name;
-                }
-
-                if (isConst(variableDeclarationNode)) {
-                    return ts.ScriptElementKind.constElement;
-                }
-                else if (isLet(variableDeclarationNode)) {
-                    return ts.ScriptElementKind.letElement;
-                }
-                else {
-                    return ts.ScriptElementKind.variableElement;
-                }
-
-            case SyntaxKind.ArrowFunction:
-                return ts.ScriptElementKind.functionElement;
-
-            case SyntaxKind.JSDocTypedefTag:
-                return ScriptElementKind.typeElement;
-
-            default:
-                return getNodeKind(node);
-        }
-    }
-
    function getModuleName(moduleDeclaration: ModuleDeclaration): string {
        // We want to maintain quotation marks.
        if (isAmbientModule(moduleDeclaration)) {
--- a/src/services/services.ts
+++ b/src/services/services.ts
@@ -1690,6 +1690,8 @@ namespace ts {

        /** enum E */
        export const enumElement = "enum";
+        // TODO: GH#9983
+        export const enumMemberElement = "const";

        /**
         * Inside module and script only
@@ -2947,7 +2949,10 @@ namespace ts {

    /* @internal */ export function getNodeKind(node: Node): string {
        switch (node.kind) {
-            case SyntaxKind.ModuleDeclaration: return ScriptElementKind.moduleElement;
+            case SyntaxKind.SourceFile:
+                return isExternalModule(<SourceFile> node) ? ScriptElementKind.moduleElement : ScriptElementKind.scriptElement;
+            case SyntaxKind.ModuleDeclaration:
+                return ScriptElementKind.moduleElement;
            case SyntaxKind.ClassDeclaration:
            case SyntaxKind.ClassExpression:
                return ScriptElementKind.classElement;
@@ -2955,11 +2960,10 @@ namespace ts {
            case SyntaxKind.TypeAliasDeclaration: return ScriptElementKind.typeElement;
            case SyntaxKind.EnumDeclaration: return ScriptElementKind.enumElement;
            case SyntaxKind.VariableDeclaration:
-                return isConst(node)
-                    ? ScriptElementKind.constElement
-                    : isLet(node)
-                        ? ScriptElementKind.letElement
-                        : ScriptElementKind.variableElement;
+                return variableDeclarationKind(<VariableDeclaration> node);
+            case SyntaxKind.BindingElement:
+                return variableDeclarationKind(<VariableDeclaration> getRootDeclaration(node));
+            case SyntaxKind.ArrowFunction:
            case SyntaxKind.FunctionDeclaration:
            case SyntaxKind.FunctionExpression:
                return ScriptElementKind.functionElement;
@@ -2976,7 +2980,7 @@ namespace ts {
            case SyntaxKind.CallSignature: return ScriptElementKind.callSignatureElement;
            case SyntaxKind.Constructor: return ScriptElementKind.constructorImplementationElement;
            case SyntaxKind.TypeParameter: return ScriptElementKind.typeParameterElement;
-            case SyntaxKind.EnumMember: return ScriptElementKind.variableElement;
+            case SyntaxKind.EnumMember: return ScriptElementKind.enumMemberElement;
            case SyntaxKind.Parameter: return (node.flags & NodeFlags.ParameterPropertyModifier) ? ScriptElementKind.memberVariableElement : ScriptElementKind.parameterElement;
            case SyntaxKind.ImportEqualsDeclaration:
            case SyntaxKind.ImportSpecifier:
@@ -2984,8 +2988,18 @@ namespace ts {
            case SyntaxKind.ExportSpecifier:
            case SyntaxKind.NamespaceImport:
                return ScriptElementKind.alias;
+            case SyntaxKind.JSDocTypedefTag:
+                return ScriptElementKind.typeElement;
        }
        return ScriptElementKind.unknown;
+
+        function variableDeclarationKind(v: VariableDeclaration): string {
+            return isConst(v)
+                ? ScriptElementKind.constElement
+                : isLet(v)
+                    ? ScriptElementKind.letElement
+                    : ScriptElementKind.variableElement;
+        }
    }

    class CancellationTokenObject implements CancellationToken {
--- a/tests/cases/fourslash/deleteClassWithEnumPresent.ts
+++ b/tests/cases/fourslash/deleteClassWithEnumPresent.ts
@@ -8,7 +8,7 @@ edit.deleteAtCaret('class Bar { }'.length);
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "Foo",
--- a/tests/cases/fourslash/getNavigationBarItems.ts
+++ b/tests/cases/fourslash/getNavigationBarItems.ts
@@ -8,7 +8,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "C",
--- a/tests/cases/fourslash/navbar_const.ts
+++ b/tests/cases/fourslash/navbar_const.ts
@@ -5,7 +5,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "c",
--- a/tests/cases/fourslash/navbar_contains-no-duplicates.ts
+++ b/tests/cases/fourslash/navbar_contains-no-duplicates.ts
@@ -30,7 +30,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "ABC",
--- a/tests/cases/fourslash/navbar_let.ts
+++ b/tests/cases/fourslash/navbar_let.ts
@@ -5,7 +5,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "c",
--- a/tests/cases/fourslash/navigationBarAnonymousClassAndFunctionExpressions.ts
+++ b/tests/cases/fourslash/navigationBarAnonymousClassAndFunctionExpressions.ts
@@ -29,7 +29,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "<function>",
--- a/tests/cases/fourslash/navigationBarAnonymousClassAndFunctionExpressions2.ts
+++ b/tests/cases/fourslash/navigationBarAnonymousClassAndFunctionExpressions2.ts
@@ -6,7 +6,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "A",
--- a/tests/cases/fourslash/navigationBarGetterAndSetter.ts
+++ b/tests/cases/fourslash/navigationBarGetterAndSetter.ts
@@ -11,7 +11,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "X",
--- a/tests/cases/fourslash/navigationBarItemsBindingPatterns.ts
+++ b/tests/cases/fourslash/navigationBarItemsBindingPatterns.ts
@@ -9,7 +9,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "a",
--- a/tests/cases/fourslash/navigationBarItemsBindingPatternsInConstructor.ts
+++ b/tests/cases/fourslash/navigationBarItemsBindingPatternsInConstructor.ts
@@ -14,7 +14,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "A",
--- a/tests/cases/fourslash/navigationBarItemsEmptyConstructors.ts
+++ b/tests/cases/fourslash/navigationBarItemsEmptyConstructors.ts
@@ -8,7 +8,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "Test",
--- a/tests/cases/fourslash/navigationBarItemsFunctions.ts
+++ b/tests/cases/fourslash/navigationBarItemsFunctions.ts
@@ -17,7 +17,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "baz",
--- a/tests/cases/fourslash/navigationBarItemsFunctionsBroken.ts
+++ b/tests/cases/fourslash/navigationBarItemsFunctionsBroken.ts
@@ -7,7 +7,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "f",
--- a/tests/cases/fourslash/navigationBarItemsFunctionsBroken2.ts
+++ b/tests/cases/fourslash/navigationBarItemsFunctionsBroken2.ts
@@ -8,7 +8,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "<function>",
--- a/tests/cases/fourslash/navigationBarItemsInsideMethodsAndConstructors.ts
+++ b/tests/cases/fourslash/navigationBarItemsInsideMethodsAndConstructors.ts
@@ -21,7 +21,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "Class",
@@ -73,7 +73,7 @@ verify.navigationBar([
        "childItems": [
            {
                "text": "LocalEnumMemberInConstructor",
-                "kind": "property"
+                "kind": "const"
            }
        ],
        "indent": 3
@@ -113,7 +113,7 @@ verify.navigationBar([
        "childItems": [
            {
                "text": "LocalEnumMemberInMethod",
-                "kind": "property"
+                "kind": "const"
            }
        ],
        "indent": 3
--- a/tests/cases/fourslash/navigationBarItemsItems.ts
+++ b/tests/cases/fourslash/navigationBarItemsItems.ts
@@ -42,7 +42,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "dist",
@@ -155,15 +155,15 @@ verify.navigationBar([
        "childItems": [
            {
                "text": "value1",
-                "kind": "property"
+                "kind": "const"
            },
            {
                "text": "value2",
-                "kind": "property"
+                "kind": "const"
            },
            {
                "text": "value3",
-                "kind": "property"
+                "kind": "const"
            }
        ],
        "indent": 2
--- a/tests/cases/fourslash/navigationBarItemsItemsModuleVariables.ts
+++ b/tests/cases/fourslash/navigationBarItemsItemsModuleVariables.ts
@@ -23,7 +23,7 @@ goTo.marker("file1");
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "Module1",
@@ -49,7 +49,7 @@ goTo.marker("file2");
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "Module1.SubModule",
--- a/tests/cases/fourslash/navigationBarItemsMissingName2.ts
+++ b/tests/cases/fourslash/navigationBarItemsMissingName2.ts
@@ -9,7 +9,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "<class>",
--- a/tests/cases/fourslash/navigationBarItemsModules.ts
+++ b/tests/cases/fourslash/navigationBarItemsModules.ts
@@ -30,7 +30,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "'X2.Y2.Z2'",
--- a/tests/cases/fourslash/navigationBarItemsMultilineStringIdentifiers.ts
+++ b/tests/cases/fourslash/navigationBarItemsMultilineStringIdentifiers.ts
@@ -27,7 +27,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "\"Multiline\\\nMadness\"",
--- a/tests/cases/fourslash/navigationBarItemsPropertiesDefinedInConstructors.ts
+++ b/tests/cases/fourslash/navigationBarItemsPropertiesDefinedInConstructors.ts
@@ -9,7 +9,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "List",
--- a/tests/cases/fourslash/navigationBarItemsSymbols1.ts
+++ b/tests/cases/fourslash/navigationBarItemsSymbols1.ts
@@ -9,7 +9,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "C",
--- a/tests/cases/fourslash/navigationBarItemsSymbols2.ts
+++ b/tests/cases/fourslash/navigationBarItemsSymbols2.ts
@@ -8,7 +8,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "I",
--- a/tests/cases/fourslash/navigationBarItemsSymbols3.ts
+++ b/tests/cases/fourslash/navigationBarItemsSymbols3.ts
@@ -8,7 +8,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "E",
--- a/tests/cases/fourslash/navigationBarItemsTypeAlias.ts
+++ b/tests/cases/fourslash/navigationBarItemsTypeAlias.ts
@@ -5,7 +5,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "T",
--- a/tests/cases/fourslash/navigationBarJsDoc.ts
+++ b/tests/cases/fourslash/navigationBarJsDoc.ts
@@ -8,7 +8,7 @@
 verify.navigationBar([
  {
    "text": "<global>",
-    "kind": "module",
+    "kind": "script",
    "childItems": [
      {
        "text": "NumberLike",
--- a/tests/cases/fourslash/navigationBarMerging.ts
+++ b/tests/cases/fourslash/navigationBarMerging.ts
@@ -14,7 +14,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "a",
@@ -63,7 +63,7 @@ goTo.file("file2.ts");
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "a",
@@ -104,7 +104,7 @@ goTo.file("file3.ts");
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "a",
@@ -150,7 +150,7 @@ goTo.file("file4.ts");
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "A",
--- a/tests/cases/fourslash/navigationBarVariables.ts
+++ b/tests/cases/fourslash/navigationBarVariables.ts
@@ -7,7 +7,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "x",
@@ -34,7 +34,7 @@ goTo.file("file2.ts");
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "a",
--- a/tests/cases/fourslash/server/jsdocTypedefTagNavigateTo.ts
+++ b/tests/cases/fourslash/server/jsdocTypedefTagNavigateTo.ts
@@ -13,7 +13,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "numberLike",
--- a/tests/cases/fourslash/server/navbar01.ts
+++ b/tests/cases/fourslash/server/navbar01.ts
@@ -41,7 +41,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "dist",
@@ -154,15 +154,15 @@ verify.navigationBar([
        "childItems": [
            {
                "text": "value1",
-                "kind": "property"
+                "kind": "const"
            },
            {
                "text": "value2",
-                "kind": "property"
+                "kind": "const"
            },
            {
                "text": "value3",
-                "kind": "property"
+                "kind": "const"
            }
        ],
        "indent": 2
--- a/tests/cases/fourslash/shims-pp/getNavigationBarItems.ts
+++ b/tests/cases/fourslash/shims-pp/getNavigationBarItems.ts
@@ -5,7 +5,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "c",
--- a/tests/cases/fourslash/shims/getNavigationBarItems.ts
+++ b/tests/cases/fourslash/shims/getNavigationBarItems.ts
@@ -5,7 +5,7 @@
 verify.navigationBar([
    {
        "text": "<global>",
-        "kind": "module",
+        "kind": "script",
        "childItems": [
            {
                "text": "c",