typescript-language-server 3.0.1 → 3.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/lib/cli.mjs +3 -0
- package/lib/cli.mjs.map +1 -0
- package/package.json +37 -31
- package/lib/cli.d.ts +0 -3
- package/lib/cli.d.ts.map +0 -1
- package/lib/cli.js +0 -37
- package/lib/cli.js.map +0 -1
- package/lib/commands.d.ts +0 -13
- package/lib/commands.d.ts.map +0 -1
- package/lib/commands.js +0 -20
- package/lib/commands.js.map +0 -1
- package/lib/completion.d.ts +0 -10
- package/lib/completion.d.ts.map +0 -1
- package/lib/completion.js +0 -388
- package/lib/completion.js.map +0 -1
- package/lib/configuration-manager.d.ts +0 -48
- package/lib/configuration-manager.d.ts.map +0 -1
- package/lib/configuration-manager.js +0 -138
- package/lib/configuration-manager.js.map +0 -1
- package/lib/diagnostic-queue.d.ts +0 -31
- package/lib/diagnostic-queue.d.ts.map +0 -1
- package/lib/diagnostic-queue.js +0 -70
- package/lib/diagnostic-queue.js.map +0 -1
- package/lib/document-symbol.d.ts +0 -6
- package/lib/document-symbol.d.ts.map +0 -1
- package/lib/document-symbol.js +0 -85
- package/lib/document-symbol.js.map +0 -1
- package/lib/document.d.ts +0 -34
- package/lib/document.d.ts.map +0 -1
- package/lib/document.js +0 -115
- package/lib/document.js.map +0 -1
- package/lib/features/call-hierarchy.d.ts +0 -7
- package/lib/features/call-hierarchy.d.ts.map +0 -1
- package/lib/features/call-hierarchy.js +0 -81
- package/lib/features/call-hierarchy.js.map +0 -1
- package/lib/features/call-hierarchy.spec.d.ts +0 -2
- package/lib/features/call-hierarchy.spec.d.ts.map +0 -1
- package/lib/features/call-hierarchy.spec.js +0 -107
- package/lib/features/call-hierarchy.spec.js.map +0 -1
- package/lib/features/fix-all.d.ts +0 -12
- package/lib/features/fix-all.d.ts.map +0 -1
- package/lib/features/fix-all.js +0 -156
- package/lib/features/fix-all.js.map +0 -1
- package/lib/features/inlay-hints.d.ts +0 -11
- package/lib/features/inlay-hints.d.ts.map +0 -1
- package/lib/features/inlay-hints.js +0 -71
- package/lib/features/inlay-hints.js.map +0 -1
- package/lib/features/semantic-tokens.d.ts +0 -9
- package/lib/features/semantic-tokens.d.ts.map +0 -1
- package/lib/features/semantic-tokens.js +0 -43
- package/lib/features/semantic-tokens.js.map +0 -1
- package/lib/features/source-definition.d.ts +0 -11
- package/lib/features/source-definition.d.ts.map +0 -1
- package/lib/features/source-definition.js +0 -51
- package/lib/features/source-definition.js.map +0 -1
- package/lib/file-lsp-server.spec.d.ts +0 -2
- package/lib/file-lsp-server.spec.d.ts.map +0 -1
- package/lib/file-lsp-server.spec.js +0 -64
- package/lib/file-lsp-server.spec.js.map +0 -1
- package/lib/hover.d.ts +0 -6
- package/lib/hover.d.ts.map +0 -1
- package/lib/hover.js +0 -80
- package/lib/hover.js.map +0 -1
- package/lib/lsp-client.d.ts +0 -26
- package/lib/lsp-client.d.ts.map +0 -1
- package/lib/lsp-client.js +0 -51
- package/lib/lsp-client.js.map +0 -1
- package/lib/lsp-connection.d.ts +0 -9
- package/lib/lsp-connection.d.ts.map +0 -1
- package/lib/lsp-connection.js +0 -54
- package/lib/lsp-connection.js.map +0 -1
- package/lib/lsp-server.d.ts +0 -86
- package/lib/lsp-server.d.ts.map +0 -1
- package/lib/lsp-server.js +0 -1168
- package/lib/lsp-server.js.map +0 -1
- package/lib/lsp-server.spec.d.ts +0 -2
- package/lib/lsp-server.spec.d.ts.map +0 -1
- package/lib/lsp-server.spec.js +0 -2106
- package/lib/lsp-server.spec.js.map +0 -1
- package/lib/organize-imports.d.ts +0 -5
- package/lib/organize-imports.d.ts.map +0 -1
- package/lib/organize-imports.js +0 -19
- package/lib/organize-imports.js.map +0 -1
- package/lib/organize-imports.spec.d.ts +0 -2
- package/lib/organize-imports.spec.d.ts.map +0 -1
- package/lib/organize-imports.spec.js +0 -38
- package/lib/organize-imports.spec.js.map +0 -1
- package/lib/protocol-translation.d.ts +0 -26
- package/lib/protocol-translation.d.ts.map +0 -1
- package/lib/protocol-translation.js +0 -184
- package/lib/protocol-translation.js.map +0 -1
- package/lib/quickfix.d.ts +0 -5
- package/lib/quickfix.d.ts.map +0 -1
- package/lib/quickfix.js +0 -20
- package/lib/quickfix.js.map +0 -1
- package/lib/refactor.d.ts +0 -6
- package/lib/refactor.d.ts.map +0 -1
- package/lib/refactor.js +0 -58
- package/lib/refactor.js.map +0 -1
- package/lib/test-utils.d.ts +0 -45
- package/lib/test-utils.d.ts.map +0 -1
- package/lib/test-utils.js +0 -185
- package/lib/test-utils.js.map +0 -1
- package/lib/ts-protocol.d.ts +0 -93
- package/lib/ts-protocol.d.ts.map +0 -1
- package/lib/ts-protocol.js +0 -66
- package/lib/ts-protocol.js.map +0 -1
- package/lib/tsServer/callbackMap.d.ts +0 -17
- package/lib/tsServer/callbackMap.d.ts.map +0 -1
- package/lib/tsServer/callbackMap.js +0 -47
- package/lib/tsServer/callbackMap.js.map +0 -1
- package/lib/tsServer/cancellation.d.ts +0 -22
- package/lib/tsServer/cancellation.d.ts.map +0 -1
- package/lib/tsServer/cancellation.js +0 -51
- package/lib/tsServer/cancellation.js.map +0 -1
- package/lib/tsServer/logDirectoryProvider.d.ts +0 -13
- package/lib/tsServer/logDirectoryProvider.d.ts.map +0 -1
- package/lib/tsServer/logDirectoryProvider.js +0 -49
- package/lib/tsServer/logDirectoryProvider.js.map +0 -1
- package/lib/tsServer/requestQueue.d.ts +0 -34
- package/lib/tsServer/requestQueue.d.ts.map +0 -1
- package/lib/tsServer/requestQueue.js +0 -74
- package/lib/tsServer/requestQueue.js.map +0 -1
- package/lib/tsServer/requests.d.ts +0 -73
- package/lib/tsServer/requests.d.ts.map +0 -1
- package/lib/tsServer/requests.js +0 -30
- package/lib/tsServer/requests.js.map +0 -1
- package/lib/tsServer/server.d.ts +0 -100
- package/lib/tsServer/server.d.ts.map +0 -1
- package/lib/tsServer/server.js +0 -216
- package/lib/tsServer/server.js.map +0 -1
- package/lib/tsServer/serverError.d.ts +0 -18
- package/lib/tsServer/serverError.d.ts.map +0 -1
- package/lib/tsServer/serverError.js +0 -53
- package/lib/tsServer/serverError.js.map +0 -1
- package/lib/tsServer/serverProcess.d.ts +0 -7
- package/lib/tsServer/serverProcess.d.ts.map +0 -1
- package/lib/tsServer/serverProcess.js +0 -244
- package/lib/tsServer/serverProcess.js.map +0 -1
- package/lib/tsServer/spawner.d.ts +0 -19
- package/lib/tsServer/spawner.d.ts.map +0 -1
- package/lib/tsServer/spawner.js +0 -130
- package/lib/tsServer/spawner.js.map +0 -1
- package/lib/tsServer/tracer.d.ts +0 -26
- package/lib/tsServer/tracer.d.ts.map +0 -1
- package/lib/tsServer/tracer.js +0 -80
- package/lib/tsServer/tracer.js.map +0 -1
- package/lib/tsServer/versionProvider.d.ts +0 -29
- package/lib/tsServer/versionProvider.d.ts.map +0 -1
- package/lib/tsServer/versionProvider.js +0 -161
- package/lib/tsServer/versionProvider.js.map +0 -1
- package/lib/tsp-client.d.ts +0 -53
- package/lib/tsp-client.d.ts.map +0 -1
- package/lib/tsp-client.js +0 -228
- package/lib/tsp-client.js.map +0 -1
- package/lib/tsp-client.spec.d.ts +0 -2
- package/lib/tsp-client.spec.d.ts.map +0 -1
- package/lib/tsp-client.spec.js +0 -113
- package/lib/tsp-client.spec.js.map +0 -1
- package/lib/utils/MarkdownString.d.ts +0 -15
- package/lib/utils/MarkdownString.d.ts.map +0 -1
- package/lib/utils/MarkdownString.js +0 -45
- package/lib/utils/MarkdownString.js.map +0 -1
- package/lib/utils/SnippetString.d.ts +0 -12
- package/lib/utils/SnippetString.d.ts.map +0 -1
- package/lib/utils/SnippetString.js +0 -66
- package/lib/utils/SnippetString.js.map +0 -1
- package/lib/utils/api.d.ts +0 -49
- package/lib/utils/api.d.ts.map +0 -1
- package/lib/utils/api.js +0 -77
- package/lib/utils/api.js.map +0 -1
- package/lib/utils/configuration.d.ts +0 -20
- package/lib/utils/configuration.d.ts.map +0 -1
- package/lib/utils/configuration.js +0 -47
- package/lib/utils/configuration.js.map +0 -1
- package/lib/utils/errorCodes.d.ts +0 -12
- package/lib/utils/errorCodes.d.ts.map +0 -1
- package/lib/utils/errorCodes.js +0 -16
- package/lib/utils/errorCodes.js.map +0 -1
- package/lib/utils/fixNames.d.ts +0 -14
- package/lib/utils/fixNames.d.ts.map +0 -1
- package/lib/utils/fixNames.js +0 -18
- package/lib/utils/fixNames.js.map +0 -1
- package/lib/utils/logger.d.ts +0 -65
- package/lib/utils/logger.d.ts.map +0 -1
- package/lib/utils/logger.js +0 -187
- package/lib/utils/logger.js.map +0 -1
- package/lib/utils/modules-resolver.d.ts +0 -2
- package/lib/utils/modules-resolver.d.ts.map +0 -1
- package/lib/utils/modules-resolver.js +0 -17
- package/lib/utils/modules-resolver.js.map +0 -1
- package/lib/utils/modules-resolver.spec.d.ts +0 -2
- package/lib/utils/modules-resolver.spec.d.ts.map +0 -1
- package/lib/utils/modules-resolver.spec.js +0 -18
- package/lib/utils/modules-resolver.spec.js.map +0 -1
- package/lib/utils/previewer.d.ts +0 -15
- package/lib/utils/previewer.d.ts.map +0 -1
- package/lib/utils/previewer.js +0 -185
- package/lib/utils/previewer.js.map +0 -1
- package/lib/utils/previewer.spec.d.ts +0 -2
- package/lib/utils/previewer.spec.d.ts.map +0 -1
- package/lib/utils/previewer.spec.js +0 -123
- package/lib/utils/previewer.spec.js.map +0 -1
- package/lib/utils/tsconfig.d.ts +0 -4
- package/lib/utils/tsconfig.d.ts.map +0 -1
- package/lib/utils/tsconfig.js +0 -41
- package/lib/utils/tsconfig.js.map +0 -1
- package/lib/utils/typeConverters.d.ts +0 -29
- package/lib/utils/typeConverters.d.ts.map +0 -1
- package/lib/utils/typeConverters.js +0 -118
- package/lib/utils/typeConverters.js.map +0 -1
- package/lib/utils/types.d.ts +0 -41
- package/lib/utils/types.d.ts.map +0 -1
- package/lib/utils/types.js +0 -55
- package/lib/utils/types.js.map +0 -1
- package/lib/utils.d.ts +0 -6
- package/lib/utils.d.ts.map +0 -1
- package/lib/utils.js +0 -17
- package/lib/utils.js.map +0 -1
package/lib/utils/logger.js
DELETED
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
/*---------------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
4
|
-
*--------------------------------------------------------------------------------------------*/
|
|
5
|
-
/*
|
|
6
|
-
* Copyright (C) 2017, 2018 TypeFox and others.
|
|
7
|
-
*
|
|
8
|
-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
|
9
|
-
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*/
|
|
11
|
-
/* eslint-disable @typescript-eslint/no-unnecessary-qualifier */
|
|
12
|
-
import lsp from 'vscode-languageserver';
|
|
13
|
-
export var LogLevel;
|
|
14
|
-
(function (LogLevel) {
|
|
15
|
-
LogLevel[LogLevel["Error"] = 0] = "Error";
|
|
16
|
-
LogLevel[LogLevel["Warning"] = 1] = "Warning";
|
|
17
|
-
LogLevel[LogLevel["Info"] = 2] = "Info";
|
|
18
|
-
LogLevel[LogLevel["Log"] = 3] = "Log";
|
|
19
|
-
})(LogLevel = LogLevel || (LogLevel = {}));
|
|
20
|
-
(function (LogLevel) {
|
|
21
|
-
function fromString(value) {
|
|
22
|
-
switch (value?.toLowerCase()) {
|
|
23
|
-
case 'log':
|
|
24
|
-
return LogLevel.Log;
|
|
25
|
-
case 'info':
|
|
26
|
-
return LogLevel.Info;
|
|
27
|
-
case 'warning':
|
|
28
|
-
return LogLevel.Warning;
|
|
29
|
-
case 'error':
|
|
30
|
-
default:
|
|
31
|
-
return LogLevel.Error;
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
LogLevel.fromString = fromString;
|
|
35
|
-
function toString(level) {
|
|
36
|
-
switch (level) {
|
|
37
|
-
case LogLevel.Error:
|
|
38
|
-
return 'error';
|
|
39
|
-
case LogLevel.Warning:
|
|
40
|
-
return 'warning';
|
|
41
|
-
case LogLevel.Info:
|
|
42
|
-
return 'info';
|
|
43
|
-
case LogLevel.Log:
|
|
44
|
-
return 'log';
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
LogLevel.toString = toString;
|
|
48
|
-
})(LogLevel = LogLevel || (LogLevel = {}));
|
|
49
|
-
export class LspClientLogger {
|
|
50
|
-
constructor(client, level) {
|
|
51
|
-
this.client = client;
|
|
52
|
-
this.level = level;
|
|
53
|
-
}
|
|
54
|
-
sendMessage(severity, messageObjects, options) {
|
|
55
|
-
if (this.level >= severity || options?.overrideLevel) {
|
|
56
|
-
const message = messageObjects.map(p => {
|
|
57
|
-
if (typeof p === 'object') {
|
|
58
|
-
return JSON.stringify(p, null, 2);
|
|
59
|
-
}
|
|
60
|
-
else {
|
|
61
|
-
return p;
|
|
62
|
-
}
|
|
63
|
-
}).join(' ');
|
|
64
|
-
this.client.logMessage({
|
|
65
|
-
type: severity,
|
|
66
|
-
message: message,
|
|
67
|
-
});
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
logLevelToLspMessageType(level) {
|
|
71
|
-
switch (level) {
|
|
72
|
-
case LogLevel.Log:
|
|
73
|
-
return lsp.MessageType.Log;
|
|
74
|
-
case LogLevel.Info:
|
|
75
|
-
return lsp.MessageType.Info;
|
|
76
|
-
case LogLevel.Warning:
|
|
77
|
-
return lsp.MessageType.Warning;
|
|
78
|
-
case LogLevel.Error:
|
|
79
|
-
return lsp.MessageType.Error;
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
error(...args) {
|
|
83
|
-
this.sendMessage(lsp.MessageType.Error, args);
|
|
84
|
-
}
|
|
85
|
-
warn(...args) {
|
|
86
|
-
this.sendMessage(lsp.MessageType.Warning, args);
|
|
87
|
-
}
|
|
88
|
-
info(...args) {
|
|
89
|
-
this.sendMessage(lsp.MessageType.Info, args);
|
|
90
|
-
}
|
|
91
|
-
log(...args) {
|
|
92
|
-
this.sendMessage(lsp.MessageType.Log, args);
|
|
93
|
-
}
|
|
94
|
-
logIgnoringVerbosity(level, ...args) {
|
|
95
|
-
this.sendMessage(this.logLevelToLspMessageType(level), args, { overrideLevel: true });
|
|
96
|
-
}
|
|
97
|
-
trace(level, message, data) {
|
|
98
|
-
this.logIgnoringVerbosity(LogLevel.Log, `[${level} - ${now()}] ${message}`);
|
|
99
|
-
if (data) {
|
|
100
|
-
this.logIgnoringVerbosity(LogLevel.Log, data2String(data));
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
}
|
|
104
|
-
export class ConsoleLogger {
|
|
105
|
-
constructor(level = LogLevel.Error) {
|
|
106
|
-
this.level = level;
|
|
107
|
-
}
|
|
108
|
-
print(level, args, options) {
|
|
109
|
-
if (this.level >= level || options?.overrideLevel) {
|
|
110
|
-
// All messages logged to stderr as stdout is reserved for LSP communication.
|
|
111
|
-
console.error(`[${LogLevel.toString(level)}]`, ...this.toStrings(...args));
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
toStrings(...args) {
|
|
115
|
-
return args.map(a => {
|
|
116
|
-
if (typeof a === 'string') {
|
|
117
|
-
return a;
|
|
118
|
-
}
|
|
119
|
-
return JSON.stringify(a, null, 2);
|
|
120
|
-
});
|
|
121
|
-
}
|
|
122
|
-
error(...args) {
|
|
123
|
-
this.print(LogLevel.Error, args);
|
|
124
|
-
}
|
|
125
|
-
warn(...args) {
|
|
126
|
-
this.print(LogLevel.Warning, args);
|
|
127
|
-
}
|
|
128
|
-
info(...args) {
|
|
129
|
-
this.print(LogLevel.Info, args);
|
|
130
|
-
}
|
|
131
|
-
log(...args) {
|
|
132
|
-
this.print(LogLevel.Log, args);
|
|
133
|
-
}
|
|
134
|
-
logIgnoringVerbosity(level, ...args) {
|
|
135
|
-
this.print(level, args, { overrideLevel: true });
|
|
136
|
-
}
|
|
137
|
-
trace(level, message, data) {
|
|
138
|
-
this.logIgnoringVerbosity(LogLevel.Log, `[${level} - ${now()}] ${message}`);
|
|
139
|
-
if (data) {
|
|
140
|
-
this.logIgnoringVerbosity(LogLevel.Log, data2String(data));
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
}
|
|
144
|
-
export class PrefixingLogger {
|
|
145
|
-
constructor(logger, prefix) {
|
|
146
|
-
this.logger = logger;
|
|
147
|
-
this.prefix = prefix;
|
|
148
|
-
}
|
|
149
|
-
error(...args) {
|
|
150
|
-
this.logger.error(this.prefix, ...args);
|
|
151
|
-
}
|
|
152
|
-
warn(...args) {
|
|
153
|
-
this.logger.warn(this.prefix, ...args);
|
|
154
|
-
}
|
|
155
|
-
info(...args) {
|
|
156
|
-
this.logger.info(this.prefix, ...args);
|
|
157
|
-
}
|
|
158
|
-
log(...args) {
|
|
159
|
-
this.logger.log(this.prefix, ...args);
|
|
160
|
-
}
|
|
161
|
-
logIgnoringVerbosity(level, ...args) {
|
|
162
|
-
this.logger.logIgnoringVerbosity(level, this.prefix, ...args);
|
|
163
|
-
}
|
|
164
|
-
trace(level, message, data) {
|
|
165
|
-
this.logIgnoringVerbosity(LogLevel.Log, this.prefix, `[${level} - ${now()}] ${message}`);
|
|
166
|
-
if (data) {
|
|
167
|
-
this.logIgnoringVerbosity(LogLevel.Log, this.prefix, data2String(data));
|
|
168
|
-
}
|
|
169
|
-
}
|
|
170
|
-
}
|
|
171
|
-
function now() {
|
|
172
|
-
const now = new Date();
|
|
173
|
-
return `${padLeft(`${now.getUTCHours()}`, 2, '0')}:${padLeft(`${now.getMinutes()}`, 2, '0')}:${padLeft(`${now.getUTCSeconds()}`, 2, '0')}.${now.getMilliseconds()}`;
|
|
174
|
-
}
|
|
175
|
-
function padLeft(s, n, pad = ' ') {
|
|
176
|
-
return pad.repeat(Math.max(0, n - s.length)) + s;
|
|
177
|
-
}
|
|
178
|
-
function data2String(data) {
|
|
179
|
-
if (data instanceof Error) {
|
|
180
|
-
return data.stack || data.message;
|
|
181
|
-
}
|
|
182
|
-
if (data.success === false && data.message) {
|
|
183
|
-
return data.message;
|
|
184
|
-
}
|
|
185
|
-
return data.toString();
|
|
186
|
-
}
|
|
187
|
-
//# sourceMappingURL=logger.js.map
|
package/lib/utils/logger.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;;;;GAKG;AAEH,gEAAgE;AAEhE,OAAO,GAAG,MAAM,uBAAuB,CAAC;AAGxC,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAChB,yCAAK,CAAA;IACL,6CAAO,CAAA;IACP,uCAAI,CAAA;IACJ,qCAAG,CAAA;AACP,CAAC,EALW,QAAQ,GAAR,QAAQ,KAAR,QAAQ,QAKnB;AAED,WAAiB,QAAQ;IACrB,SAAgB,UAAU,CAAC,KAAc;QACrC,QAAQ,KAAK,EAAE,WAAW,EAAE,EAAE;YAC1B,KAAK,KAAK;gBACN,OAAO,QAAQ,CAAC,GAAG,CAAC;YACxB,KAAK,MAAM;gBACP,OAAO,QAAQ,CAAC,IAAI,CAAC;YACzB,KAAK,SAAS;gBACV,OAAO,QAAQ,CAAC,OAAO,CAAC;YAC5B,KAAK,OAAO,CAAC;YACb;gBACI,OAAO,QAAQ,CAAC,KAAK,CAAC;SAC7B;IACL,CAAC;IAZe,mBAAU,aAYzB,CAAA;IAED,SAAgB,QAAQ,CAAC,KAAe;QACpC,QAAQ,KAAK,EAAE;YACX,KAAK,QAAQ,CAAC,KAAK;gBACf,OAAO,OAAO,CAAC;YACnB,KAAK,QAAQ,CAAC,OAAO;gBACjB,OAAO,SAAS,CAAC;YACrB,KAAK,QAAQ,CAAC,IAAI;gBACd,OAAO,MAAM,CAAC;YAClB,KAAK,QAAQ,CAAC,GAAG;gBACb,OAAO,KAAK,CAAC;SACpB;IACL,CAAC;IAXe,iBAAQ,WAWvB,CAAA;AACL,CAAC,EA3BgB,QAAQ,GAAR,QAAQ,KAAR,QAAQ,QA2BxB;AAmBD,MAAM,OAAO,eAAe;IACxB,YACY,MAAiB,EACjB,KAAsB;QADtB,WAAM,GAAN,MAAM,CAAW;QACjB,UAAK,GAAL,KAAK,CAAiB;IAC/B,CAAC;IAEI,WAAW,CAAC,QAAyB,EAAE,cAAqB,EAAE,OAAsC;QACxG,IAAI,IAAI,CAAC,KAAK,IAAI,QAAQ,IAAI,OAAO,EAAE,aAAa,EAAE;YAClD,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACnC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;oBACvB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;iBACrC;qBAAM;oBACH,OAAO,CAAC,CAAC;iBACZ;YACL,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEb,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;gBACnB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,OAAO;aACnB,CAAC,CAAC;SACN;IACL,CAAC;IAEO,wBAAwB,CAAC,KAAe;QAC5C,QAAQ,KAAK,EAAE;YACX,KAAK,QAAQ,CAAC,GAAG;gBACb,OAAO,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC;YAC/B,KAAK,QAAQ,CAAC,IAAI;gBACd,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;YAChC,KAAK,QAAQ,CAAC,OAAO;gBACjB,OAAO,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC;YACnC,KAAK,QAAQ,CAAC,KAAK;gBACf,OAAO,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC;SACpC;IACL,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAChB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACf,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACf,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,GAAG,CAAC,GAAG,IAAW;QACd,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,oBAAoB,CAAC,KAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,KAAK,CAAC,KAAiB,EAAE,OAAe,EAAE,IAAU;QAChD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,KAAK,OAAO,GAAG,EAAE,KAAK,OAAO,EAAE,CAAC,CAAC;QAC7E,IAAI,IAAI,EAAE;YACN,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9D;IACL,CAAC;CACJ;AAED,MAAM,OAAO,aAAa;IACtB,YACY,QAAkB,QAAQ,CAAC,KAAK;QAAhC,UAAK,GAAL,KAAK,CAA2B;IACzC,CAAC;IAEI,KAAK,CAAC,KAAe,EAAE,IAAW,EAAE,OAAsC;QAC9E,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,IAAI,OAAO,EAAE,aAAa,EAAE;YAC/C,6EAA6E;YAC7E,OAAO,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;SAC9E;IACL,CAAC;IAEO,SAAS,CAAC,GAAG,IAAW;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YAChB,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;gBACvB,OAAO,CAAC,CAAC;aACZ;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAChB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACf,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACf,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,GAAG,CAAC,GAAG,IAAW;QACd,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,oBAAoB,CAAC,KAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,KAAiB,EAAE,OAAe,EAAE,IAAU;QAChD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,KAAK,OAAO,GAAG,EAAE,KAAK,OAAO,EAAE,CAAC,CAAC;QAC7E,IAAI,IAAI,EAAE;YACN,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9D;IACL,CAAC;CACJ;AAED,MAAM,OAAO,eAAe;IACxB,YACY,MAAc,EACd,MAAc;QADd,WAAM,GAAN,MAAM,CAAQ;QACd,WAAM,GAAN,MAAM,CAAQ;IACvB,CAAC;IAEJ,KAAK,CAAC,GAAG,IAAW;QAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,GAAG,CAAC,GAAG,IAAW;QACd,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,oBAAoB,CAAC,KAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,KAAiB,EAAE,OAAe,EAAE,IAAU;QAChD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,OAAO,GAAG,EAAE,KAAK,OAAO,EAAE,CAAC,CAAC;QAC1F,IAAI,IAAI,EAAE;YACN,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;SAC3E;IACL,CAAC;CACJ;AAED,SAAS,GAAG;IACR,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,OAAO,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,GAAG,GAAG,CAAC,UAAU,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,eAAe,EAAE,EAAE,CAAC;AACxK,CAAC;AAED,SAAS,OAAO,CAAC,CAAS,EAAE,CAAS,EAAE,GAAG,GAAG,GAAG;IAC5C,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,WAAW,CAAC,IAAS;IAC1B,IAAI,IAAI,YAAY,KAAK,EAAE;QACvB,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC;KACrC;IACD,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC;KACvB;IACD,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"modules-resolver.d.ts","sourceRoot":"","sources":["../../src/utils/modules-resolver.ts"],"names":[],"mappings":"AAGA,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAavF"}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { statSync, existsSync } from 'node:fs';
|
|
2
|
-
import { resolve } from 'node:path';
|
|
3
|
-
export function findPathToModule(dir, moduleNames) {
|
|
4
|
-
const stat = statSync(dir);
|
|
5
|
-
if (stat.isDirectory()) {
|
|
6
|
-
const candidates = moduleNames.map(moduleName => resolve(dir, moduleName));
|
|
7
|
-
const modulePath = candidates.find(existsSync);
|
|
8
|
-
if (modulePath) {
|
|
9
|
-
return modulePath;
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
const parent = resolve(dir, '..');
|
|
13
|
-
if (parent !== dir) {
|
|
14
|
-
return findPathToModule(parent, moduleNames);
|
|
15
|
-
}
|
|
16
|
-
}
|
|
17
|
-
//# sourceMappingURL=modules-resolver.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"modules-resolver.js","sourceRoot":"","sources":["../../src/utils/modules-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,WAAqB;IAC/D,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC3B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;QACpB,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC;QAC3E,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,UAAU,EAAE;YACZ,OAAO,UAAU,CAAC;SACrB;KACJ;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAClC,IAAI,MAAM,KAAK,GAAG,EAAE;QAChB,OAAO,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;KAChD;AACL,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"modules-resolver.spec.d.ts","sourceRoot":"","sources":["../../src/utils/modules-resolver.spec.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,MAAM,QAA0C,CAAC"}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import * as chai from 'chai';
|
|
2
|
-
import { dirname, resolve } from 'node:path';
|
|
3
|
-
import { fileURLToPath } from 'node:url';
|
|
4
|
-
import { findPathToModule } from './modules-resolver.js';
|
|
5
|
-
import { PACKAGE_ROOT } from '../test-utils.js';
|
|
6
|
-
import { MODULE_FOLDERS } from '../tsServer/versionProvider.js';
|
|
7
|
-
export const CURDIR = dirname(fileURLToPath(import.meta.url));
|
|
8
|
-
describe('findPathToModule', () => {
|
|
9
|
-
it('resolves tsserver in own directory', () => {
|
|
10
|
-
const tsserverPath = findPathToModule(PACKAGE_ROOT, MODULE_FOLDERS);
|
|
11
|
-
chai.assert.equal(tsserverPath, resolve(PACKAGE_ROOT, 'node_modules', 'typescript', 'lib'));
|
|
12
|
-
});
|
|
13
|
-
it('resolves tsserver in parent directory', () => {
|
|
14
|
-
const tsserverPath = findPathToModule(CURDIR, MODULE_FOLDERS);
|
|
15
|
-
chai.assert.equal(tsserverPath, resolve(CURDIR, '..', '..', 'node_modules', 'typescript', 'lib'));
|
|
16
|
-
});
|
|
17
|
-
});
|
|
18
|
-
//# sourceMappingURL=modules-resolver.spec.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"modules-resolver.spec.js","sourceRoot":"","sources":["../../src/utils/modules-resolver.spec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAEhE,MAAM,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE9D,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC1C,MAAM,YAAY,GAAG,gBAAgB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
package/lib/utils/previewer.d.ts
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import vscodeUri from 'vscode-uri';
|
|
2
|
-
import * as lsp from 'vscode-languageserver';
|
|
3
|
-
import { MarkdownString } from './MarkdownString.js';
|
|
4
|
-
import type { tsp } from '../ts-protocol.js';
|
|
5
|
-
export interface IFilePathToResourceConverter {
|
|
6
|
-
/**
|
|
7
|
-
* Convert a typescript filepath to an URI resource.
|
|
8
|
-
*/
|
|
9
|
-
toResource(filepath: string): vscodeUri.URI;
|
|
10
|
-
}
|
|
11
|
-
export declare function plainWithLinks(parts: readonly tsp.SymbolDisplayPart[] | string, filePathConverter: IFilePathToResourceConverter): string;
|
|
12
|
-
export declare function tagsMarkdownPreview(tags: readonly tsp.JSDocTagInfo[], filePathConverter: IFilePathToResourceConverter): string;
|
|
13
|
-
export declare function markdownDocumentation(documentation: tsp.SymbolDisplayPart[] | string | undefined, tags: tsp.JSDocTagInfo[] | undefined, filePathConverter: IFilePathToResourceConverter): lsp.MarkupContent | undefined;
|
|
14
|
-
export declare function addMarkdownDocumentation(out: MarkdownString, documentation: string | tsp.SymbolDisplayPart[] | undefined, tags: tsp.JSDocTagInfo[] | undefined, converter: IFilePathToResourceConverter): MarkdownString;
|
|
15
|
-
//# sourceMappingURL=previewer.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"previewer.d.ts","sourceRoot":"","sources":["../../src/utils/previewer.ts"],"names":[],"mappings":"AAWA,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,GAAG,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAE7C,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC;CAC/C;AA+FD,wBAAgB,cAAc,CAC1B,KAAK,EAAE,SAAS,GAAG,CAAC,iBAAiB,EAAE,GAAG,MAAM,EAChD,iBAAiB,EAAE,4BAA4B,GAChD,MAAM,CAER;AA6ED,wBAAgB,mBAAmB,CAC/B,IAAI,EAAE,SAAS,GAAG,CAAC,YAAY,EAAE,EACjC,iBAAiB,EAAE,4BAA4B,GAChD,MAAM,CAER;AAED,wBAAgB,qBAAqB,CACjC,aAAa,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAAG,MAAM,GAAG,SAAS,EAC3D,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,GAAG,SAAS,EACpC,iBAAiB,EAAE,4BAA4B,GAChD,GAAG,CAAC,aAAa,GAAG,SAAS,CAI/B;AAED,wBAAgB,wBAAwB,CACpC,GAAG,EAAE,cAAc,EACnB,aAAa,EAAE,MAAM,GAAG,GAAG,CAAC,iBAAiB,EAAE,GAAG,SAAS,EAC3D,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,GAAG,SAAS,EACpC,SAAS,EAAE,4BAA4B,GACxC,cAAc,CAWhB"}
|
package/lib/utils/previewer.js
DELETED
|
@@ -1,185 +0,0 @@
|
|
|
1
|
-
/*---------------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
4
|
-
*--------------------------------------------------------------------------------------------*/
|
|
5
|
-
/*
|
|
6
|
-
* Copyright (C) 2022 TypeFox and others.
|
|
7
|
-
*
|
|
8
|
-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
|
9
|
-
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*/
|
|
11
|
-
import { MarkdownString } from './MarkdownString.js';
|
|
12
|
-
function replaceLinks(text) {
|
|
13
|
-
return text
|
|
14
|
-
// Http(s) links
|
|
15
|
-
.replace(/\{@(link|linkplain|linkcode) (https?:\/\/[^ |}]+?)(?:[| ]([^{}\n]+?))?\}/gi, (_, tag, link, text) => {
|
|
16
|
-
switch (tag) {
|
|
17
|
-
case 'linkcode':
|
|
18
|
-
return `[\`${text ? text.trim() : link}\`](${link})`;
|
|
19
|
-
default:
|
|
20
|
-
return `[${text ? text.trim() : link}](${link})`;
|
|
21
|
-
}
|
|
22
|
-
});
|
|
23
|
-
}
|
|
24
|
-
function processInlineTags(text) {
|
|
25
|
-
return replaceLinks(text);
|
|
26
|
-
}
|
|
27
|
-
function getTagBodyText(tag, filePathConverter) {
|
|
28
|
-
if (!tag.text) {
|
|
29
|
-
return undefined;
|
|
30
|
-
}
|
|
31
|
-
// Convert to markdown code block if it does not already contain one
|
|
32
|
-
function makeCodeblock(text) {
|
|
33
|
-
if (/^\s*[~`]{3}/m.test(text)) {
|
|
34
|
-
return text;
|
|
35
|
-
}
|
|
36
|
-
return '```\n' + text + '\n```';
|
|
37
|
-
}
|
|
38
|
-
const text = convertLinkTags(tag.text, filePathConverter);
|
|
39
|
-
switch (tag.name) {
|
|
40
|
-
case 'example': {
|
|
41
|
-
// check for caption tags, fix for #79704
|
|
42
|
-
const captionTagMatches = text.match(/<caption>(.*?)<\/caption>\s*(\r\n|\n)/);
|
|
43
|
-
if (captionTagMatches && captionTagMatches.index === 0) {
|
|
44
|
-
return captionTagMatches[1] + '\n' + makeCodeblock(text.substring(captionTagMatches[0].length));
|
|
45
|
-
}
|
|
46
|
-
else {
|
|
47
|
-
return makeCodeblock(text);
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
case 'author': {
|
|
51
|
-
// fix obsucated email address, #80898
|
|
52
|
-
const emailMatch = text.match(/(.+)\s<([-.\w]+@[-.\w]+)>/);
|
|
53
|
-
if (emailMatch === null) {
|
|
54
|
-
return text;
|
|
55
|
-
}
|
|
56
|
-
else {
|
|
57
|
-
return `${emailMatch[1]} ${emailMatch[2]}`;
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
case 'default':
|
|
61
|
-
return makeCodeblock(text);
|
|
62
|
-
}
|
|
63
|
-
return processInlineTags(text);
|
|
64
|
-
}
|
|
65
|
-
function getTagDocumentation(tag, filePathConverter) {
|
|
66
|
-
switch (tag.name) {
|
|
67
|
-
case 'augments':
|
|
68
|
-
case 'extends':
|
|
69
|
-
case 'param':
|
|
70
|
-
case 'template': {
|
|
71
|
-
const body = convertLinkTags(tag.text, filePathConverter).split(/^(\S+)\s*-?\s*/);
|
|
72
|
-
if (body?.length === 3) {
|
|
73
|
-
const param = body[1];
|
|
74
|
-
const doc = body[2];
|
|
75
|
-
const label = `*@${tag.name}* \`${param}\``;
|
|
76
|
-
if (!doc) {
|
|
77
|
-
return label;
|
|
78
|
-
}
|
|
79
|
-
return label + (doc.match(/\r\n|\n/g) ? ' \n' + processInlineTags(doc) : ` \u2014 ${processInlineTags(doc)}`);
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
// Generic tag
|
|
84
|
-
const label = `*@${tag.name}*`;
|
|
85
|
-
const text = getTagBodyText(tag, filePathConverter);
|
|
86
|
-
if (!text) {
|
|
87
|
-
return label;
|
|
88
|
-
}
|
|
89
|
-
return label + (text.match(/\r\n|\n/g) ? ' \n' + text : ` \u2014 ${text}`);
|
|
90
|
-
}
|
|
91
|
-
export function plainWithLinks(parts, filePathConverter) {
|
|
92
|
-
return processInlineTags(convertLinkTags(parts, filePathConverter));
|
|
93
|
-
}
|
|
94
|
-
/**
|
|
95
|
-
* Convert `@link` inline tags to markdown links
|
|
96
|
-
*/
|
|
97
|
-
function convertLinkTags(parts, filePathConverter) {
|
|
98
|
-
if (!parts) {
|
|
99
|
-
return '';
|
|
100
|
-
}
|
|
101
|
-
if (typeof parts === 'string') {
|
|
102
|
-
return parts;
|
|
103
|
-
}
|
|
104
|
-
const out = [];
|
|
105
|
-
let currentLink;
|
|
106
|
-
for (const part of parts) {
|
|
107
|
-
switch (part.kind) {
|
|
108
|
-
case 'link':
|
|
109
|
-
if (currentLink) {
|
|
110
|
-
if (currentLink.target) {
|
|
111
|
-
const link = filePathConverter.toResource(currentLink.target.file)
|
|
112
|
-
.with({
|
|
113
|
-
fragment: `L${currentLink.target.start.line},${currentLink.target.start.offset}`,
|
|
114
|
-
});
|
|
115
|
-
const linkText = currentLink.text ? currentLink.text : escapeMarkdownSyntaxTokensForCode(currentLink.name ?? '');
|
|
116
|
-
out.push(`[${currentLink.linkcode ? '`' + linkText + '`' : linkText}](${link.toString()})`);
|
|
117
|
-
}
|
|
118
|
-
else {
|
|
119
|
-
const text = currentLink.text ?? currentLink.name;
|
|
120
|
-
if (text) {
|
|
121
|
-
if (/^https?:/.test(text)) {
|
|
122
|
-
const parts = text.split(' ');
|
|
123
|
-
if (parts.length === 1) {
|
|
124
|
-
out.push(parts[0]);
|
|
125
|
-
}
|
|
126
|
-
else if (parts.length > 1) {
|
|
127
|
-
const linkText = escapeMarkdownSyntaxTokensForCode(parts.slice(1).join(' '));
|
|
128
|
-
out.push(`[${currentLink.linkcode ? '`' + linkText + '`' : linkText}](${parts[0]})`);
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
else {
|
|
132
|
-
out.push(escapeMarkdownSyntaxTokensForCode(text));
|
|
133
|
-
}
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
currentLink = undefined;
|
|
137
|
-
}
|
|
138
|
-
else {
|
|
139
|
-
currentLink = {
|
|
140
|
-
linkcode: part.text === '{@linkcode ',
|
|
141
|
-
};
|
|
142
|
-
}
|
|
143
|
-
break;
|
|
144
|
-
case 'linkName':
|
|
145
|
-
if (currentLink) {
|
|
146
|
-
currentLink.name = part.text;
|
|
147
|
-
currentLink.target = part.target;
|
|
148
|
-
}
|
|
149
|
-
break;
|
|
150
|
-
case 'linkText':
|
|
151
|
-
if (currentLink) {
|
|
152
|
-
currentLink.text = part.text;
|
|
153
|
-
}
|
|
154
|
-
break;
|
|
155
|
-
default:
|
|
156
|
-
out.push(part.text);
|
|
157
|
-
break;
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
return processInlineTags(out.join(''));
|
|
161
|
-
}
|
|
162
|
-
export function tagsMarkdownPreview(tags, filePathConverter) {
|
|
163
|
-
return tags.map(tag => getTagDocumentation(tag, filePathConverter)).join(' \n\n');
|
|
164
|
-
}
|
|
165
|
-
export function markdownDocumentation(documentation, tags, filePathConverter) {
|
|
166
|
-
const out = new MarkdownString();
|
|
167
|
-
addMarkdownDocumentation(out, documentation, tags, filePathConverter);
|
|
168
|
-
return out.value ? out.toMarkupContent() : undefined;
|
|
169
|
-
}
|
|
170
|
-
export function addMarkdownDocumentation(out, documentation, tags, converter) {
|
|
171
|
-
if (documentation) {
|
|
172
|
-
out.appendMarkdown(plainWithLinks(documentation, converter));
|
|
173
|
-
}
|
|
174
|
-
if (tags) {
|
|
175
|
-
const tagsPreview = tagsMarkdownPreview(tags, converter);
|
|
176
|
-
if (tagsPreview) {
|
|
177
|
-
out.appendMarkdown('\n\n' + tagsPreview);
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
return out;
|
|
181
|
-
}
|
|
182
|
-
function escapeMarkdownSyntaxTokensForCode(text) {
|
|
183
|
-
return text.replace(/`/g, '\\$&');
|
|
184
|
-
}
|
|
185
|
-
//# sourceMappingURL=previewer.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"previewer.js","sourceRoot":"","sources":["../../src/utils/previewer.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;;;;GAKG;AAIH,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAUrD,SAAS,YAAY,CAAC,IAAY;IAC9B,OAAO,IAAI;QACP,gBAAgB;SACf,OAAO,CAAC,4EAA4E,EAAE,CAAC,CAAC,EAAE,GAAW,EAAE,IAAY,EAAE,IAAa,EAAE,EAAE;QACnI,QAAQ,GAAG,EAAE;YACT,KAAK,UAAU;gBACX,OAAO,MAAM,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,IAAI,GAAG,CAAC;YAEzD;gBACI,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,GAAG,CAAC;SACxD;IACL,CAAC,CAAC,CAAC;AACX,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY;IACnC,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,cAAc,CACnB,GAAqB,EACrB,iBAA+C;IAE/C,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;QACX,OAAO,SAAS,CAAC;KACpB;IAED,oEAAoE;IACpE,SAAS,aAAa,CAAC,IAAY;QAC/B,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC;SACf;QACD,OAAO,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC;IACpC,CAAC;IAED,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC1D,QAAQ,GAAG,CAAC,IAAI,EAAE;QACd,KAAK,SAAS,CAAC,CAAC;YACZ,yCAAyC;YACzC,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;YAC9E,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,KAAK,KAAK,CAAC,EAAE;gBACpD,OAAO,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aACnG;iBAAM;gBACH,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;aAC9B;SACJ;QACD,KAAK,QAAQ,CAAC,CAAC;YACX,sCAAsC;YACtC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAE3D,IAAI,UAAU,KAAK,IAAI,EAAE;gBACrB,OAAO,IAAI,CAAC;aACf;iBAAM;gBACH,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9C;SACJ;QACD,KAAK,SAAS;YACV,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;KAClC;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,mBAAmB,CACxB,GAAqB,EACrB,iBAA+C;IAE/C,QAAQ,GAAG,CAAC,IAAI,EAAE;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS,CAAC;QACf,KAAK,OAAO,CAAC;QACb,KAAK,UAAU,CAAC,CAAC;YACb,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAClF,IAAI,IAAI,EAAE,MAAM,KAAK,CAAC,EAAE;gBACpB,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACtB,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACpB,MAAM,KAAK,GAAG,KAAK,GAAG,CAAC,IAAI,OAAO,KAAK,IAAI,CAAC;gBAC5C,IAAI,CAAC,GAAG,EAAE;oBACN,OAAO,KAAK,CAAC;iBAChB;gBACD,OAAO,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aAClH;SACJ;KACJ;IAED,cAAc;IACd,MAAM,KAAK,GAAG,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC;IAC/B,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IACpD,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,KAAK,CAAC;KAChB;IACD,OAAO,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,cAAc,CAC1B,KAAgD,EAChD,iBAA+C;IAE/C,OAAO,iBAAiB,CAAC,eAAe,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CACpB,KAA4D,EAC5D,iBAA+C;IAE/C,IAAI,CAAC,KAAK,EAAE;QACR,OAAO,EAAE,CAAC;KACb;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,OAAO,KAAK,CAAC;KAChB;IAED,MAAM,GAAG,GAAa,EAAE,CAAC;IAEzB,IAAI,WAA6G,CAAC;IAClH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACtB,QAAQ,IAAI,CAAC,IAAI,EAAE;YACf,KAAK,MAAM;gBACP,IAAI,WAAW,EAAE;oBACb,IAAI,WAAW,CAAC,MAAM,EAAE;wBACpB,MAAM,IAAI,GAAG,iBAAiB,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;6BAC7D,IAAI,CAAC;4BACF,QAAQ,EAAE,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE;yBACnF,CAAC,CAAC;wBAEP,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,iCAAiC,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;wBACjH,GAAG,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;qBAC/F;yBAAM;wBACH,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC;wBAClD,IAAI,IAAI,EAAE;4BACN,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gCACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gCAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;oCACpB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;iCACtB;qCAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;oCACzB,MAAM,QAAQ,GAAG,iCAAiC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;oCAC7E,GAAG,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;iCACxF;6BACJ;iCAAM;gCACH,GAAG,CAAC,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC,CAAC;6BACrD;yBACJ;qBACJ;oBACD,WAAW,GAAG,SAAS,CAAC;iBAC3B;qBAAM;oBACH,WAAW,GAAG;wBACV,QAAQ,EAAE,IAAI,CAAC,IAAI,KAAK,aAAa;qBACxC,CAAC;iBACL;gBACD,MAAM;YAEV,KAAK,UAAU;gBACX,IAAI,WAAW,EAAE;oBACb,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;oBAC7B,WAAW,CAAC,MAAM,GAAI,IAAiC,CAAC,MAAM,CAAC;iBAClE;gBACD,MAAM;YAEV,KAAK,UAAU;gBACX,IAAI,WAAW,EAAE;oBACb,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;iBAChC;gBACD,MAAM;YAEV;gBACI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpB,MAAM;SACb;KACJ;IACD,OAAO,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAC/B,IAAiC,EACjC,iBAA+C;IAE/C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,qBAAqB,CACjC,aAA2D,EAC3D,IAAoC,EACpC,iBAA+C;IAE/C,MAAM,GAAG,GAAG,IAAI,cAAc,EAAE,CAAC;IACjC,wBAAwB,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;IACtE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,wBAAwB,CACpC,GAAmB,EACnB,aAA2D,EAC3D,IAAoC,EACpC,SAAuC;IAEvC,IAAI,aAAa,EAAE;QACf,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC;KAChE;IACD,IAAI,IAAI,EAAE;QACN,MAAM,WAAW,GAAG,mBAAmB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACzD,IAAI,WAAW,EAAE;YACb,GAAG,CAAC,cAAc,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC;SAC5C;KACJ;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED,SAAS,iCAAiC,CAAC,IAAY;IACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"previewer.spec.d.ts","sourceRoot":"","sources":["../../src/utils/previewer.spec.ts"],"names":[],"mappings":""}
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
/*---------------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
4
|
-
*--------------------------------------------------------------------------------------------*/
|
|
5
|
-
/*
|
|
6
|
-
* Copyright (C) 2022 TypeFox and others.
|
|
7
|
-
*
|
|
8
|
-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
|
9
|
-
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*/
|
|
11
|
-
import vscodeUri from 'vscode-uri';
|
|
12
|
-
import * as chai from 'chai';
|
|
13
|
-
import { markdownDocumentation, plainWithLinks, tagsMarkdownPreview } from './previewer.js';
|
|
14
|
-
const assert = chai.assert;
|
|
15
|
-
const noopToResource = {
|
|
16
|
-
toResource: (path) => vscodeUri.URI.file(path),
|
|
17
|
-
};
|
|
18
|
-
describe('typescript.previewer', () => {
|
|
19
|
-
it('Should ignore hyphens after a param tag', async () => {
|
|
20
|
-
assert.strictEqual(tagsMarkdownPreview([
|
|
21
|
-
{
|
|
22
|
-
name: 'param',
|
|
23
|
-
text: 'a - b',
|
|
24
|
-
},
|
|
25
|
-
], noopToResource), '*@param* `a` — b');
|
|
26
|
-
});
|
|
27
|
-
it('Should parse url jsdoc @link', async () => {
|
|
28
|
-
assert.strictEqual(markdownDocumentation('x {@link http://www.example.com/foo} y {@link https://api.jquery.com/bind/#bind-eventType-eventData-handler} z', [], noopToResource).value, 'x [http://www.example.com/foo](http://www.example.com/foo) y [https://api.jquery.com/bind/#bind-eventType-eventData-handler](https://api.jquery.com/bind/#bind-eventType-eventData-handler) z');
|
|
29
|
-
});
|
|
30
|
-
it('Should parse url jsdoc @link with text', async () => {
|
|
31
|
-
assert.strictEqual(markdownDocumentation('x {@link http://www.example.com/foo abc xyz} y {@link http://www.example.com/bar|b a z} z', [], noopToResource).value, 'x [abc xyz](http://www.example.com/foo) y [b a z](http://www.example.com/bar) z');
|
|
32
|
-
});
|
|
33
|
-
it('Should treat @linkcode jsdocs links as monospace', async () => {
|
|
34
|
-
assert.strictEqual(markdownDocumentation('x {@linkcode http://www.example.com/foo} y {@linkplain http://www.example.com/bar} z', [], noopToResource).value, 'x [`http://www.example.com/foo`](http://www.example.com/foo) y [http://www.example.com/bar](http://www.example.com/bar) z');
|
|
35
|
-
});
|
|
36
|
-
it('Should parse url jsdoc @link in param tag', async () => {
|
|
37
|
-
assert.strictEqual(tagsMarkdownPreview([
|
|
38
|
-
{
|
|
39
|
-
name: 'param',
|
|
40
|
-
text: 'a x {@link http://www.example.com/foo abc xyz} y {@link http://www.example.com/bar|b a z} z',
|
|
41
|
-
},
|
|
42
|
-
], noopToResource), '*@param* `a` — x [abc xyz](http://www.example.com/foo) y [b a z](http://www.example.com/bar) z');
|
|
43
|
-
});
|
|
44
|
-
it('Should ignore unclosed jsdocs @link', async () => {
|
|
45
|
-
assert.strictEqual(markdownDocumentation('x {@link http://www.example.com/foo y {@link http://www.example.com/bar bar} z', [], noopToResource).value, 'x {@link http://www.example.com/foo y [bar](http://www.example.com/bar) z');
|
|
46
|
-
});
|
|
47
|
-
it('Should support non-ascii characters in parameter name (#90108)', async () => {
|
|
48
|
-
assert.strictEqual(tagsMarkdownPreview([
|
|
49
|
-
{
|
|
50
|
-
name: 'param',
|
|
51
|
-
text: 'parámetroConDiacríticos this will not',
|
|
52
|
-
},
|
|
53
|
-
], noopToResource), '*@param* `parámetroConDiacríticos` — this will not');
|
|
54
|
-
});
|
|
55
|
-
it('Should render @example blocks as code', () => {
|
|
56
|
-
assert.strictEqual(tagsMarkdownPreview([
|
|
57
|
-
{
|
|
58
|
-
name: 'example',
|
|
59
|
-
text: 'code();',
|
|
60
|
-
},
|
|
61
|
-
], noopToResource), '*@example* \n```\ncode();\n```');
|
|
62
|
-
});
|
|
63
|
-
it('Should not render @example blocks as code as if they contain a codeblock', () => {
|
|
64
|
-
assert.strictEqual(tagsMarkdownPreview([
|
|
65
|
-
{
|
|
66
|
-
name: 'example',
|
|
67
|
-
text: 'Not code\n```\ncode();\n```',
|
|
68
|
-
},
|
|
69
|
-
], noopToResource), '*@example* \nNot code\n```\ncode();\n```');
|
|
70
|
-
});
|
|
71
|
-
it('Should render @example blocks as code if they contain a <caption>', () => {
|
|
72
|
-
assert.strictEqual(tagsMarkdownPreview([
|
|
73
|
-
{
|
|
74
|
-
name: 'example',
|
|
75
|
-
text: '<caption>Not code</caption>\ncode();',
|
|
76
|
-
},
|
|
77
|
-
], noopToResource), '*@example* \nNot code\n```\ncode();\n```');
|
|
78
|
-
});
|
|
79
|
-
it('Should not render @example blocks as code if they contain a <caption> and a codeblock', () => {
|
|
80
|
-
assert.strictEqual(tagsMarkdownPreview([
|
|
81
|
-
{
|
|
82
|
-
name: 'example',
|
|
83
|
-
text: '<caption>Not code</caption>\n```\ncode();\n```',
|
|
84
|
-
},
|
|
85
|
-
], noopToResource), '*@example* \nNot code\n```\ncode();\n```');
|
|
86
|
-
});
|
|
87
|
-
it('Should render @linkcode symbol name as code', async () => {
|
|
88
|
-
assert.strictEqual(plainWithLinks([
|
|
89
|
-
{ text: 'a ', kind: 'text' },
|
|
90
|
-
{ text: '{@linkcode ', kind: 'link' },
|
|
91
|
-
{
|
|
92
|
-
text: 'dog',
|
|
93
|
-
kind: 'linkName',
|
|
94
|
-
target: {
|
|
95
|
-
file: '/path/file.ts',
|
|
96
|
-
start: { line: 7, offset: 5 },
|
|
97
|
-
end: { line: 7, offset: 13 },
|
|
98
|
-
},
|
|
99
|
-
},
|
|
100
|
-
{ text: '}', kind: 'link' },
|
|
101
|
-
{ text: ' b', kind: 'text' },
|
|
102
|
-
], noopToResource), 'a [`dog`](file:///path/file.ts#L7%2C5) b');
|
|
103
|
-
});
|
|
104
|
-
it('Should render @linkcode text as code', async () => {
|
|
105
|
-
assert.strictEqual(plainWithLinks([
|
|
106
|
-
{ text: 'a ', kind: 'text' },
|
|
107
|
-
{ text: '{@linkcode ', kind: 'link' },
|
|
108
|
-
{
|
|
109
|
-
text: 'dog',
|
|
110
|
-
kind: 'linkName',
|
|
111
|
-
target: {
|
|
112
|
-
file: '/path/file.ts',
|
|
113
|
-
start: { line: 7, offset: 5 },
|
|
114
|
-
end: { line: 7, offset: 13 },
|
|
115
|
-
},
|
|
116
|
-
},
|
|
117
|
-
{ text: 'husky', kind: 'linkText' },
|
|
118
|
-
{ text: '}', kind: 'link' },
|
|
119
|
-
{ text: ' b', kind: 'text' },
|
|
120
|
-
], noopToResource), 'a [`husky`](file:///path/file.ts#L7%2C5) b');
|
|
121
|
-
});
|
|
122
|
-
});
|
|
123
|
-
//# sourceMappingURL=previewer.spec.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"previewer.spec.js","sourceRoot":"","sources":["../../src/utils/previewer.spec.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;;;;GAKG;AAEH,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAgC,qBAAqB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE1H,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;AAE3B,MAAM,cAAc,GAAiC;IACjD,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;CACjD,CAAC;AAEF,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC;YAChB;gBACI,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;aAChB;SACJ,EAAE,cAAc,CAAC,EAClB,kBAAkB,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,CAAC,WAAW,CACd,qBAAqB,CACjB,gHAAgH,EAChH,EAAE,EACF,cAAc,CAChB,CAAC,KAAK,EACR,+LAA+L,CAAC,CAAC;IACzM,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,CAAC,WAAW,CACd,qBAAqB,CACjB,2FAA2F,EAC3F,EAAE,EACF,cAAc,CAChB,CAAC,KAAK,EACR,iFAAiF,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,CAAC,WAAW,CACd,qBAAqB,CACjB,sFAAsF,EACtF,EAAE,EACF,cAAc,CAChB,CAAC,KAAK,EACR,2HAA2H,CAAC,CAAC;IACrI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC;YAChB;gBACI,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,6FAA6F;aACtG;SACJ,EAAE,cAAc,CAAC,EAClB,gGAAgG,CAAC,CAAC;IAC1G,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,CAAC,WAAW,CACd,qBAAqB,CACjB,gFAAgF,EAChF,EAAE,EACF,cAAc,CAChB,CAAC,KAAK,EACR,2EAA2E,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC;YAChB;gBACI,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,uCAAuC;aAChD;SACJ,EAAE,cAAc,CAAC,EAClB,oDAAoD,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC;YAChB;gBACI,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAClB;SACJ,EAAE,cAAc,CAAC,EAClB,iCAAiC,CACpC,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;QAChF,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC;YAChB;gBACI,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,6BAA6B;aACtC;SACJ,EAAE,cAAc,CAAC,EAClB,2CAA2C,CAC9C,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QACzE,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC;YAChB;gBACI,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,sCAAsC;aAC/C;SACJ,EAAE,cAAc,CAAC,EAClB,2CAA2C,CAC9C,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,GAAG,EAAE;QAC7F,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC;YAChB;gBACI,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,gDAAgD;aACzD;SACJ,EAAE,cAAc,CAAC,EAClB,2CAA2C,CAC9C,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,CAAC,WAAW,CACd,cAAc,CAAC;YACX,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE;YAC5B,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE;YACrC;gBACI,IAAI,EAAE,KAAK;gBACX,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE;oBACJ,IAAI,EAAE,eAAe;oBACrB,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;oBAC7B,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;iBAC/B;aACqB;YAC1B,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;YAC3B,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE;SAC/B,EAAE,cAAc,CAAC,EAClB,0CAA0C,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,CAAC,WAAW,CACd,cAAc,CAAC;YACX,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE;YAC5B,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE;YACrC;gBACI,IAAI,EAAE,KAAK;gBACX,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE;oBACJ,IAAI,EAAE,eAAe;oBACrB,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;oBAC7B,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;iBAC/B;aACqB;YAC1B,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE;YACnC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;YAC3B,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE;SAC/B,EAAE,cAAc,CAAC,EAClB,4CAA4C,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
package/lib/utils/tsconfig.d.ts
DELETED
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { WorkspaceConfigurationImplicitProjectConfigurationOptions } from '../configuration-manager.js';
|
|
2
|
-
import { tsp } from '../ts-protocol.js';
|
|
3
|
-
export declare function getInferredProjectCompilerOptions(workspaceConfig: WorkspaceConfigurationImplicitProjectConfigurationOptions): tsp.ExternalProjectCompilerOptions;
|
|
4
|
-
//# sourceMappingURL=tsconfig.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tsconfig.d.ts","sourceRoot":"","sources":["../../src/utils/tsconfig.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,yDAAyD,EAAE,MAAM,6BAA6B,CAAC;AAC7G,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AASxC,wBAAgB,iCAAiC,CAC7C,eAAe,EAAE,yDAAyD,GAC3E,GAAG,CAAC,8BAA8B,CA8BpC"}
|