microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-05 08:11:30 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

fix(56602): JSDoc render with @param Sub-object properties (#56657)

Browse Source
This commit is contained in:
Oleksandr T 2023-12-13 23:02:14 +02:00 committed by GitHub
parent 0b03c80260
commit d84be8ed2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 252 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/services/jsDoc.ts
View File

@ -8,6 +8,7 @@ import {
CompletionEntry,
CompletionEntryDetails,
Completions,
concatenate,
ConstructorDeclaration,
contains,
Declaration,
@ -258,17 +259,21 @@ export function getJsDocTagsFromDeclarations(declarations?: Declaration[], check
}
for (const tag of tags) {
infos.push({ name: tag.tagName.text, text: getCommentDisplayParts(tag, checker) });
if (isJSDocPropertyLikeTag(tag) && tag.isNameFirst && tag.typeExpression && isJSDocTypeLiteral(tag.typeExpression.type)) {
forEach(tag.typeExpression.type.jsDocPropertyTags, propTag => {
infos.push({ name: propTag.tagName.text, text: getCommentDisplayParts(propTag, checker) });
});
}
infos.push(...getJSDocPropertyTagsInfo(tryGetJSDocPropertyTags(tag), checker));
}
});
return infos;
}
function getJSDocPropertyTagsInfo(nodes: readonly JSDocTag[] | undefined, checker: TypeChecker | undefined): readonly JSDocTagInfo[] {
return flatMap(nodes, propTag => concatenate([{ name: propTag.tagName.text, text: getCommentDisplayParts(propTag, checker) }], getJSDocPropertyTagsInfo(tryGetJSDocPropertyTags(propTag), checker)));
}
function tryGetJSDocPropertyTags(node: JSDocTag) {
return isJSDocPropertyLikeTag(node) && node.isNameFirst && node.typeExpression &&
isJSDocTypeLiteral(node.typeExpression.type) ? node.typeExpression.type.jsDocPropertyTags : undefined;
}
function getDisplayPartsFromComment(comment: string | readonly JSDocComment[], checker: TypeChecker | undefined): SymbolDisplayPart[] {
if (typeof comment === "string") {
return [textPart(comment)];

227
tests/baselines/reference/quickInfoJsDocTags14.baseline Normal file
View File

@ -0,0 +1,227 @@
// === QuickInfo ===
=== /tests/cases/fourslash/quickInfoJsDocTags14.ts ===
// /**
// * @param {Object} options the args object
// * @param {number} options.a first number
// * @param {number} options.b second number
// * @param {Object} options.c sub-object
// * @param {number} options.c.d third number
// * @param {Function} callback the callback function
// * @returns {number}
// */
// function fn(options, callback = null) { }
// ^^
// | ----------------------------------------------------------------------
// | function fn(options: any, callback?: any): void
// | @param options the args object
// | @param options.a first number
// | @param options.b second number
// | @param options.c sub-object
// | @param options.c.d third number
// | @param callback the callback function
// | @returns
// | ----------------------------------------------------------------------
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoJsDocTags14.ts",
"position": 302,
"name": ""
},
"item": {
"kind": "function",
"kindModifiers": "",
"textSpan": {
"start": 302,
"length": 2
},
"displayParts": [
{
"text": "function",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "fn",
"kind": "functionName"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "options",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "any",
"kind": "keyword"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "callback",
"kind": "parameterName"
},
{
"text": "?",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "any",
"kind": "keyword"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "void",
"kind": "keyword"
}
],
"documentation": [],
"tags": [
{
"name": "param",
"text": [
{
"text": "options",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "the args object",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "options.a",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "first number",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "options.b",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "second number",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "options.c",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "sub-object",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "options.c.d",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "third number",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "callback",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "the callback function",
"kind": "text"
}
]
},
{
"name": "returns"
}
]
}
}
]

14
tests/cases/fourslash/quickInfoJsDocTags14.ts Normal file
View File

@ -0,0 +1,14 @@
/// <reference path="fourslash.ts" />
/////**
//// * @param {Object} options the args object
//// * @param {number} options.a first number
//// * @param {number} options.b second number
//// * @param {Object} options.c sub-object
//// * @param {number} options.c.d third number
//// * @param {Function} callback the callback function
//// * @returns {number}
//// */
////function /**/fn(options, callback = null) { }
verify.baselineQuickInfo();