maxmustermann/TypeScript
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #32672 from armanio123/FixNavbarMultiline

Browse source 
Fixed issue for navbar when having multi-line string literals
This commit is contained in:
Armando Aguirre 2019-08-23 15:02:25 -07:00 committed by GitHub
parent 5b59cfb1c4 f76e3b59b2
commit 25f609b3a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 184 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
src/services/navigationBar.ts
View file

@ -15,6 +15,12 @@ namespace ts.NavigationBar {
*/
const whiteSpaceRegex = /\s+/g;
/**
* Maximum amount of characters to return
* The amount was choosen arbitrarily.
*/
const maxLength = 150;
// Keep sourceFile handy so we don't have to search for it every time we need to call `getText`.
let curCancellationToken: CancellationToken;
let curSourceFile: SourceFile;
@ -74,7 +80,7 @@ namespace ts.NavigationBar {
}
function nodeText(node: Node): string {
return node.getText(curSourceFile);
return cleanText(node.getText(curSourceFile));
}
function navigationBarNodeKind(n: NavigationBarNode): SyntaxKind {
@ -194,7 +200,7 @@ namespace ts.NavigationBar {
// Handle named bindings in imports e.g.:
// import * as NS from "mod";
// import {a, b as B} from "mod";
const {namedBindings} = importClause;
const { namedBindings } = importClause;
if (namedBindings) {
if (namedBindings.kind === SyntaxKind.NamespaceImport) {
addLeafNode(namedBindings);
@ -434,13 +440,13 @@ namespace ts.NavigationBar {
function getItemName(node: Node, name: Node | undefined): string {
if (node.kind === SyntaxKind.ModuleDeclaration) {
return getModuleName(<ModuleDeclaration>node);
return cleanText(getModuleName(<ModuleDeclaration>node));
}
if (name) {
const text = nodeText(name);
if (text.length > 0) {
return text;
return cleanText(text);
}
}
@ -636,11 +642,11 @@ namespace ts.NavigationBar {
function getFunctionOrClassName(node: FunctionExpression | FunctionDeclaration | ArrowFunction | ClassLikeDeclaration): string {
const { parent } = node;
if (node.name && getFullWidth(node.name) > 0) {
return declarationNameToString(node.name);
return cleanText(declarationNameToString(node.name));
}
// See if it is a var initializer. If so, use the var name.
else if (isVariableDeclaration(parent)) {
return declarationNameToString(parent.name);
return cleanText(declarationNameToString(parent.name));
}
// See if it is of the form "<expr> = function(){...}". If so, use the text from the left-hand side.
else if (isBinaryExpression(parent) && parent.operatorToken.kind === SyntaxKind.EqualsToken) {
@ -658,9 +664,15 @@ namespace ts.NavigationBar {
return "<class>";
}
else if (isCallExpression(parent)) {
const name = getCalledExpressionName(parent.expression);
let name = getCalledExpressionName(parent.expression);
if (name !== undefined) {
const args = mapDefined(parent.arguments, a => isStringLiteralLike(a) ? a.getText(curSourceFile) : undefined).join(", ");
name = cleanText(name);
if (name.length > maxLength) {
return `${name} callback`;
}
const args = cleanText(mapDefined(parent.arguments, a => isStringLiteralLike(a) ? a.getText(curSourceFile) : undefined).join(", "));
return `${name}(${args}) callback`;
}
}
@ -691,4 +703,16 @@ namespace ts.NavigationBar {
return false;
}
}
function cleanText(text: string): string {
// Truncate to maximum amount of characters as we don't want to do a big replace operation.
text = text.length > maxLength ? text.substring(0, maxLength) + "..." : text;
// Replaces ECMAScript line terminators and removes the trailing `\` from each line:
// \n - Line Feed
// \r - Carriage Return
// \u2028 - Line separator
// \u2029 - Paragraph separator
return text.replace(/\\(\r?\n|\r|\u2028|\u2029)/g, "");
}
}

50
tests/cases/fourslash/navigationBarItemsMultilineStringIdentifiers.ts → tests/cases/fourslash/navigationBarItemsMultilineStringIdentifiers1.ts
View file

@ -7,6 +7,10 @@
////}
////declare module "MultilineMadness" {}
////
////declare module "Multiline\
////Madness2" {
////}
////
////interface Foo {
//// "a1\\\r\nb";
//// "a2\
@ -29,7 +33,12 @@ verify.navigationTree({
"kind": "script",
"childItems": [
{
"text": "\"Multiline\\\nMadness\"",
"text": "\"MultilineMadness\"",
"kind": "module",
"kindModifiers": "declare"
},
{
"text": "\"MultilineMadness2\"",
"kind": "module",
"kindModifiers": "declare"
},
@ -38,11 +47,6 @@ verify.navigationTree({
"kind": "module",
"kindModifiers": "declare"
},
{
"text": "\"MultilineMadness\"",
"kind": "module",
"kindModifiers": "declare"
},
{
"text": "Bar",
"kind": "class",
@ -52,7 +56,7 @@ verify.navigationTree({
"kind": "property"
},
{
"text": "'a2\\\n \\\n b'",
"text": "'a2 b'",
"kind": "method"
}
]
@ -66,7 +70,7 @@ verify.navigationTree({
"kind": "property"
},
{
"text": "\"a2\\\n \\\n b\"",
"text": "\"a2 b\"",
"kind": "method"
}
]
@ -80,7 +84,12 @@ verify.navigationBar([
"kind": "script",
"childItems": [
{
"text": "\"Multiline\\\nMadness\"",
"text": "\"MultilineMadness\"",
"kind": "module",
"kindModifiers": "declare"
},
{
"text": "\"MultilineMadness2\"",
"kind": "module",
"kindModifiers": "declare"
},
@ -89,11 +98,6 @@ verify.navigationBar([
"kind": "module",
"kindModifiers": "declare"
},
{
"text": "\"MultilineMadness\"",
"kind": "module",
"kindModifiers": "declare"
},
{
"text": "Bar",
"kind": "class"
@ -105,7 +109,13 @@ verify.navigationBar([
]
},
{
"text": "\"Multiline\\\nMadness\"",
"text": "\"MultilineMadness\"",
"kind": "module",
"kindModifiers": "declare",
"indent": 1
},
{
"text": "\"MultilineMadness2\"",
"kind": "module",
"kindModifiers": "declare",
"indent": 1
@ -116,12 +126,6 @@ verify.navigationBar([
"kindModifiers": "declare",
"indent": 1
},
{
"text": "\"MultilineMadness\"",
"kind": "module",
"kindModifiers": "declare",
"indent": 1
},
{
"text": "Bar",
"kind": "class",
@ -131,7 +135,7 @@ verify.navigationBar([
"kind": "property"
},
{
"text": "'a2\\\n \\\n b'",
"text": "'a2 b'",
"kind": "method"
}
],
@ -146,7 +150,7 @@ verify.navigationBar([
"kind": "property"
},
{
"text": "\"a2\\\n \\\n b\"",
"text": "\"a2 b\"",
"kind": "method"
}
],

85
tests/cases/fourslash/navigationBarItemsMultilineStringIdentifiers2.ts Normal file
View file

@ -0,0 +1,85 @@
//// function f(p1: () => any, p2: string) { }
//// f(() => { }, `line1\
//// line2\
//// line3`);
////
//// class c1 {
//// const a = ' ''line1\
//// line2';
//// }
verify.navigationTree({
"text": "<global>",
"kind": "script",
"childItems": [
{
"text": "c1",
"kind": "class",
"childItems": [
{
"text": "a",
"kind": "property"
},
{
"text": "'line1 line2'",
"kind": "property"
}
]
},
{
"text": "f",
"kind": "function"
},
{
"text": "f(`line1line2line3`) callback",
"kind": "function"
}
]
});
verify.navigationBar([
{
"text": "<global>",
"kind": "script",
"childItems": [
{
"text": "c1",
"kind": "class"
},
{
"text": "f",
"kind": "function"
},
{
"text": "f(`line1line2line3`) callback",
"kind": "function"
}
]
},
{
"text": "c1",
"kind": "class",
"childItems": [
{
"text": "a",
"kind": "property"
},
{
"text": "'line1 line2'",
"kind": "property"
}
],
"indent": 1
},
{
"text": "f",
"kind": "function",
"indent": 1
},
{
"text": "f(`line1line2line3`) callback",
"kind": "function",
"indent": 1
}
]);

40
tests/cases/fourslash/navigationBarItemsMultilineStringIdentifiers3.ts Normal file
View file

@ -0,0 +1,40 @@
//// declare module 'MoreThanOneHundredAndFiftyCharacters\
//// MoreThanOneHundredAndFiftyCharacters\
//// MoreThanOneHundredAndFiftyCharacters\
//// MoreThanOneHundredAndFiftyCharacters\
//// MoreThanOneHundredAndFiftyCharacters\
//// MoreThanOneHundredAndFiftyCharacters\
//// MoreThanOneHundredAndFiftyCharacters' { }
verify.navigationTree({
"text": "<global>",
"kind": "script",
"childItems": [
{
"text": "'MoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharacter...",
"kind": "module",
"kindModifiers": "declare"
}
]
});
verify.navigationBar([
{
"text": "<global>",
"kind": "script",
"childItems": [
{
"text": "'MoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharacter...",
"kind": "module",
"kindModifiers": "declare"
}
]
},
{
"text": "'MoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharactersMoreThanOneHundredAndFiftyCharacter...",
"kind": "module",
"kindModifiers": "declare",
"indent": 1
}
]);