Change tests to use the full JSON output of the navigation bar.

This reduces the confusion of verify.navigationBarCount() counting duplicate items.

Author: Andy Hanson

src/harness/fourslash.ts

@@ -1959,70 +1959,42 @@ namespace FourSlash {
  }
  }
 
- public verifyNavigationBarCount(expected: number) {
- const items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
- const actual = this.getNavigationBarItemsCount(items[0]);
-
- if (expected !== actual) {
- this.raiseError(`verifyNavigationBarCount failed - found: ${actual} navigation items, expected: ${expected}.`);
- }
- }
-
- private getNavigationBarItemsCount(root: ts.NavigationBarItem) {
- ts.Debug.assert(root.kind === ts.ScriptElementKind.moduleElement);
- function recur(item: ts.NavigationBarItem) {
- let count = 1;
- for (const child of item.childItems)
- count += recur(child);
- return count;
- }
- return recur(root);
- }
-
- public verifyNavigationBarContains(name: string, kind: string, fileName?: string, parentName?: string, isAdditionalSpan?: boolean, markerPosition?: number) {
- fileName = fileName || this.activeFile.fileName;
- const items = this.languageService.getNavigationBarItems(fileName);
-
- if (!items || items.length === 0) {
- this.raiseError("verifyNavigationBarContains failed - found 0 navigation items, expected at least one.");
- }
-
- if (this.navigationBarItemsContains(items, name, kind, parentName)) {
- return;
- }
-
- const missingItem = { name, kind, parentName };
- this.raiseError(`verifyNavigationBarContains failed - could not find the item: ${JSON.stringify(missingItem, undefined, 2)} in the returned list: (${JSON.stringify(items, undefined, 2)})`);
- }
-
- private navigationBarItemsContains(items: ts.NavigationBarItem[], name: string, kind: string, parentName?: string) {
- function recur(items: ts.NavigationBarItem[], curParentName: string) {
- for (let i = 0; i < items.length; i++) {
- const item = items[i];
- if (item && item.text === name && item.kind === kind && (!parentName || curParentName === parentName)) {
- return true;
- }
- if (recur(item.childItems, item.text)) {
- return true;
- }
- }
- return false;
- }
- return recur(items, "");
- }
-
- public verifyNavigationBarChildItem(parent: string, name: string, kind: string) {
- const items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
-
- for (let i = 0; i < items.length; i++) {
- const item = items[i];
- if (item.text === parent) {
- if (this.navigationBarItemsContains(item.childItems, name, kind))
- return;
- const missingItem = { name, kind };
- this.raiseError(`verifyNavigationBarChildItem failed - could not find the item: ${JSON.stringify(missingItem)} in the children list: (${JSON.stringify(item.childItems, undefined, 2)})`);
- }
- }
+ public verifyNavigationBar(json: any) {
+ let items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
+ items = this.simplifyNavigationBar(items);
+ if (JSON.stringify(items) !== JSON.stringify(json)) {
+ this.raiseError(`verifyNavigationBar failed - expected: ${JSON.stringify(json, undefined, 2)}, got: ${JSON.stringify(items, undefined, 2)}`)
+ }
+ }
+
+ // Remove any properties that tend to all have the same value so that test data is easier to read.
+ private simplifyNavigationBar(items: ts.NavigationBarItem[]): any {
+ return items.map(item => {
+ item = ts.clone(item);
+ if (item.kindModifiers === "")
+ delete item.kindModifiers;
+ delete item.spans;
+ item.childItems = item.childItems.map(child => {
+ child = ts.clone(child);
+ ts.Debug.assert(child.childItems.length === 0);
+ ts.Debug.assert(child.indent === 0);
+ ts.Debug.assert(child.bolded === false);
+ ts.Debug.assert(child.grayed === false);
+ delete child.childItems;
+ delete child.indent;
+ delete child.bolded;
+ delete child.grayed;
+ delete child.spans;
+ if (child.kindModifiers === "")
+ delete child.kindModifiers;
+ return child;
+ });
+ if (item.bolded === false)
+ delete item.bolded;
+ if (item.grayed === false)
+ delete item.grayed;
+ return item;
+ })
  }
 
  public printNavigationItems(searchValue: string) {
@@ -3041,23 +3013,8 @@ namespace FourSlashInterface {
  this.DocCommentTemplate(/*expectedText*/ undefined, /*expectedOffset*/ undefined, /*empty*/ true);
  }
 
- public navigationBarCount(count: number) {
- this.state.verifyNavigationBarCount(count);
- }
-
- // TODO: figure out what to do with the unused arguments.
- public navigationBarContains(
- name: string,
- kind: string,
- fileName?: string,
- parentName?: string,
- isAdditionalSpan?: boolean,
- markerPosition?: number) {
- this.state.verifyNavigationBarContains(name, kind, fileName, parentName, isAdditionalSpan, markerPosition);
- }
-
- public navigationBarChildItem(parent: string, name: string, kind: string) {
- this.state.verifyNavigationBarChildItem(parent, name, kind);
+ public navigationBar(json: any) {
+ this.state.verifyNavigationBar(json);
  }
 
  public navigationItemsListCount(count: number, searchValue: string, matchKind?: string) {

tests/cases/fourslash/deleteClassWithEnumPresent.ts

@@ -5,4 +5,35 @@
 
 goTo.marker();
 edit.deleteAtCaret('class Bar { }'.length);
-verify.navigationBarContains('Foo', 'enum', 'tests/cases/fourslash/deleteClassWithEnumPresent.ts', '');
+verify.navigationBar([
+ {
+ "text": "<global>",
+ "kind": "module",
+ "childItems": [
+ {
+ "text": "Foo",
+ "kind": "enum"
+ }
+ ],
+ "indent": 0
+ },
+ {
+ "text": "Foo",
+ "kind": "enum",
+ "childItems": [
+ {
+ "text": "a",
+ "kind": "property"
+ },
+ {
+ "text": "b",
+ "kind": "property"
+ },
+ {
+ "text": "c",
+ "kind": "property"
+ }
+ ],
+ "indent": 1
+ }
+]);

tests/cases/fourslash/fourslash.ts

@@ -175,9 +175,7 @@ declare namespace FourSlashInterface {
  DocCommentTemplate(expectedText: string, expectedOffset: number, empty?: boolean): void;
  noDocCommentTemplate(): void;
 
- navigationBarCount(count: number): void;
- navigationBarContains(name: string, kind: string, fileName?: string, parentName?: string, isAdditionalSpan?: boolean, markerPosition?: number): void;
- navigationBarChildItem(parent: string, text: string, kind: string): void;
+ navigationBar(json: any): void;
  navigationItemsListCount(count: number, searchValue: string, matchKind?: string): void;
  navigationItemsListContains(name: string, kind: string, searchValue: string, matchKind: string, fileName?: string, parentName?: string): void;
  occurrencesAtPositionContains(range: Range, isWriteAccess?: boolean): void;

tests/cases/fourslash/getNavigationBarItems.ts

@@ -5,7 +5,31 @@
 //// ["bar"]: string;
 ////}
 
-verify.navigationBarCount(5);
-verify.navigationBarContains("C", "class");
-verify.navigationBarChildItem("C", "[\"bar\"]", "property");
-verify.navigationBarChildItem("C", "foo", "property");
+verify.navigationBar([
+ {
+ "text": "<global>",
+ "kind": "module",
+ "childItems": [
+ {
+ "text": "C",
+ "kind": "class"
+ }
+ ],
+ "indent": 0
+ },
+ {
+ "text": "C",
+ "kind": "class",
+ "childItems": [
+ {
+ "text": "[\"bar\"]",
+ "kind": "property"
+ },
+ {
+ "text": "foo",
+ "kind": "property"
+ }
+ ],
+ "indent": 1
+ }
+])

tests/cases/fourslash/navbar_const.ts

@@ -1,13 +1,17 @@
 /// <reference path="fourslash.ts" />
 
-//// {| "itemName": "c", "kind": "const", "parentName": "<global>" |}const c = 0;
+//// const c = 0;
 
-test.markers().forEach(marker => {
- verify.navigationBarContains(
- marker.data.itemName,
- marker.data.kind,
- marker.fileName,
- marker.data.parentName,
- marker.data.isAdditionalRange,
- marker.position);
-});
+verify.navigationBar([
+ {
+ "text": "<global>",
+ "kind": "module",
+ "childItems": [
+ {
+ "text": "c",
+ "kind": "const"
+ }
+ ],
+ "indent": 0
+ }
+]);