blob: 89c42a33a56121c3736c69dc343e07c1f80db5a9 (
plain)
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
|
import * as TypeDoc from 'typedoc';
import type { Method } from '../../docs/.vitepress/components/api-docs/method';
import faker from '../../src';
import { writeApiDocsData, writeApiDocsModulePage } from './apiDocsWriter';
import { analyzeSignature, toBlock } from './signature';
import type { PageIndex } from './utils';
/**
* Analyzes and writes the documentation for modules and their methods such as `faker.animal.cat()`.
*
* @param project The project used to extract the modules.
* @returns The generated pages.
*/
export function processModuleMethods(
project: TypeDoc.ProjectReflection
): PageIndex {
const modules = project
.getChildrenByKind(TypeDoc.ReflectionKind.Namespace)[0]
.getChildrenByKind(TypeDoc.ReflectionKind.Class);
const pages: PageIndex = [];
// Generate module file
for (const module of modules) {
pages.push(...processModuleMethod(module));
}
return pages;
}
/**
* Analyzes and writes the documentation for a module and its methods such as `faker.animal.cat()`.
*
* @param direct The module to process.
* @returns The generated pages.
*/
function processModuleMethod(module: TypeDoc.DeclarationReflection): PageIndex {
const moduleName = module.name.replace('_', '');
const lowerModuleName =
moduleName.substring(0, 1).toLowerCase() + moduleName.substring(1);
if (faker[lowerModuleName] === undefined) {
return [];
}
console.log(`Processing Module ${moduleName}`);
const methods: Method[] = [];
// Generate method section
for (const method of module.getChildrenByKind(
TypeDoc.ReflectionKind.Method
)) {
const methodName = method.name;
console.debug(`- ${methodName}`);
const signature = method.signatures[0];
methods.push(analyzeSignature(signature, lowerModuleName, methodName));
}
writeApiDocsModulePage(moduleName, lowerModuleName, toBlock(module.comment));
writeApiDocsData(lowerModuleName, methods);
return [
{
text: moduleName,
link: `/api/${lowerModuleName}.html`,
},
];
}
|
