microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-19 17:18:50 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Parse unexpected comments after email in author JSDoc tag (#17244)

Browse Source
This commit is contained in:
Peter Šándor 2019-02-09 17:17:09 +01:00
parent ea9d519424
commit 00279e9eca
No known key found for this signature in database
GPG Key ID: 463B58EC78FD6AB6
3 changed files with 47 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/compiler/parser.ts
View File

@ -468,6 +468,8 @@ namespace ts {
visitNode(cbNode, (<JSDocPropertyLikeTag>node).typeExpression)
: visitNode(cbNode, (<JSDocPropertyLikeTag>node).typeExpression) ||
visitNode(cbNode, (<JSDocPropertyLikeTag>node).name));
case SyntaxKind.JSDocAuthorTag:
return visitNode(cbNode, (node as JSDocTag).tagName);
case SyntaxKind.JSDocAugmentsTag:
return visitNode(cbNode, (node as JSDocTag).tagName) ||
visitNode(cbNode, (<JSDocAugmentsTag>node).class);
@ -6612,7 +6614,7 @@ namespace ts {
let tag: JSDocTag | undefined;
switch (tagName.escapedText) {
case "author":
tag = parseAuthorTag(start, tagName);
tag = parseAuthorTag(start, tagName, indent);
break;
case "augments":
case "extends":
@ -6877,14 +6879,22 @@ namespace ts {
return finishNode(result);
}
function parseAuthorTag(start: number, tagName: Identifier): JSDocAuthorTag {
function parseAuthorTag(start: number, tagName: Identifier, indent: number): JSDocAuthorTag {
const result = <JSDocAuthorTag>createNode(SyntaxKind.JSDocAuthorTag, start);
result.tagName = tagName;
const comment = tryParse(() => tryParseAuthorNameAndEmail());
const authorInfoWithEmail = tryParse(() => tryParseAuthorNameAndEmail());
if (!authorInfoWithEmail) {
return finishNode(result);
}
if (comment) {
result.comment = comment;
result.comment = authorInfoWithEmail;
if (lookAhead(() => nextToken() !== SyntaxKind.NewLineTrivia)) {
const comment = parseTagComments(indent);
if (comment) {
result.comment += comment;
}
}
return finishNode(result);
@ -6894,7 +6904,6 @@ namespace ts {
const comments: string[] = [];
let seenLessThan = false;
let seenGreaterThan = false;
let seenAtToken = false;
let token = scanner.getToken();
loop: while (true) {
@ -6902,31 +6911,24 @@ namespace ts {
case SyntaxKind.Identifier:
case SyntaxKind.WhitespaceTrivia:
case SyntaxKind.DotToken:
case SyntaxKind.AtToken:
comments.push(scanner.getTokenText());
break;
case SyntaxKind.LessThanToken:
if (seenLessThan || seenAtToken || seenGreaterThan) {
if (seenLessThan || seenGreaterThan) {
return;
}
seenLessThan = true;
comments.push(scanner.getTokenText());
break;
case SyntaxKind.GreaterThanToken:
if (!seenLessThan || !seenAtToken || seenGreaterThan) {
if (!seenLessThan || seenGreaterThan) {
return;
}
seenGreaterThan = true;
comments.push(scanner.getTokenText());
scanner.setTextPos(scanner.getTokenPos() + 1);
break loop;
case SyntaxKind.AtToken:
if (seenAtToken || !seenLessThan || seenGreaterThan) {
return;
}
seenAtToken = true;
comments.push(scanner.getTokenText());
break;
case SyntaxKind.NewLineTrivia:
case SyntaxKind.EndOfFileToken:
break loop;
@ -6935,7 +6937,7 @@ namespace ts {
token = nextJSDocToken();
}
if (seenLessThan && seenAtToken && seenGreaterThan) {
if (seenLessThan && seenGreaterThan) {
return comments.length === 0 ? undefined : comments.join("");
}
}

1
src/testRunner/unittests/jsDocParsing.ts
View File

@ -317,6 +317,7 @@ namespace ts {
parsesCorrectly("authorTag",
`/**
* @author John Doe <john.doe@example.com>
* @author John Doe <john.doe@example.com> unexpected comment
*/`);
});
});

30
tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.authorTag.json
View File

@ -1,22 +1,44 @@
{
"kind": "JSDocComment",
"pos": 0,
"end": 50,
"end": 112,
"modifierFlagsCache": 0,
"transformFlags": 0,
"tags": {
"0": {
"kind": "JSDocAuthorTag",
"pos": 7,
"end": 45,
"end": 50,
"modifierFlagsCache": 0,
"transformFlags": 0,
"tagName": {
"kind": "Identifier",
"pos": 8,
"end": 14,
"modifierFlagsCache": 0,
"transformFlags": 0,
"escapedText": "author"
},
"comment": "John Doe <john.doe@example.com>"
},
"length": 1,
"1": {
"kind": "JSDocAuthorTag",
"pos": 50,
"end": 110,
"modifierFlagsCache": 0,
"transformFlags": 0,
"tagName": {
"kind": "Identifier",
"pos": 51,
"end": 57,
"modifierFlagsCache": 0,
"transformFlags": 0,
"escapedText": "author"
},
"comment": "John Doe <john.doe@example.com> unexpected comment"
},
"length": 2,
"pos": 7,
"end": 45
"end": 110
}
}