Skip to content

Navigation bar class expression #8648

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.

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
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
32 changes: 28 additions & 4 deletions src/harness/fourslash.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1989,6 +1989,17 @@ namespace FourSlash {
return result;
}

public verifyNavigationBarIndex(name: string, index: number) {
const items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
if (!items[index]) {
this.raiseError(`verifyNavigationBarIndex failed - No item at index ${index}`);
}
const actual = items[index].text;
if (actual !== name) {
this.raiseError(`verifyNavigationBarIndex failed - Item at index ${index} is named ${actual} instead of ${name}.`);
}
}

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);
Expand Down Expand Up @@ -2047,15 +2058,24 @@ namespace FourSlash {
}
}

public printNavigationBar() {
public printNavigationBar(showChildItems = false) {
const items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
const length = items && items.length;

Harness.IO.log(`Navigation bar (${length} items)`);

for (let i = 0; i < length; i++) {
const item = items[i];
Harness.IO.log(`name: ${item.text}, kind: ${item.kind}`);
const childrenText = showChildItems ? `, children: ${item.childItems.map(child => child.text)}` : "";
Harness.IO.log(`${strRepeat(" ", item.indent)}name: ${item.text}, kind: ${item.kind}${childrenText}`);
}

function strRepeat(str: string, times: number) {
let out = "";
for (let i = 0; i < times; i++) {
out += str;
}
return out;
}
}

Expand Down Expand Up @@ -3047,6 +3067,10 @@ namespace FourSlashInterface {
this.state.verifyNavigationBarCount(count);
}

public navigationBarIndex(name: string, index: number) {
this.state.verifyNavigationBarIndex(name, index);
}

// TODO: figure out what to do with the unused arguments.
public navigationBarContains(
name: string,
Expand Down Expand Up @@ -3252,8 +3276,8 @@ namespace FourSlashInterface {
this.state.printNavigationItems(searchValue);
}

public printNavigationBar() {
this.state.printNavigationBar();
public printNavigationBar(showChildItems = false) {
this.state.printNavigationBar(showChildItems);
}

public printReferences() {
Expand Down
306 changes: 180 additions & 126 deletions src/services/navigationBar.ts

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion tests/cases/fourslash/fourslash.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ declare namespace FourSlashInterface {
noDocCommentTemplate(): void;

navigationBarCount(count: number): void;
navigationBarIndex(name: string, index: number): void;
navigationBarContains(name: string, kind: string, fileName?: string, parentName?: string, isAdditionalSpan?: boolean, markerPosition?: number): void;
navigationBarChildItem(parent: string, text: string, kind: string): void;
navigationItemsListCount(count: number, searchValue: string, matchKind?: string): void;
Expand Down Expand Up @@ -237,7 +238,7 @@ declare namespace FourSlashInterface {
printBreakpointAtCurrentLocation(): void;
printNameOrDottedNameSpans(pos: number): void;
printErrorList(): void;
printNavigationBar(): void;
printNavigationBar(showChildItems?: boolean): void;
printNavigationItems(searchValue?: string): void;
printScriptLexicalStructureItems(): void;
printReferences(): void;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/// <reference path="fourslash.ts" />

////global.cls = class { };
////(function() {
//// const x = () => {
//// // Presence of inner function causes x to be a top-level function.
//// function xx() {}
//// };
//// const y = {
//// // This is not a top-level function (contains nothing, but shows up in childItems of its parent.)
//// foo: function() {}
//// };
//// (function nest() {
//// function moreNest() {}
//// })();
////})();
////(function() { // Different anonymous functions are not merged
//// These will only show up as childItems.
//// function z() {}
//// console.log(function() {})
////})
////(function classes() {
//// // Classes show up in top-level regardless of whether they have names or inner declarations.
//// const cls2 = class { };
//// console.log(class cls3 {});
//// (class { });
////})

verify.navigationBarCount(21);
verify.navigationBarIndex("<global>", 0);
verify.navigationBarIndex("<function>", 1);
verify.navigationBarIndex("x", 2);
verify.navigationBarIndex("nest", 3);
verify.navigationBarIndex("<function>", 4);
verify.navigationBarIndex("global.cls", 5);
verify.navigationBarIndex("classes", 6);
verify.navigationBarIndex("cls2", 7);
verify.navigationBarIndex("<class>", 8);
verify.navigationBarIndex("cls3", 9);

verify.navigationBarContains("global.cls", "class");

14 changes: 14 additions & 0 deletions tests/cases/fourslash/navigationBarDeclarationExpressions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/// <reference path="fourslash.ts" />

////console.log(console.log(class Y {}, class X {}), console.log(class B {}, class A {}));
////console.log(class Cls { meth() {} });

verify.navigationBarCount(6);
verify.navigationBarIndex("A", 0);
verify.navigationBarIndex("B", 1);
verify.navigationBarIndex("Cls", 2);
verify.navigationBarIndex("X", 3);
verify.navigationBarIndex("Y", 4);

verify.navigationBarContains("Cls", "class");
verify.navigationBarChildItem("Cls", "meth", "method");
2 changes: 1 addition & 1 deletion tests/cases/fourslash/navigationBarItemsFunctions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ test.markers().forEach((marker) => {
verify.navigationBarContains(marker.data.itemName, marker.data.kind, marker.fileName, marker.data.parentName);
});

verify.navigationBarCount(8); // 4 functions + global. Note: there are 8 because of the functions show up at the top level and as child items.
verify.navigationBarCount(11); // Includes many nested functions, with duplications as they appear both at top-level and as childItems
2 changes: 1 addition & 1 deletion tests/cases/fourslash/navigationBarItemsFunctionsBroken.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ test.markers().forEach((marker) => {
verify.navigationBarContains(marker.data.itemName, marker.data.kind, marker.fileName, marker.data.parentName);
});

verify.navigationBarCount(3); // <global> and 'f'.
verify.navigationBarCount(4); // <global> with child 'f' and 'f' with child '<function>'.
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ test.markers().forEach((marker) => {
verify.navigationBarContains(marker.data.itemName, marker.data.kind, marker.fileName, marker.data.parentName);
});

verify.navigationBarCount(3); // <global> and 'f'
verify.navigationBarCount(5); // <global> with children '<function>' and 'f', and 'f' with child '<function>'

This file was deleted.

16 changes: 0 additions & 16 deletions tests/cases/fourslash/navigationBarItemsMissingName1.ts

This file was deleted.