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
|
import type { ClassDeclaration, InterfaceDeclaration, Project } from 'ts-morph';
import { required, valuesForKeys } from '../utils/value-checks';
import { newProcessingError } from './error';
import type { JSDocableLikeNode } from './jsdocs';
import {
getDeprecated,
getDescription,
getExamples,
getJsDocs,
} from './jsdocs';
import type { RawApiDocsMethod } from './method';
import {
processClassConstructors,
processClassMethods,
processInterfaceMethods,
processUtilityFunctions,
} from './method';
/**
* Represents a raw page in the API docs.
*/
export interface RawApiDocsPage {
/**
* The title of the page as shown to users.
*/
title: string;
/**
* The title of the page in camel case as used in paths.
*/
camelTitle: string;
/**
* The category of the page, if it has one.
*/
category: string | undefined;
/**
* The deprecation notice of the page, if it has one.
*/
deprecated: string | undefined;
/**
* The description of the page.
*/
description: string;
/**
* The usage examples of the elements on the page.
*/
examples: string[];
/**
* The api methods on the page.
*/
methods: RawApiDocsMethod[];
}
// Classes
function getAllClasses(
project: Project,
filter: (name: string) => boolean = () => true
): Record<string, ClassDeclaration> {
return Object.fromEntries(
project
.getSourceFiles()
.flatMap((file) => file.getClasses())
.map((clazz) => [clazz.getNameOrThrow(), clazz] as const)
.filter(([name]) => filter(name))
);
}
export function processProjectClasses(project: Project): RawApiDocsPage[] {
return processClasses(
valuesForKeys(getAllClasses(project), ['Faker', 'SimpleFaker'])
);
}
function processClasses(classes: ClassDeclaration[]): RawApiDocsPage[] {
return classes.map((clazz) => {
try {
return processClass(clazz);
} catch (error) {
throw newProcessingError({
type: 'class',
name: clazz.getNameOrThrow(),
source: clazz,
cause: error,
});
}
});
}
export function processClass(clazz: ClassDeclaration): RawApiDocsPage {
const result = processModule(clazz);
result.methods.unshift(...processClassConstructors(clazz));
return result;
}
// Modules
export function processModuleClasses(project: Project): RawApiDocsPage[] {
return processModules(
Object.values(
getAllClasses(
project,
(module: string): boolean =>
module.endsWith('Module') && !module.startsWith('Simple')
)
).sort((a, b) => a.getNameOrThrow().localeCompare(b.getNameOrThrow()))
);
}
function processModules(modules: ClassDeclaration[]): RawApiDocsPage[] {
return modules.map((module) => {
try {
return processModule(module, 'Modules');
} catch (error: unknown) {
throw newProcessingError({
type: 'module',
name: getModuleName(module),
source: module,
cause: error,
});
}
});
}
function processModule(
module: ClassDeclaration,
category: string | undefined = undefined
): RawApiDocsPage {
const title = getModuleName(module);
return {
...preparePage(module, title, category),
methods: processClassMethods(module),
};
}
function getModuleName(module: ClassDeclaration): string {
return required(module.getName(), 'module name').replace(/Module$/, '');
}
// Interfaces
function getAllInterfaces(
project: Project
): Record<string, InterfaceDeclaration> {
return Object.fromEntries(
project
.getSourceFiles()
.flatMap((file) => file.getInterfaces())
.map((iface) => [iface.getName(), iface] as const)
);
}
export function processProjectInterfaces(project: Project): RawApiDocsPage[] {
return processInterfaces(
valuesForKeys(getAllInterfaces(project), ['Randomizer'])
);
}
function processInterfaces(
interfaces: InterfaceDeclaration[]
): RawApiDocsPage[] {
return interfaces.map((iface) => {
try {
return processInterface(iface);
} catch (error) {
throw newProcessingError({
type: 'interface',
name: iface.getName(),
source: iface,
cause: error,
});
}
});
}
function processInterface(iface: InterfaceDeclaration): RawApiDocsPage {
return {
...preparePage(iface, iface.getName()),
methods: processInterfaceMethods(iface),
};
}
// Utilities
export function processProjectUtilities(project: Project): RawApiDocsPage {
console.log(`- Utilities`);
return {
title: 'Utilities',
camelTitle: 'utils',
category: undefined,
deprecated: undefined,
description: 'A list of all the utilities available in Faker.js.',
examples: [],
methods: processUtilityFunctions(project),
};
}
// Helpers
function preparePage(
module: JSDocableLikeNode,
title: string,
category: string | undefined = undefined
): RawApiDocsPage {
console.log(`- ${title}`);
const jsdocs = getJsDocs(module);
return {
title,
camelTitle: toCamelCase(title),
category,
deprecated: getDeprecated(jsdocs),
description: getDescription(jsdocs),
examples: getExamples(jsdocs),
methods: [],
};
}
function toCamelCase(value: string): string {
return value.substring(0, 1).toLowerCase() + value.substring(1);
}
|
