support @extends in jsdoc #18706
Merged
support @extends in jsdoc #18706
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhegazy
reviewed
Sep 23, 2017
src/compiler/utilities.ts
Outdated
| @@ -4765,8 +4765,8 @@ namespace ts { | |||
| return node.kind === SyntaxKind.JSDocComment; | |||
| } | |||
|
|
|||
| export function isJSDocAugmentsTag(node: Node): node is JSDocAugmentsTag { | |||
| return node.kind === SyntaxKind.JSDocAugmentsTag; | |||
| export function isJSDocAugmentsOrExtendsTag(node: Node): node is JSDocAugmentsOrExtendsTag { | |||
There was a problem hiding this comment.
this is part of the public API now, we should not break that.
weswigham
reviewed
Sep 26, 2017
src/compiler/parser.ts
Outdated
| case SyntaxKind.JSDocAugmentsTag: | ||
| return visitNode(cbNode, (<JSDocAugmentsTag>node).typeExpression); | ||
| case SyntaxKind.JSDocAugmentsOrExtendsTag: | ||
| case SyntaxKind.JSDocExtendsTag: |
There was a problem hiding this comment.
It seems like SyntaxKind.JSDocExtendsTag is never assigned anywhere?
ghost
mentioned this pull request
sandersn
requested changes
Sep 27, 2017
src/compiler/types.ts
Outdated
| @@ -363,7 +363,8 @@ namespace ts { | |||
| JSDocVariadicType, | |||
| JSDocComment, | |||
| JSDocTag, | |||
| JSDocAugmentsTag, | |||
| JSDocAugmentsOrExtendsTag, | |||
There was a problem hiding this comment.
I think we should keep JSDocAugmentsTag and just let @extends be a silent synonym for it in the parser. I don't think it's bad, for example, if the roundtrip emit converts @extends to @augment. And that's the worst side-effect I can think of.
ghost
mentioned this pull request
|
@sandersn mentioned in #18854 (review) that we should have an error if both |
sandersn
reviewed
Oct 6, 2017
| @@ -4247,6 +4247,12 @@ namespace ts { | |||
| return find(tags, doc => doc.kind === kind); | |||
| } | |||
|
|
|||
| /** Gets all JSDoc tags of a specified kind, or undefined if not present. */ | |||
| export function getAllJSDocTagsOfKind(node: Node, kind: SyntaxKind): ReadonlyArray<JSDocTag> | undefined { | |||
sandersn
approved these changes
Oct 6, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #18701