Skip to content

Run fixupParentReferences when parsing isolated jsDocComment #8930

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 2, 2016
Merged

Run fixupParentReferences when parsing isolated jsDocComment #8930

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e96c5e
Run fixupParentReferences when parsing isolated jsDocComment
zhengbli Jun 2, 2016
d41ac8a
Add null check and CR feedback
zhengbli Jun 2, 2016
e2a1a78
reuse the fixupParentReferences function
zhengbli Jun 2, 2016
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
21 changes: 20 additions & 1 deletion src/compiler/parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,26 @@ namespace ts {

/* @internal */
export function parseIsolatedJSDocComment(content: string, start?: number, length?: number) {
return Parser.JSDocParser.parseIsolatedJSDocComment(content, start, length);
const result = Parser.JSDocParser.parseIsolatedJSDocComment(content, start, length);
if (result.jsDocComment) {
// because the jsDocComment was parsed out of the source file, it might
// not be covered by the fixupParentReferences.
let parentNode: Node = result.jsDocComment;
Copy link
Contributor

@vladima vladima Jun 2, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you just call fixupParentReferences here and pass result.jsDocComment as a parameter instead of copying the code?

Copy link
Contributor Author

@zhengbli zhengbli Jun 2, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be better, as I was thinking the fixupParentReferences was supposed to be called only for sourceFile nodes. Changing that.

forEachChild(result.jsDocComment, visitNode);

function visitNode(n: Node): void {
if (n.parent !== parentNode) {
Copy link
Member

@DanielRosenwasser DanielRosenwasser Jun 2, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd expect the check here to be n.parent === undefined. Is there ever a case where the node has a parent but it's not the current parent? That seems like it should never happen.

Copy link
Contributor Author

@zhengbli zhengbli Jun 2, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this might happen during incremental parsing; however as the jsDocComment is parsed in isolation, it is always parsed from scratch, so you are right that it should never happen. Will update.

n.parent = parentNode;

const saveParent = parentNode;
parentNode = n;
forEachChild(n, visitNode);
parentNode = saveParent;
}
}
}

return result;
}

/* @internal */
Expand Down
22 changes: 22 additions & 0 deletions tests/cases/fourslash/syntacticClassificationForJSDocTemplateTag.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/// <reference path="fourslash.ts"/>

/////** @template T */
////function ident<T>: T {
////}

var c = classification;
verify.syntacticClassificationsAre(
c.comment("/** "),
c.punctuation("@"),
c.docCommentTagName("template"),
c.typeParameterName("T"),
c.comment(" */"),
c.keyword("function"),
c.identifier("ident"),
c.punctuation("<"),
c.typeParameterName("T"),
c.punctuation(">"),
c.punctuation(":"),
c.identifier("T"),
c.punctuation("{"),
c.punctuation("}"));