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

Fix @link https:// formatting (#47705)

Browse Source 
* Fix @link https:// formatting

Also improve .d.ts formatting of `@link`,`@linkcode`,`@linkplain`.

Fixes #46734

1. Previously, `@link` incorrectly put a space between "https" and "://"
when formatting jsdoc for editors. Now it does not.
2. When fixing the same output for .d.ts, I discovered that all `@link` tags
were formatted as `@link`, even if they were `@linkcode` or
`@linkplain`. I fixed that too.

* semicolon lint
This commit is contained in:
Nathan Shively-Sanders 2022-02-02 14:00:08 -08:00 committed by GitHub
parent 854cec7387
commit c4fd0028f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 181 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/compiler/utilitiesPublic.ts
View File

@ -905,9 +905,16 @@ namespace ts {
/** Gets the text of a jsdoc comment, flattening links to their text. */
export function getTextOfJSDocComment(comment?: string | NodeArray<JSDocComment>) {
return typeof comment === "string" ? comment
: comment?.map(c =>
// TODO: Other kinds here
c.kind === SyntaxKind.JSDocText ? c.text : `{@link ${c.name ? entityNameToString(c.name) + " " : ""}${c.text}}`).join("");
: comment?.map(c => c.kind === SyntaxKind.JSDocText ? c.text : formatJSDocLink(c)).join("");
}
function formatJSDocLink(link: JSDocLink | JSDocLinkCode | JSDocLinkPlain) {
const kind = link.kind === SyntaxKind.JSDocLink ? "link"
: link.kind === SyntaxKind.JSDocLinkCode ? "linkcode"
: "linkplain";
const name = link.name ? entityNameToString(link.name) : "";
const space = link.name && link.text.startsWith("://") ? "" : " ";
return `{@${kind} ${name}${space}${link.text}}`;
}
/**

2
src/services/utilities.ts
View File

@ -2320,7 +2320,7 @@ namespace ts {
if (text) parts.push(linkTextPart(text));
}
else {
parts.push(linkTextPart(name + (suffix ? "" : " ") + text));
parts.push(linkTextPart(name + (suffix || text.indexOf("://") === 0 ? "" : " ") + text));
}
}
parts.push(linkPart("}"));

14
tests/baselines/reference/linkTagEmit1.js
View File

@ -20,6 +20,11 @@ declare namespace NS {
function computeCommonSourceDirectoryOfFilenames(integer) {
return integer + 1 // pls pls pls
}
/** {@link https://hvad} */
var see3 = true
/** @typedef {number} Attempt {@link https://wat} {@linkcode I think lingcod is better} {@linkplain or lutefisk}*/
//// [linkTagEmit1.js]
@ -36,6 +41,9 @@ function computeCommonSourceDirectoryOfFilenames(integer) {
function computeCommonSourceDirectoryOfFilenames(integer) {
return integer + 1; // pls pls pls
}
/** {@link https://hvad} */
var see3 = true;
/** @typedef {number} Attempt {@link https://wat} {@linkcode I think lingcod is better} {@linkplain or lutefisk}*/
//// [linkTagEmit1.d.ts]
@ -50,6 +58,8 @@ function computeCommonSourceDirectoryOfFilenames(integer) {
* @param {number} integer {@link Z}
*/
declare function computeCommonSourceDirectoryOfFilenames(integer: number): number;
/** {@link https://hvad} */
declare var see3: boolean;
type N = number;
type D1 = {
/**
@ -62,3 +72,7 @@ type D1 = {
m: 1;
};
type Z = number;
/**
* {@link https://wat} {@linkcode I think lingcod is better} {@linkplain or lutefisk}
*/
type Attempt = number;

6
tests/baselines/reference/linkTagEmit1.symbols
View File

@ -26,3 +26,9 @@ function computeCommonSourceDirectoryOfFilenames(integer) {
>integer : Symbol(integer, Decl(linkTagEmit1.js, 12, 49))
}
/** {@link https://hvad} */
var see3 = true
>see3 : Symbol(see3, Decl(linkTagEmit1.js, 17, 3))
/** @typedef {number} Attempt {@link https://wat} {@linkcode I think lingcod is better} {@linkplain or lutefisk}*/

7
tests/baselines/reference/linkTagEmit1.types
View File

@ -26,3 +26,10 @@ function computeCommonSourceDirectoryOfFilenames(integer) {
>1 : 1
}
/** {@link https://hvad} */
var see3 = true
>see3 : boolean
>true : true
/** @typedef {number} Attempt {@link https://wat} {@linkcode I think lingcod is better} {@linkplain or lutefisk}*/

126
tests/baselines/reference/quickInfoForJSDocWithUnresolvedHttpLinks.baseline Normal file
View File

@ -0,0 +1,126 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoForJSDocWithHttpLinks.js",
"position": 36,
"name": "5"
},
"quickInfo": {
"kind": "var",
"kindModifiers": "",
"textSpan": {
"start": 36,
"length": 4
},
"displayParts": [
{
"text": "var",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "see2",
"kind": "localName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "boolean",
"kind": "keyword"
}
],
"documentation": [],
"tags": [
{
"name": "see",
"text": [
{
"text": "",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "https://hva",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
}
]
}
]
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoForJSDocWithHttpLinks.js",
"position": 81,
"name": "6"
},
"quickInfo": {
"kind": "var",
"kindModifiers": "",
"textSpan": {
"start": 81,
"length": 4
},
"displayParts": [
{
"text": "var",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "see3",
"kind": "localName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "boolean",
"kind": "keyword"
}
],
"documentation": [
{
"text": "",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "https://hvaD",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
}
]
}
}
]

5
tests/cases/conformance/jsdoc/linkTagEmit1.ts
View File

@ -21,3 +21,8 @@ declare namespace NS {
function computeCommonSourceDirectoryOfFilenames(integer) {
return integer + 1 // pls pls pls
}
/** {@link https://hvad} */
var see3 = true
/** @typedef {number} Attempt {@link https://wat} {@linkcode I think lingcod is better} {@linkplain or lutefisk}*/

12
tests/cases/fourslash/quickInfoForJSDocWithUnresolvedHttpLinks.ts Normal file
View File

@ -0,0 +1,12 @@
/// <reference path='fourslash.ts' />
// @checkJs: true
// @filename: quickInfoForJSDocWithHttpLinks.js
// #46734
//// /** @see {@link https://hva} */
//// var /*5*/see2 = true
////
//// /** {@link https://hvaD} */
//// var /*6*/see3 = true
verify.baselineQuickInfo();