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
|
import type { DeclarationReflection, ProjectReflection } from 'typedoc';
import type { Method } from '../../docs/.vitepress/components/api-docs/method';
import { writeApiDocsData, writeApiDocsModulePage } from './apiDocsWriter';
import { analyzeSignature, stripAbsoluteFakerUrls, toBlock } from './signature';
import {
extractDeprecated,
extractModuleFieldName,
extractModuleName,
selectApiMethodSignatures,
selectApiModules,
} from './typedoc';
import type { PageAndDiffIndex } from './utils';
import { diffHash, methodDiffHash } 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: ProjectReflection
): PageAndDiffIndex {
const pages: PageAndDiffIndex = [];
// Generate module files
for (const module of selectApiModules(project)) {
pages.push(...processModuleMethod(module));
}
return pages;
}
/**
* Analyzes and writes the documentation for a module and its methods such as `faker.animal.cat()`.
*
* @param module The module to process.
* @returns The generated pages.
*/
function processModuleMethod(module: DeclarationReflection): PageAndDiffIndex {
const moduleName = extractModuleName(module);
const moduleFieldName = extractModuleFieldName(module);
console.log(`Processing Module ${moduleName}`);
const comment = stripAbsoluteFakerUrls(toBlock(module.comment));
const deprecated = extractDeprecated(module);
const methods: Method[] = [];
// Generate method section
for (const [methodName, signature] of Object.entries(
selectApiMethodSignatures(module)
)) {
console.debug(`- ${methodName}`);
methods.push(analyzeSignature(signature, moduleFieldName, methodName));
}
writeApiDocsModulePage(
moduleName,
moduleFieldName,
comment,
deprecated,
methods
);
writeApiDocsData(moduleFieldName, methods);
return [
{
text: moduleName,
link: `/api/${moduleFieldName}.html`,
diff: methods.reduce(
(data, method) => ({
...data,
[method.name]: methodDiffHash(method),
}),
{
moduleHash: diffHash({
name: moduleName,
field: moduleFieldName,
comment,
}),
}
),
},
];
}
|
