-
-
Notifications
You must be signed in to change notification settings - Fork 880
/
apiDocsWriter.ts
201 lines (168 loc) · 5.29 KB
/
apiDocsWriter.ts
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
import { writeFileSync } from 'node:fs';
import { resolve } from 'node:path';
import type { ProjectReflection } from 'typedoc';
import { ReflectionKind } from 'typedoc';
import type { Method } from '../../docs/.vitepress/components/api-docs/method';
import type { APIGroup, APIItem } from '../../docs/api/api-types';
import { selectDirectMethods } from './directMethods';
import { extractModuleName, selectApiModules, slugify } from './moduleMethods';
import type { PageIndex } from './utils';
import {
formatMarkdown,
formatTypescript,
pathDocsDir,
pathOutputDir,
} from './utils';
const pathDocsApiPages = resolve(pathDocsDir, '.vitepress', 'api-pages.ts');
const pathDocsApiSearchIndex = resolve(
pathDocsDir,
'api',
'api-search-index.json'
);
const scriptCommand = 'pnpm run generate:api-docs';
// Moved here because this must not be formatted by prettier
const vitePressInFileOptions = `---
editLink: false
---
`;
/**
* Writes the api page for the given module to the correct location.
*
* @param moduleName The name of the module to write the docs for.
* @param lowerModuleName The lowercase name of the module.
* @param comment The module comments.
* @param methods The methods of the module.
*/
export function writeApiDocsModulePage(
moduleName: string,
lowerModuleName: string,
comment: string,
methods: Method[]
): void {
// Write api docs page
let content = `
<script setup>
import ApiDocsMethod from '../.vitepress/components/api-docs/method.vue';
import ${lowerModuleName} from './${lowerModuleName}.json';
</script>
<!-- This file is automatically generated. -->
<!-- Run '${scriptCommand}' to update -->
# ${moduleName}
::: v-pre
${comment}
:::
${methods
.map(
(method) => `
## ${method.name}
<ApiDocsMethod :method="${lowerModuleName}.${method.name}" v-once />
`
)
.join('')}
`.replace(/\n +/g, '\n');
content = vitePressInFileOptions + formatMarkdown(content);
writeFileSync(resolve(pathOutputDir, `${lowerModuleName}.md`), content);
}
/**
* Writes the api page for the given method to the correct location.
*
* @param methodName The name of the method to write the docs for.
* @param capitalizedMethodName The capitalized name of the method.
*/
export function writeApiDocsDirectPage(
methodName: string,
capitalizedMethodName: string
): void {
let content = `
<script setup>
import ApiDocsMethod from '../.vitepress/components/api-docs/method.vue';
import ${methodName} from './${methodName}.json';
</script>
<!-- This file is automatically generated. -->
<!-- Run '${scriptCommand}' to update -->
# ${capitalizedMethodName}
## ${methodName}
<ApiDocsMethod :method="${methodName}.${methodName}" v-once />
`.replace(/\n +/g, '\n');
content = vitePressInFileOptions + formatMarkdown(content);
writeFileSync(resolve(pathOutputDir, `${methodName}.md`), content);
}
/**
* Writes the api docs data to correct location.
*
* @param lowerModuleName The lowercase name of the module.
* @param methods The methods data to save.
*/
export function writeApiDocsData(
lowerModuleName: string,
methods: Method[]
): void {
const content = JSON.stringify(
methods.reduce<Record<string, Method>>(
(map, method) => ({
...map,
[method.name]: method,
}),
{}
)
);
writeFileSync(resolve(pathOutputDir, `${lowerModuleName}.json`), content);
}
/**
* Writes the api docs index to correct location.
*
* @param pages The pages to write into the index.
*/
export function writeApiPagesIndex(pages: PageIndex): void {
// Write api-pages.ts
console.log('Updating api-pages.ts');
pages.sort((a, b) => a.text.localeCompare(b.text));
let apiPagesContent = `
// This file is automatically generated.
// Run '${scriptCommand}' to update
export const apiPages = ${JSON.stringify(pages)};
`.replace(/\n +/, '\n');
apiPagesContent = formatTypescript(apiPagesContent);
writeFileSync(pathDocsApiPages, apiPagesContent);
}
export function writeApiSearchIndex(project: ProjectReflection): void {
const apiIndex: APIGroup[] = [];
const moduleApiSection: APIGroup = {
text: 'Module API',
items: [],
};
apiIndex.push(moduleApiSection);
const apiModules = selectApiModules(project);
const directMethods = selectDirectMethods(project);
moduleApiSection.items = [...apiModules, ...directMethods]
.map((module) => {
const moduleName = extractModuleName(module);
const apiSection: APIItem = {
text: moduleName,
link: moduleName.toLowerCase(),
headers: [],
};
if (module.kind !== ReflectionKind.Property) {
apiSection.headers = module
.getChildrenByKind(ReflectionKind.Method)
.map((child) => ({
anchor: slugify(child.name),
text: child.name,
}));
} else {
// TODO @Shinigami92 2022-08-17: Extract capitalization into own function
apiSection.text =
apiSection.text.substring(0, 1).toUpperCase() +
apiSection.text.substring(1);
apiSection.headers = [
{
anchor: slugify(module.name),
text: module.name,
},
];
}
return apiSection;
})
.sort((a, b) => a.text.localeCompare(b.text));
writeFileSync(pathDocsApiSearchIndex, JSON.stringify(apiIndex));
}