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

Merge pull request #42356 from armanio123/FixJSDocFormatting

Browse Source 
Fix double asterisk formatting in JSDoc
This commit is contained in:
Armando Aguirre
2021-01-25 15:05:44 -08:00
committed by GitHub
parent 701493fb80 a231b23772
commit 871096b3a1
3 changed files with 108 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/compiler/parser.ts
View File

@@ -7691,13 +7691,14 @@ namespace ts {
skipWhitespaceOrAsterisk();
const { name, isBracketed } = parseBracketNameInPropertyAndParamTag();
skipWhitespace();
const indentText = skipWhitespaceOrAsterisk();
if (isNameFirst) {
typeExpression = tryParseTypeExpression();
}
const comment = parseTagComments(indent + scanner.getStartPos() - start);
const comment = parseTrailingTagComments(start, getNodePos(), indent, indentText);
const nestedTypeLiteral = target !== PropertyLikeParse.CallbackParameter && parseNestedTypeLiteral(typeExpression, name, target, indent);
if (nestedTypeLiteral) {
typeExpression = nestedTypeLiteral;

8
tests/cases/fourslash/commentsLinePreservation.ts
View File

@@ -129,16 +129,16 @@ verify.quickInfos({
3: ["(parameter) param1: string", "first line of param\n\nparam information third line"],
g: ["function g(param1: string): void", "This is firstLine\nThis is second Line"],
4: ["(parameter) param1: string", "param information first line"],
4: ["(parameter) param1: string", " param information first line"],
h: ["function h(param1: string): void", "This is firstLine\nThis is second Line"],
5: ["(parameter) param1: string", "param information first line\n\nparam information third line"],
5: ["(parameter) param1: string", " param information first line\n\n param information third line"],
i: ["function i(param1: string): void", "This is firstLine\nThis is second Line"],
6: ["(parameter) param1: string", "param information first line\n\nparam information third line"],
6: ["(parameter) param1: string", " param information first line\n\n param information third line"],
j: ["function j(param1: string): void", "This is firstLine\nThis is second Line"],
7: ["(parameter) param1: string", "param information first line\n\nparam information third line"],
7: ["(parameter) param1: string", " param information first line\n\n param information third line"],
k: ["function k(param1: string): void", "This is firstLine\nThis is second Line"],
8: ["(parameter) param1: string", "hello"],

101
tests/cases/fourslash/quickInfoJsDocTextFormatting1.ts Normal file
View File

@@ -0,0 +1,101 @@
/// <reference path='fourslash.ts'/>
// Regression test for #33386
//// /**
//// * @param {number} var1 **Highlighted text**
//// * @param {string} var2 Another **Highlighted text**
//// */
//// function f1(var1, var2) { }
////
//// /**
//// * @param {number} var1 *Regular text with an asterisk
//// * @param {string} var2 Another *Regular text with an asterisk
//// */
//// function f2(var1, var2) { }
////
//// /**
//// * @param {number} var1
//// * *Regular text with an asterisk
//// * @param {string} var2
//// * Another *Regular text with an asterisk
//// */
//// function f3(var1, var2) { }
////
//// /**
//// * @param {number} var1
//// * **Highlighted text**
//// * @param {string} var2
//// * Another **Highlighted text**
//// */
//// function f4(var1, var2) { }
////
//// /**
//// * @param {number} var1
//// **Highlighted text**
//// * @param {string} var2
//// Another **Highlighted text**
//// */
//// function f5(var1, var2) { }
////
//// f1(/*1*/);
//// f2(/*2*/);
//// f3(/*3*/);
//// f4(/*4*/);
//// f5(/*5*/);
verify.signatureHelp({
marker: "1",
parameterDocComment: "**Highlighted text**",
tags: [{
name: "param",
text: "var1 **Highlighted text**"
}, {
name: "param",
text: "var2 Another **Highlighted text**"
}]
});
verify.signatureHelp({
marker: "2",
parameterDocComment: "*Regular text with an asterisk",
tags: [{
name: "param",
text: "var1 *Regular text with an asterisk"
}, {
name: "param",
text: "var2 Another *Regular text with an asterisk"
}]
});
verify.signatureHelp({
marker: "3",
parameterDocComment: "*Regular text with an asterisk",
tags: [{
name: "param",
text: "var1 *Regular text with an asterisk"
}, {
name: "param",
text: "var2 Another *Regular text with an asterisk"
}]
});
verify.signatureHelp({
marker: "4",
parameterDocComment: "**Highlighted text**",
tags: [{
name: "param",
text: "var1 **Highlighted text**"
}, {
name: "param",
text: "var2 Another **Highlighted text**"
}]
});
verify.signatureHelp({
marker: "5",
parameterDocComment: "**Highlighted text**",
tags: [{
name: "param",
text: "var1 **Highlighted text**"
}, {
name: "param",
text: "var2 Another **Highlighted text**"
}]
});