-
Notifications
You must be signed in to change notification settings - Fork 12.6k
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
Lexical colorization/classification for template strings. #2026
Changes from 8 commits
ea30c68
3429fab
f1f085e
3fea0ae
ab79fae
1838800
15b333e
65e23b1
1dca562
a1b90f0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1143,6 +1143,9 @@ module ts { | |
InMultiLineCommentTrivia, | ||
InSingleQuoteStringLiteral, | ||
InDoubleQuoteStringLiteral, | ||
InTemplateHeadOrNoSubstitutionTemplate, | ||
InTemplateMiddleOrTail, | ||
InTemplateSubstitutionPosition, | ||
} | ||
|
||
export enum TokenClass { | ||
|
@@ -1168,7 +1171,7 @@ module ts { | |
} | ||
|
||
export interface Classifier { | ||
getClassificationsForLine(text: string, lexState: EndOfLineState, classifyKeywordsInGenerics?: boolean): ClassificationResult; | ||
getClassificationsForLine(text: string, lexState: EndOfLineState, syntacticClassifierAbsent?: boolean): ClassificationResult; | ||
} | ||
|
||
/** | ||
|
@@ -5617,6 +5620,10 @@ module ts { | |
noRegexTable[SyntaxKind.TrueKeyword] = true; | ||
noRegexTable[SyntaxKind.FalseKeyword] = true; | ||
|
||
// Just a stack of TemplateHeads and OpenCurlyBraces, used | ||
// to perform rudimentary classification on templates. | ||
var templateStack: SyntaxKind[] = []; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Explain that rudimentary means 'inexact' and give example of where template classification will be wrong. |
||
|
||
function isAccessibilityModifier(kind: SyntaxKind) { | ||
switch (kind) { | ||
case SyntaxKind.PublicKeyword: | ||
|
@@ -5650,13 +5657,19 @@ module ts { | |
// if there are more cases we want the classifier to be better at. | ||
return true; | ||
} | ||
|
||
// 'classifyKeywordsInGenerics' should be 'true' when a syntactic classifier is not present. | ||
function getClassificationsForLine(text: string, lexState: EndOfLineState, classifyKeywordsInGenerics?: boolean): ClassificationResult { | ||
|
||
// If there is a syntactic classifier ('syntacticClassifierAbsent' is false), | ||
// we will be more conservative in order to avoid conflicting with the syntactic classifier. | ||
function getClassificationsForLine(text: string, lexState: EndOfLineState, syntacticClassifierAbsent?: boolean): ClassificationResult { | ||
var offset = 0; | ||
var token = SyntaxKind.Unknown; | ||
var lastNonTriviaToken = SyntaxKind.Unknown; | ||
|
||
// Empty out the template stack for reuse. | ||
while (templateStack.length > 0) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. templateStack.length = 0 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's actually faster to do it this way. |
||
templateStack.pop(); | ||
} | ||
|
||
// If we're in a string literal, then prepend: "\ | ||
// (and a newline). That way when we lex we'll think we're still in a string literal. | ||
// | ||
|
@@ -5675,6 +5688,17 @@ module ts { | |
text = "/*\n" + text; | ||
offset = 3; | ||
break; | ||
case EndOfLineState.InTemplateHeadOrNoSubstitutionTemplate: | ||
text = "`\n" + text; | ||
offset = 2; | ||
break; | ||
case EndOfLineState.InTemplateMiddleOrTail: | ||
text = "}\n" + text; | ||
offset = 2; | ||
// fallthrough | ||
case EndOfLineState.InTemplateSubstitutionPosition: | ||
templateStack.push(SyntaxKind.TemplateHead); | ||
break; | ||
} | ||
|
||
scanner.setText(text); | ||
|
@@ -5739,12 +5763,45 @@ module ts { | |
token === SyntaxKind.StringKeyword || | ||
token === SyntaxKind.NumberKeyword || | ||
token === SyntaxKind.BooleanKeyword) { | ||
if (angleBracketStack > 0 && !classifyKeywordsInGenerics) { | ||
// If it looks like we're could be in something generic, don't classify this | ||
// as a keyword. We may just get overwritten by the syntactic classifier, | ||
// causing a noisy experience for the user. | ||
token = SyntaxKind.Identifier; | ||
} | ||
if (angleBracketStack > 0 && !syntacticClassifierAbsent) { | ||
// If it looks like we're could be in something generic, don't classify this | ||
// as a keyword. We may just get overwritten by the syntactic classifier, | ||
// causing a noisy experience for the user. | ||
token = SyntaxKind.Identifier; | ||
} | ||
} | ||
else if (token === SyntaxKind.TemplateHead) { | ||
templateStack.push(token); | ||
} | ||
else if (token === SyntaxKind.OpenBraceToken) { | ||
// If we don't have anything on the template stack, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i don't understand your comment wrapping. |
||
// then we aren't trying to keep track of a previously scanned template head. | ||
if (templateStack.length > 0) { | ||
templateStack.push(token); | ||
} | ||
} | ||
else if (token === SyntaxKind.CloseBraceToken) { | ||
// If we don't have anything on the template stack, | ||
// then we aren't trying to keep track of a previously scanned template head. | ||
if (templateStack.length > 0) { | ||
var lastTemplateStackToken = lastOrUndefined(templateStack); | ||
|
||
if (lastTemplateStackToken === SyntaxKind.TemplateHead) { | ||
token = scanner.reScanTemplateToken(); | ||
|
||
// Only pop on a TemplateTail; a TemplateMiddle indicates there is more for us. | ||
if (token === SyntaxKind.TemplateTail) { | ||
templateStack.pop(); | ||
} | ||
else { | ||
Debug.assert(token === SyntaxKind.TemplateMiddle, "Should have been a template middle. Was " + token); | ||
} | ||
} | ||
else { | ||
Debug.assert(lastTemplateStackToken === SyntaxKind.OpenBraceToken, "Should have been an open brace. Was: " + token); | ||
templateStack.pop(); | ||
} | ||
} | ||
} | ||
|
||
lastNonTriviaToken = token; | ||
|
@@ -5789,6 +5846,22 @@ module ts { | |
result.finalLexState = EndOfLineState.InMultiLineCommentTrivia; | ||
} | ||
} | ||
else if (isTemplateLiteralKind(token)) { | ||
if (scanner.isUnterminated()) { | ||
if (token === SyntaxKind.TemplateTail) { | ||
result.finalLexState = EndOfLineState.InTemplateMiddleOrTail; | ||
} | ||
else if (token === SyntaxKind.NoSubstitutionTemplateLiteral) { | ||
result.finalLexState = EndOfLineState.InTemplateHeadOrNoSubstitutionTemplate; | ||
} | ||
else { | ||
Debug.fail("Only 'NoSubstitutionTemplateLiteral's and 'TemplateTail's can be unterminated; got SyntaxKind #" + token); | ||
} | ||
} | ||
} | ||
else if (templateStack.length > 0 && lastOrUndefined(templateStack) === SyntaxKind.TemplateHead) { | ||
result.finalLexState = EndOfLineState.InTemplateSubstitutionPosition; | ||
} | ||
} | ||
} | ||
|
||
|
@@ -5892,6 +5965,9 @@ module ts { | |
return TokenClass.Whitespace; | ||
case SyntaxKind.Identifier: | ||
default: | ||
if (isTemplateLiteralKind(token)) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
return TokenClass.StringLiteral; // maybe make a TemplateLiteral | ||
} | ||
return TokenClass.Identifier; | ||
} | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment the purpose of this parameter so that consumers of the LS know what they should pass and how hte classifiers interact