Repository navigation
Expand file tree
/
Copy pathast-processing.ts
More file actions
529 lines (474 loc) · 18.2 KB
/
Copy pathast-processing.ts
File metadata and controls
529 lines (474 loc) · 18.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
import {
JSDocTag,
Printer,
TypeChecker,
isFunctionDeclaration,
EmitHint,
addSyntheticLeadingComment,
SyntaxKind,
Node,
FunctionDeclaration,
TransformationContext,
JSDocUnknownTag,
JSDocSeeTag,
ClassDeclaration,
isClassDeclaration,
isMethodDeclaration,
MethodDeclaration,
Identifier,
JSDocReturnTag,
JSDocParameterTag,
PropertyDeclaration,
isPropertyDeclaration,
isMethodSignature,
MethodSignature,
InterfaceDeclaration,
isInterfaceDeclaration,
isPropertySignature,
PropertySignature,
isConstructorTypeNode,
isTypeLiteralNode,
} from "typescript";
import { fixupHtmlDocs, fixupLocalLinks } from "./html-doc-processing";
import { ClassDocNode, MethodDocNode, ModuleDocNode, PropertyDocNode, SignatureDocNode } from "./node-doc-processing";
import { getIndent, getPropertyName, isNamedModuleDeclaration, nodeWarning, removeCommentsRecursive } from "./ast-utils";
import { contextDeduper, replaceLineBreaks, wordWrap } from "./utils";
interface ProcessData {
text: string;
tags: JSDocTag[];
}
enum JSDocMatchResult {
Ok,
Ignore,
Failed,
}
interface BadProcessResult {
status: JSDocMatchResult.Failed | JSDocMatchResult.Ignore;
}
interface GoodProcessResult {
status: JSDocMatchResult.Ok;
data: ProcessData;
postprocess?(res: string): string;
}
export interface DocAugmentationContext {
indent: number;
readonly printer: Printer;
readonly typeChecker: TypeChecker;
readonly moduleDocs: ModuleDocNode;
readonly transformationContext: TransformationContext;
}
type JSDocResult = GoodProcessResult | BadProcessResult;
const ignoreFunctions = new Set(['pseudoRandomBytes', '___promisify__']);
const allowedDefaultValueWords = new Set(['true', 'false']);
class TagHelper {
constructor(private readonly docContext: DocAugmentationContext) {
}
/**
* This is needed as prettier doesn't really deal with JSDoc
*/
private fixupCommentFormatting(desc: string, tagName: string): string {
const maxWidth = maxLineLength - this.docContext.indent - jsDocLinePrefixLength - tagName.length - 2; // -2 `@<tag> `
// TODO: For some reason `createJSDoc` does not create the ` * ` prefix for multi-line tag comments...
const lines = wordWrap(fixupLocalLinks(replaceLineBreaks(desc), this.docContext.moduleDocs.name), maxWidth).split('\n');
for (let i = 1; i < lines.length; ++i) {
lines[i] = ` * ${lines[i]}`;
}
return lines.join('\n');
}
private createUnknownTag(type: string, text: string): JSDocUnknownTag {
const { factory } = this.docContext.transformationContext;
return factory.createJSDocUnknownTag(
factory.createIdentifier(type),
this.fixupCommentFormatting(text, type)
);
}
private createParamTag(name: string, description: string, defaultValue?: string): JSDocParameterTag {
const { factory } = this.docContext.transformationContext;
if (defaultValue) {
const firstIndex = defaultValue.indexOf('`');
const secondIdx = firstIndex > -1 ? defaultValue.indexOf('`', firstIndex + 1) : -1;
if (secondIdx > 0) {
defaultValue = defaultValue.slice(0, secondIdx + 1);
}
defaultValue = defaultValue.replaceAll(/[`\[\]]/g, '');
if (defaultValue.length <= 32 && defaultValue !== 'undefined') {
// sometimes strings are not wrapped correctly.
if (!defaultValue.includes('.') && !/^[0-9']/.test(defaultValue) && !allowedDefaultValueWords.has(defaultValue)) {
defaultValue = `'${defaultValue}'`;
}
name = `[${name}=${defaultValue}]`;
}
}
return factory.createJSDocParameterTag(undefined,
factory.createIdentifier(name),
false,
undefined,
true,
this.fixupCommentFormatting(description, `param ${name}`)
);
}
createSinceTag(text: string): JSDocUnknownTag {
// no comment fixup since it's just versions
return this.createUnknownTag('since', text);
}
createExperimentalTag(): JSDocUnknownTag {
return this.createUnknownTag('experimental', '');
}
createDeprecatedTag(text: string): JSDocUnknownTag {
// Would use factory.creatJSDocDeprecated tag but that doesn't work...
return this.createUnknownTag('deprecated', this.fixupCommentFormatting(text, 'deprecated'));
}
createSeeLinkTag(url: string, text: string): JSDocSeeTag {
const { factory } = this.docContext.transformationContext;
return this.docContext.transformationContext.factory.createJSDocSeeTag(
factory.createIdentifier('see'),
undefined, `[${text}](${url})`);
}
private createReturnTag(text: string): JSDocReturnTag {
const { factory } = this.docContext.transformationContext;
return factory.createJSDocReturnTag(
factory.createIdentifier('return'),
undefined,
this.fixupCommentFormatting(text, 'return')
);
}
private normalizeVersionString(ver: string): string {
if (!ver.startsWith('v')) {
ver = 'v' + ver;
}
if (ver.split('.').length < 3) {
ver + '.0';
}
return ver;
}
/**
* Generates common tags eg. `@deprecated` `@experimental` description etc.
*/
extractCommonTags({ meta, stabilityText, stability }: MethodDocNode | ModuleDocNode | ClassDocNode | PropertyDocNode, moduleName: string): JSDocTag[] {
const tags: JSDocTag[] = [];
if (meta?.added) {
tags.push(this.createSinceTag(meta.added.map(a => this.normalizeVersionString(a)).join(', ')));
}
stabilityText = fixupLocalLinks(stabilityText ?? '', moduleName);
if (meta?.deprecated) {
let str = `Since ${meta.deprecated.map(d => this.normalizeVersionString(d)).join()}`;
if (stabilityText) {
str += ` - ${stabilityText.replace('Deprecated: ', '').replace('Deprecated. ', '')}`;
}
tags.push(this.createDeprecatedTag(str));
return tags;
}
switch (stability) {
case Stability.Deprecated:
tags.push(this.createDeprecatedTag((stabilityText ?? '').replace('Deprecated: ', '').replace('Deprecated. ', '')));
break;
case Stability.Experimental:
tags.push(this.createExperimentalTag());
break;
case Stability.Legacy:
tags.push(this.createDeprecatedTag(stabilityText?.replace('Legacy. ', '') ?? 'Legacy API'));
break;
}
return tags;
}
/**
* Generates param tags based on tags.
* TODO: Ensure jsdoc matches signature...
*/
extractParamTags(sigDoc: SignatureDocNode, moduleName: string): JSDocTag[] {
const tags: JSDocTag[] = [];
for (const param of sigDoc.params) {
if (param.desc || param.default) {
tags.push(this.createParamTag((param.name || '').replaceAll('.', ''), param.desc ?? '', param.default));
}
}
if (sigDoc.return?.desc) {
tags.push(this.createReturnTag(fixupLocalLinks(sigDoc.return.desc, moduleName)));
}
return tags;
}
}
/**
* Matches a class declaration to a class in a module document node.
*/
function matchClassOrInterfaceDoc(moduleDocs: ModuleDocNode, node: ClassDeclaration | InterfaceDeclaration): ClassDocNode | undefined {
return moduleDocs.classes?.find(m => m.name === node.name?.escapedText || m.name.replace(moduleDocs.name + '.', '') === node.name?.escapedText);
}
enum Stability {
Deprecated = 0,
Experimental = 1,
Stable = 2,
Legacy = 3
}
// Used to avoid generating duplicate docs for overloads.
const processedFunctions = new Set<MethodDocNode>();
const eventEmitterMethods = new Set([
'addListener',
'emit',
'getEventListener',
'listenerCount',
'off',
'on',
'once',
'prependListener',
'prependOnceListener',
'removeListener'
]);
const processedInstanceMethods = contextDeduper<Node, string>();
const processedStaticMethods = contextDeduper<Node, string>();
const maxLineLength = 200;
const jsDocLinePrefixLength = 3; // ' * '
export class NodeProcessingContext {
private readonly tagHelper: TagHelper;
constructor(private readonly context: DocAugmentationContext) {
this.tagHelper = new TagHelper(context);
}
private fixupDescriptionFormatting(desc: string | undefined, moduleName: string): string {
if (!desc) {
return '';
}
desc = fixupHtmlDocs(desc, {
moduleName,
});
const maxWidth = maxLineLength - this.context.indent - jsDocLinePrefixLength;
desc = desc.split('\n').map(l => wordWrap(l, maxWidth)).join('\n');
return desc;
}
/**
* Generates data that is common for all functions/methods.
*/
private getCallSignatureDocData(moduleDocs: ModuleDocNode, methodDoc: MethodDocNode): ProcessData {
const { desc, signatures } = methodDoc;
let tags = this.tagHelper.extractCommonTags(methodDoc, moduleDocs.name);
const [sig] = signatures; // TODO: Multi sig
if (sig) {
tags = tags.concat(this.tagHelper.extractParamTags(sig, moduleDocs.name));
}
return {
text: this.fixupDescriptionFormatting(desc, moduleDocs.name),
tags,
};
}
private handlePropertyDeclaration(node: PropertyDeclaration | PropertySignature): JSDocResult {
const name = getPropertyName(node.name);
if (!name) {
return {
status: JSDocMatchResult.Ignore,
};
}
let { properties } = this.context.moduleDocs;
const parent = node.parent;
if (isConstructorTypeNode(parent) || isTypeLiteralNode(parent)) {
return {
status: JSDocMatchResult.Ignore,
};
}
if (isClassDeclaration(parent) || isInterfaceDeclaration(parent)) {
const classDoc = matchClassOrInterfaceDoc(this.context.moduleDocs, parent);
if (!classDoc) {
return {
status: JSDocMatchResult.Ignore,
};
}
if (classDoc.properties) {
properties = classDoc.properties;
}
}
const propertyDoc = properties?.find(m => {
// Sometimes property names are just `Type` which is really damn helpful, we can extract an alternative
// from `textRaw` instead
if ((m.name === 'Type' || m.name === 'return') && m.textRaw) {
const altMatch = m.textRaw.match(/^`(.*?)`/);
if (altMatch) {
return name === altMatch[1];
}
console.warn(`Could not find real name of doc node ${JSON.stringify(m)}`);
}
return m.name === name;
});
if (!propertyDoc) {
return {
status: JSDocMatchResult.Failed,
};
}
const { moduleDocs } = this.context;
const { desc } = propertyDoc;
const tags = this.tagHelper.extractCommonTags(propertyDoc, moduleDocs.name);
return {
status: JSDocMatchResult.Ok,
data: {
text: this.fixupDescriptionFormatting(desc, moduleDocs.name),
tags,
}
};
}
/**
* Processes generic `function ...` statements
*/
private processFunctionDeclaration(node: FunctionDeclaration): JSDocResult {
const { moduleDocs } = this.context;
if (ignoreFunctions.has(node.name?.escapedText!)) {
return {
status: JSDocMatchResult.Ignore,
};
}
const methodDoc = moduleDocs.methods?.find(m => m.name === node.name?.escapedText);
if (!methodDoc) {
return {
status: JSDocMatchResult.Failed,
};
}
if (processedFunctions.has(methodDoc)) {
return {
status: JSDocMatchResult.Ignore,
};
}
processedFunctions.add(methodDoc);
return {
status: JSDocMatchResult.Ok,
data: this.getCallSignatureDocData(moduleDocs, methodDoc),
};
}
/**
* Processes named module declarations.
*/
private handleModuleDeclaration(): JSDocResult {
const { moduleDocs } = this.context;
const tags = this.tagHelper.extractCommonTags(moduleDocs, moduleDocs.name);
// Get rid of bloaty source label
let desc = moduleDocs.desc ?? '';
const removeSourceRegex = /<p><strong>Source Code:<\/strong> <a href="(.*?)">.*?<\/a><\/p>/;
const match = removeSourceRegex.exec(desc);
if (match) {
tags.push(this.tagHelper.createSeeLinkTag(match[1]!, 'source'));
desc = desc.replace(removeSourceRegex, ``);
}
return {
status: JSDocMatchResult.Ok,
data: {
text: this.fixupDescriptionFormatting(desc, moduleDocs.name),
tags,
}
};
}
/**
* Processes class declarations
*/
private handleClassDeclaration(node: ClassDeclaration): JSDocResult {
const { moduleDocs } = this.context;
// class names tend to be randomly prefixed, yaaay
const classDoc = matchClassOrInterfaceDoc(moduleDocs, node);
if (!classDoc) {
return {
status: JSDocMatchResult.Failed,
};
}
const tags = this.tagHelper.extractCommonTags(classDoc, moduleDocs.name);
// Get rid of bloaty source label
return {
status: JSDocMatchResult.Ok,
data: {
text: this.fixupDescriptionFormatting(classDoc.desc, moduleDocs.name).replace(/\* Extends: `.*?`/, '').trim(),
tags,
},
};
}
/**
* Handles both class and interface method declarations
*/
private handleMethodDeclaration(node: MethodDeclaration | MethodSignature): JSDocResult {
const name = getPropertyName(node.name);
if (!name) {
return {
status: JSDocMatchResult.Ignore,
};
}
const methodName = (node.name as Identifier).escapedText!;
// Suppress event emitter declarations unless we are the events module
if (eventEmitterMethods.has(methodName) && this.context.moduleDocs.name !== 'events') {
return {
status: JSDocMatchResult.Ignore,
};
}
const parent = node.parent;
if (!(isInterfaceDeclaration(parent) || isClassDeclaration(parent))) {
return {
status: JSDocMatchResult.Ignore,
};
}
const isStatic = node.modifiers?.some(m => m.kind === SyntaxKind.StaticKeyword);
// ignore duplicates by parent and `staticness`
if ((isStatic ? processedStaticMethods : processedInstanceMethods)(parent, methodName)) {
return {
status: JSDocMatchResult.Ignore,
};
}
const classDoc = matchClassOrInterfaceDoc(this.context.moduleDocs, parent);
// We already warn about missing class docs, let's not be obnoxious
if (!classDoc) {
return {
status: JSDocMatchResult.Ignore,
};
}
const methodDocList = isStatic ? classDoc.classMethods : classDoc.methods;
const methodDoc = methodDocList?.find(({ name }) => name === methodName);
if (!methodDoc) {
return {
status: JSDocMatchResult.Failed,
};
}
return {
status: JSDocMatchResult.Ok,
data: this.getCallSignatureDocData(this.context.moduleDocs, methodDoc),
};
}
getTransformationContext(): TransformationContext {
return this.context.transformationContext;
}
processNode(node: Node): void {
const { printer, typeChecker, transformationContext } = this.context;
let processRes: JSDocResult = {
status: JSDocMatchResult.Ignore,
};
this.context.indent = getIndent(node);
if (isFunctionDeclaration(node)) {
processRes = this.processFunctionDeclaration(node);
} else if (isNamedModuleDeclaration(node)
&& !(node.name.text.startsWith('node:') && node.name.text !== 'node:test') // apparently everything is a module
) {
processRes = this.handleModuleDeclaration();
} else if (isClassDeclaration(node)) {
processRes = this.handleClassDeclaration(node);
} else if (isMethodDeclaration(node) || isMethodSignature(node)) {
processRes = this.handleMethodDeclaration(node);
} else if (isPropertyDeclaration(node) || isPropertySignature(node)) {
processRes = this.handlePropertyDeclaration(node);
}
if (processRes.status === JSDocMatchResult.Ignore) {
return;
}
if (processRes.status === JSDocMatchResult.Ok) {
if (node.getFullText().includes('@keepdoc')) {
nodeWarning(node, `Skipping doc replace for`);
return;
}
if (processRes.data.text === '' && processRes.data.tags.length === 0) {
nodeWarning(node, 'Skipping docs for');
return;
}
const jsdoc = '*' + printer.printNode(
EmitHint.Unspecified,
transformationContext.factory.createJSDocComment(processRes.data.text, processRes.data.tags),
node.getSourceFile(),
)
.replaceAll('/**', '')
.replaceAll('*/', '')
.replaceAll(/<(.*?)>/g, '$1');
const newNode = removeCommentsRecursive(node, transformationContext, typeChecker);
addSyntheticLeadingComment(newNode, SyntaxKind.MultiLineCommentTrivia, jsdoc, true);
} else {
//console.log(node)
nodeWarning(node, `Could not match doc for symbol`);
}
}
}