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
|
import type { MethodDeclaration } from 'ts-morph';
import { getProject } from '../project';
import { exactlyOne } from '../utils/value-checks';
import { newProcessingError } from './error';
import type { JSDocableLikeNode } from './jsdocs';
import {
getDeprecated,
getDescription,
getExamples,
getJsDocs,
getRemarks,
getSeeAlsos,
getSince,
getThrows,
} from './jsdocs';
import type { RawApiDocsParameter } from './parameter';
import { processParameters, processTypeParameters } from './parameter';
import type { SourceableNode } from './source';
import type { RawApiDocsType } from './type';
import { getTypeText } from './type';
/**
* Represents a method signature in the raw API docs.
*/
export interface RawApiDocsSignature {
/**
* The deprecation notice of the signature, if it has one.
*/
deprecated: string | undefined;
/**
* The description of the signature.
*/
description: string;
/**
* The version when the signature was added.
*/
since: string;
/**
* The parameters of the signature.
*/
parameters: RawApiDocsParameter[];
/**
* Additional comments of the signature that are supposed to stand out from the description.
*/
remarks: string[];
/**
* The return type of the signature.
*/
returns: RawApiDocsType;
/**
* The exceptions thrown by the signature.
*/
throws: string[];
/**
* The full call signature as text.
*/
signature: string;
/**
* The usage examples of the signature.
*/
examples: string[];
/**
* The see also links of the signature.
*/
seeAlsos: string[];
}
export type SignatureLikeDeclaration = Pick<
MethodDeclaration,
'getTypeParameters' | 'getParameters' | 'getReturnType' | 'getText'
> &
JSDocableLikeNode &
SourceableNode;
export function processSignatures(
name: string,
signatures: SignatureLikeDeclaration[],
implementation: SignatureLikeDeclaration
): RawApiDocsSignature[] {
return signatures.map((signature, i) => {
try {
return processSignature(signature, implementation);
} catch (error) {
throw newProcessingError({
type: 'signature',
name: `${name}/${i}`,
source: signature,
cause: error,
});
}
});
}
function processSignature(
signature: SignatureLikeDeclaration,
implementation: SignatureLikeDeclaration
): RawApiDocsSignature {
const jsdocs = getJsDocs(signature);
const parameters = [
...processTypeParameters(signature.getTypeParameters(), jsdocs),
...processParameters(
signature.getParameters(),
implementation.getParameters(),
jsdocs
),
];
const returns = getTypeText(signature.getReturnType());
try {
return {
deprecated: getDeprecated(jsdocs),
description: getDescription(jsdocs),
since: getSince(jsdocs),
parameters,
remarks: getRemarks(jsdocs),
returns,
throws: getThrows(jsdocs),
signature: getSignatureText(signature),
examples: getExamples(jsdocs),
seeAlsos: getSeeAlsos(jsdocs),
};
} catch (error) {
throw newProcessingError({
type: 'jsdocs',
name: signature.getText(),
source: jsdocs,
cause: error,
});
}
}
// Cache the project for performance reasons
const signatureExtractionProject = getProject({
skipAddingFilesFromTsConfig: true,
});
function getSignatureText(signature: SignatureLikeDeclaration): string {
const fullText = signature
.getText()
// Remove all jsdocs
.replaceAll(/ *\/\*\*[^\n]*\n(\s*\*[^\n]*\n)*\s*\*\/\n/g, '')
// Remove all empty lines
.replaceAll(/\n\n+/g, '\n')
// Remove the export function keyword for consistency with member methods
.replace(/^export function /, '');
// Is this already a signature
if (fullText.endsWith(';')) {
// Restore the function keyword
return `function ${fullText}`;
}
// Create a copy of the signature to keep the line numbers unchanged
// and for performance reasons, as removing and re-adding the body is slow.
// We use a function here to avoid unnecessary boilerplate
const fn = exactlyOne(
signatureExtractionProject
.createSourceFile('temp.ts', `function ${fullText}`, { overwrite: true })
.getFunctions(),
'function signature'
);
fn.removeBody();
return fn.getText();
}
|
