Add "navtree" and "navtree-full" server commands

Author: Andy Hanson

src/harness/fourslash.ts

@@ -2211,6 +2211,18 @@ namespace FourSlash {
             }
         }
 
+        public verifyNavigationTree(json: any) {
+            const tree = this.languageService.getNavigationTree(this.activeFile.fileName);
+            if (JSON.stringify(tree, replacer) !== JSON.stringify(json)) {
+                this.raiseError(`verifyNavigationTree failed - expected: ${stringify(json)}, got: ${stringify(tree, replacer)}`);
+            }
+
+            function replacer(key: string, value: any) {
+                // Don't check "spans", and omit falsy values.
+                return key === "spans" ? undefined : (value || undefined);
+            }
+        }
+
         public printNavigationItems(searchValue: string) {
             const items = this.languageService.getNavigateToItems(searchValue);
             const length = items && items.length;
@@ -3279,6 +3291,10 @@ namespace FourSlashInterface {
             this.state.verifyNavigationBar(json);
         }
 
+        public navigationTree(json: any) {
+            this.state.verifyNavigationTree(json);
+        }
+
         public navigationItemsListCount(count: number, searchValue: string, matchKind?: string, fileName?: string) {
             this.state.verifyNavigationItemsCount(count, searchValue, matchKind, fileName);
         }

src/harness/harnessLanguageService.ts

@@ -459,6 +459,10 @@ namespace Harness.LanguageService {
         getNavigationBarItems(fileName: string): ts.NavigationBarItem[] {
             return unwrapJSONCallResult(this.shim.getNavigationBarItems(fileName));
         }
+        getNavigationTree(fileName: string): ts.NavigationTree {
+            return unwrapJSONCallResult(this.shim.getNavigationTree(fileName));
+        }
+
         getOutliningSpans(fileName: string): ts.OutliningSpan[] {
             return unwrapJSONCallResult(this.shim.getOutliningSpans(fileName));
         }

src/server/client.ts

@@ -488,7 +488,7 @@ namespace ts.server {
             return this.lastRenameEntry.locations;
         }
 
-        decodeNavigationBarItems(items: protocol.NavigationBarItem[], fileName: string, lineMap: number[]): NavigationBarItem[] {
+        private decodeNavigationBarItems(items: protocol.NavigationBarItem[], fileName: string, lineMap: number[]): NavigationBarItem[] {
             if (!items) {
                 return [];
             }
@@ -497,10 +497,7 @@ namespace ts.server {
                 text: item.text,
                 kind: item.kind,
                 kindModifiers: item.kindModifiers || "",
-                spans: item.spans.map(span =>
-                    createTextSpanFromBounds(
-                        this.lineOffsetToPosition(fileName, span.start, lineMap),
-                        this.lineOffsetToPosition(fileName, span.end, lineMap))),
+                spans: item.spans.map(span => this.decodeSpan(span, fileName, lineMap)),
                 childItems: this.decodeNavigationBarItems(item.childItems, fileName, lineMap),
                 indent: item.indent,
                 bolded: false,
@@ -509,17 +506,37 @@ namespace ts.server {
         }
 
         getNavigationBarItems(fileName: string): NavigationBarItem[] {
-            const args: protocol.FileRequestArgs = {
-                file: fileName
-            };
-
-            const request = this.processRequest<protocol.NavBarRequest>(CommandNames.NavBar, args);
+            const request = this.processRequest<protocol.NavBarRequest>(CommandNames.NavBar, { file: fileName });
             const response = this.processResponse<protocol.NavBarResponse>(request);
 
             const lineMap = this.getLineMap(fileName);
             return this.decodeNavigationBarItems(response.body, fileName, lineMap);
         }
 
+        private decodeNavigationTree(tree: protocol.NavigationTree, fileName: string, lineMap: number[]): NavigationTree {
+            return {
+                text: tree.text,
+                kind: tree.kind,
+                kindModifiers: tree.kindModifiers,
+                spans: tree.spans.map(span => this.decodeSpan(span, fileName, lineMap)),
+                childItems: map(tree.childItems, item => this.decodeNavigationTree(item, fileName, lineMap))
+            };
+        }
+
+        getNavigationTree(fileName: string): NavigationTree {
+            const request = this.processRequest<protocol.NavTreeRequest>(CommandNames.NavTree, { file: fileName });
+            const response = this.processResponse<protocol.NavTreeResponse>(request);
+
+            const lineMap = this.getLineMap(fileName);
+            return this.decodeNavigationTree(response.body, fileName, lineMap);
+        }
+
+        private decodeSpan(span: protocol.TextSpan, fileName: string, lineMap: number[]) {
+            return createTextSpanFromBounds(
+                this.lineOffsetToPosition(fileName, span.start, lineMap),
+                this.lineOffsetToPosition(fileName, span.end, lineMap));
+        }
+
         getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): TextSpan {
             throw new Error("Not Implemented Yet.");
         }

src/server/protocol.d.ts

@@ -110,7 +110,7 @@ declare namespace ts.server.protocol {
      */
     export interface TodoCommentRequestArgs extends FileRequestArgs {
         /**
-         * Array of target TodoCommentDescriptors that describes TODO comments to be found 
+         * Array of target TodoCommentDescriptors that describes TODO comments to be found
          */
         descriptors: TodoCommentDescriptor[];
     }
@@ -231,7 +231,7 @@ declare namespace ts.server.protocol {
         offset?: number;
 
         /**
-         * Position (can be specified instead of line/offset pair) 
+         * Position (can be specified instead of line/offset pair)
          */
         position?: number;
     }
@@ -577,12 +577,12 @@ declare namespace ts.server.protocol {
 
     /**
      * Represents a file in external project.
-     * External project is project whose set of files, compilation options and open\close state 
+     * External project is project whose set of files, compilation options and open\close state
      * is maintained by the client (i.e. if all this data come from .csproj file in Visual Studio).
      * External project will exist even if all files in it are closed and should be closed explicity.
-     * If external project includes one or more tsconfig.json/jsconfig.json files then tsserver will 
+     * If external project includes one or more tsconfig.json/jsconfig.json files then tsserver will
      * create configured project for every config file but will maintain a link that these projects were created
-     * as a result of opening external project so they should be removed once external project is closed. 
+     * as a result of opening external project so they should be removed once external project is closed.
      */
     export interface ExternalFile {
         /**
@@ -998,7 +998,7 @@ declare namespace ts.server.protocol {
     }
 
     /**
-     * Response for CompileOnSaveAffectedFileListRequest request; 
+     * Response for CompileOnSaveAffectedFileListRequest request;
      */
     export interface CompileOnSaveAffectedFileListResponse extends Response {
         body: CompileOnSaveAffectedFileListSingleProject[];
@@ -1743,6 +1743,13 @@ declare namespace ts.server.protocol {
     export interface NavBarRequest extends FileRequest {
     }
 
+    /**
+     * NavTree request; value of command field is "navtree".
+     * Return response giving the navigation tree of the requested file.
+     */
+    export interface NavTreeRequest extends FileRequest {
+    }
+
     export interface NavigationBarItem {
         /**
           * The item's display text.
@@ -1775,7 +1782,20 @@ declare namespace ts.server.protocol {
         indent: number;
     }
 
+    /** protocol.NavigationTree is identical to ts.NavigationTree, except using protocol.TextSpan instead of ts.TextSpan */
+    export interface NavigationTree {
+        text: string;
+        kind: string;
+        kindModifiers: string;
+        spans: TextSpan[];
+        childItems?: NavigationTree[];
+    }
+
     export interface NavBarResponse extends Response {
         body?: NavigationBarItem[];
     }
+
+    export interface NavTreeResponse extends Response {
+        body?: NavigationTree;
+    }
 }

src/server/scriptInfo.ts

@@ -4,7 +4,7 @@ namespace ts.server {
 
     export class ScriptInfo {
         /**
-         * All projects that include this file 
+         * All projects that include this file
          */
         readonly containingProjects: Project[] = [];
         private formatCodeSettings: ts.FormatCodeSettings;

src/server/session.ts

@@ -98,6 +98,8 @@ namespace ts.server {
         export const SyntacticDiagnosticsSync = "syntacticDiagnosticsSync";
         export const NavBar = "navbar";
         export const NavBarFull = "navbar-full";
+        export const NavTree = "navtree";
+        export const NavTreeFull = "navtree-full";
         export const Navto = "navto";
         export const NavtoFull = "navto-full";
         export const Occurrences = "occurrences";
@@ -550,7 +552,7 @@ namespace ts.server {
                 const scriptInfo = this.projectService.getScriptInfo(args.file);
                 projects = scriptInfo.containingProjects;
             }
-            // ts.filter handles case when 'projects' is undefined 
+            // ts.filter handles case when 'projects' is undefined
             projects = filter(projects, p => p.languageServiceEnabled);
             if (!projects || !projects.length) {
                 return Errors.ThrowNoProject();
@@ -947,15 +949,8 @@ namespace ts.server {
                 return completions.entries.reduce((result: protocol.CompletionEntry[], entry: ts.CompletionEntry) => {
                     if (completions.isMemberCompletion || (entry.name.toLowerCase().indexOf(prefix.toLowerCase()) === 0)) {
                         const { name, kind, kindModifiers, sortText, replacementSpan } = entry;
-
-                        let convertedSpan: protocol.TextSpan = undefined;
-                        if (replacementSpan) {
-                            convertedSpan = {
-                                start: scriptInfo.positionToLineOffset(replacementSpan.start),
-                                end: scriptInfo.positionToLineOffset(replacementSpan.start + replacementSpan.length)
-                            };
-                        }
-
+                        const convertedSpan: protocol.TextSpan =
+                            replacementSpan ? this.decorateSpan(replacementSpan, scriptInfo) : undefined;
                         result.push({ name, kind, kindModifiers, sortText, replacementSpan: convertedSpan });
                     }
                     return result;
@@ -1093,38 +1088,54 @@ namespace ts.server {
             this.projectService.closeClientFile(file);
         }
 
-        private decorateNavigationBarItem(project: Project, fileName: NormalizedPath, items: ts.NavigationBarItem[]): protocol.NavigationBarItem[] {
-            if (!items) {
-                return undefined;
-            }
-
-            const scriptInfo = project.getScriptInfoForNormalizedPath(fileName);
-
-            return items.map(item => ({
+        private decorateNavigationBarItems(items: ts.NavigationBarItem[], scriptInfo: ScriptInfo): protocol.NavigationBarItem[] {
+            return map(items, item => ({
                 text: item.text,
                 kind: item.kind,
                 kindModifiers: item.kindModifiers,
-                spans: item.spans.map(span => ({
-                    start: scriptInfo.positionToLineOffset(span.start),
-                    end: scriptInfo.positionToLineOffset(ts.textSpanEnd(span))
-                })),
-                childItems: this.decorateNavigationBarItem(project, fileName, item.childItems),
+                spans: item.spans.map(span => this.decorateSpan(span, scriptInfo)),
+                childItems: this.decorateNavigationBarItems(item.childItems, scriptInfo),
                 indent: item.indent
             }));
         }
 
         private getNavigationBarItems(args: protocol.FileRequestArgs, simplifiedResult: boolean): protocol.NavigationBarItem[] | NavigationBarItem[] {
             const { file, project } = this.getFileAndProject(args);
             const items = project.getLanguageService(/*ensureSynchronized*/ false).getNavigationBarItems(file);
-            if (!items) {
-                return undefined;
-            }
-
-            return simplifiedResult
-                ? this.decorateNavigationBarItem(project, file, items)
+            return !items
+                ? undefined
+                : simplifiedResult
+                ? this.decorateNavigationBarItems(items, project.getScriptInfoForNormalizedPath(file))
                 : items;
         }
 
+        private decorateNavigationTree(tree: ts.NavigationTree, scriptInfo: ScriptInfo): protocol.NavigationTree {
+            return {
+                text: tree.text,
+                kind: tree.kind,
+                kindModifiers: tree.kindModifiers,
+                spans: tree.spans.map(span => this.decorateSpan(span, scriptInfo)),
+                childItems: map(tree.childItems, item => this.decorateNavigationTree(item, scriptInfo))
+            };
+        }
+
+        private decorateSpan(span: TextSpan, scriptInfo: ScriptInfo): protocol.TextSpan {
+            return {
+                start: scriptInfo.positionToLineOffset(span.start),
+                end: scriptInfo.positionToLineOffset(ts.textSpanEnd(span))
+            };
+        }
+
+        private getNavigationTree(args: protocol.FileRequestArgs, simplifiedResult: boolean): protocol.NavigationTree | NavigationTree {
+            const { file, project } = this.getFileAndProject(args);
+            const tree = project.getLanguageService(/*ensureSynchronized*/ false).getNavigationTree(file);
+            return !tree
+                ? undefined
+                : simplifiedResult
+                ? this.decorateNavigationTree(tree, project.getScriptInfoForNormalizedPath(file))
+                : tree;
+        }
+
         private getNavigateToItems(args: protocol.NavtoRequestArgs, simplifiedResult: boolean): protocol.NavtoItem[] | NavigateToItem[] {
             const projects = this.getProjects(args);
 
@@ -1212,19 +1223,11 @@ namespace ts.server {
             const position = this.getPosition(args, scriptInfo);
 
             const spans = project.getLanguageService(/*ensureSynchronized*/ false).getBraceMatchingAtPosition(file, position);
-            if (!spans) {
-                return undefined;
-            }
-            if (simplifiedResult) {
-
-                return spans.map(span => ({
-                    start: scriptInfo.positionToLineOffset(span.start),
-                    end: scriptInfo.positionToLineOffset(span.start + span.length)
-                }));
-            }
-            else {
-                return spans;
-            }
+            return !spans
+                ? undefined
+                : simplifiedResult
+                ? spans.map(span => this.decorateSpan(span, scriptInfo))
+                : spans;
         }
 
         getDiagnosticsForProject(delay: number, fileName: string) {
@@ -1509,6 +1512,12 @@ namespace ts.server {
             [CommandNames.NavBarFull]: (request: protocol.FileRequest) => {
                 return this.requiredResponse(this.getNavigationBarItems(request.arguments, /*simplifiedResult*/ false));
             },
+            [CommandNames.NavTree]: (request: protocol.FileRequest) => {
+                return this.requiredResponse(this.getNavigationTree(request.arguments, /*simplifiedResult*/ true));
+            },
+            [CommandNames.NavTreeFull]: (request: protocol.FileRequest) => {
+                return this.requiredResponse(this.getNavigationTree(request.arguments, /*simplifiedResult*/ false));
+            },
             [CommandNames.Occurrences]: (request: protocol.FileLocationRequest) => {
                 return this.requiredResponse(this.getOccurrences(request.arguments));
             },