support @extends in jsdoc #18706
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,116 @@ | ||
| // @module: commonjs | ||
| // @includebuiltfile: typescript_standalone.d.ts | ||
| // @strict:true | ||
| /* | ||
| * Note: This test is a public API sample. The original sources can be found | ||
| * at: https://github.com/YousefED/typescript-json-schema | ||
| * https://github.com/vega/ts-json-schema-generator | ||
| * Please log a "breaking change" issue for any API breaking change affecting this issue | ||
| */ | ||
| declare var console: any; | ||
| import * as ts from "typescript"; | ||
| // excerpted from https://github.com/YousefED/typescript-json-schema | ||
| // (converted from a method and modified; for example, `this: any` to compensate, among other changes) | ||
| function parseCommentsIntoDefinition(this: any, | ||
| symbol: ts.Symbol, | ||
| definition: {description?: string, [s: string]: string | undefined}, | ||
| otherAnnotations: { [s: string]: true}): void { | ||
| if (!symbol) { | ||
| return; | ||
| } | ||
| // the comments for a symbol | ||
| let comments = symbol.getDocumentationComment(); | ||
| if (comments.length) { | ||
| definition.description = comments.map(comment => comment.kind === "lineBreak" ? comment.text : comment.text.trim().replace(/\r\n/g, "\n")).join(""); | ||
| } | ||
| // jsdocs are separate from comments | ||
| const jsdocs = symbol.getJsDocTags(); | ||
| jsdocs.forEach(doc => { | ||
| // if we have @TJS-... annotations, we have to parse them | ||
| const { name, text } = doc; | ||
| if (this.userValidationKeywords[name]) { | ||
| definition[name] = this.parseValue(text); | ||
| } else { | ||
| // special annotations | ||
| otherAnnotations[doc.name] = true; | ||
| } | ||
| }); | ||
| } | ||
| // excerpted from https://github.com/vega/ts-json-schema-generator | ||
| export interface Annotations { | ||
| [name: string]: any; | ||
| } | ||
| function getAnnotations(this: any, node: ts.Node): Annotations | undefined { | ||
| const symbol: ts.Symbol = (node as any).symbol; | ||
| if (!symbol) { | ||
| return undefined; | ||
| } | ||
| const jsDocTags: ts.JSDocTagInfo[] = symbol.getJsDocTags(); | ||
| if (!jsDocTags || !jsDocTags.length) { | ||
| return undefined; | ||
| } | ||
| const annotations: Annotations = jsDocTags.reduce((result: Annotations, jsDocTag: ts.JSDocTagInfo) => { | ||
| const value = this.parseJsDocTag(jsDocTag); | ||
| if (value !== undefined) { | ||
| result[jsDocTag.name] = value; | ||
| } | ||
| return result; | ||
| }, {}); | ||
| return Object.keys(annotations).length ? annotations : undefined; | ||
| } | ||
| // these examples are artificial and mostly nonsensical | ||
| function parseSpecificTags(node: ts.Node) { | ||
| if (node.kind === ts.SyntaxKind.Parameter) { | ||
| return ts.getJSDocParameterTags(node as ts.ParameterDeclaration); | ||
| } | ||
| if (node.kind === ts.SyntaxKind.FunctionDeclaration) { | ||
| const func = node as ts.FunctionDeclaration; | ||
| if (ts.hasJSDocParameterTags(func)) { | ||
| const flat: ts.JSDocTag[] = []; | ||
| for (const tags of func.parameters.map(ts.getJSDocParameterTags)) { | ||
| if (tags) flat.push(...tags); | ||
| } | ||
| return flat; | ||
| } | ||
| } | ||
| } | ||
| function getReturnTypeFromJSDoc(node: ts.Node) { | ||
| if (node.kind === ts.SyntaxKind.FunctionDeclaration) { | ||
| return ts.getJSDocReturnType(node); | ||
| } | ||
| let type = ts.getJSDocType(node); | ||
| if (type && type.kind === ts.SyntaxKind.FunctionType) { | ||
| return (type as ts.FunctionTypeNode).type; | ||
| } | ||
| } | ||
| function getAllTags(node: ts.Node) { | ||
| ts.getJSDocTags(node); | ||
| } | ||
| function getSomeOtherTags(node: ts.Node) { | ||
| const tags: (ts.JSDocTag | undefined)[] = []; | ||
| tags.push(ts.getJSDocAugmentsOrExtendsTag(node)); | ||
| tags.push(ts.getJSDocClassTag(node)); | ||
| tags.push(ts.getJSDocReturnTag(node)); | ||
| const type = ts.getJSDocTypeTag(node); | ||
| if (type) { | ||
| tags.push(type); | ||
| } | ||
| tags.push(ts.getJSDocTemplateTag(node)); | ||
| return tags; | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| ///<reference path="fourslash.ts" /> | ||
|
|
||
| // @allowJs: true | ||
| // @Filename: dummy.js | ||
|
|
||
| //// /** | ||
| //// * @extends {Thing<string>} | ||
| //// */ | ||
| //// class MyStringThing extends Thing { | ||
| //// constructor() { | ||
| //// var x = this.mine; | ||
| //// x/**/; | ||
| //// } | ||
| //// } | ||
|
|
||
| // @Filename: declarations.d.ts | ||
| //// declare class Thing<T> { | ||
| //// mine: T; | ||
| //// } | ||
|
|
||
| goTo.marker(); | ||
| verify.quickInfoIs("(local var) x: string"); |
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.
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.
It seems like
SyntaxKind.JSDocExtendsTagis never assigned anywhere?