-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtypedoc.config.ts
223 lines (216 loc) · 10.5 KB
/
typedoc.config.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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
import type { StarlightPlugin } from '@astrojs/starlight/types';
import { createStarlightTypeDocPlugin } from 'starlight-typedoc';
import type { StarlightTypeDocOptions } from 'starlight-typedoc';
// Utility function to create TypeDoc related paths
export function getFilePathToPackage(name: string, path: string) {
return `./studiocms/packages/${name}/${path}`;
}
// Utility function to create TypeDoc options for the StudioCMS packages so that each package documentation is the same when generated
export function makeTypedocOpts(o: {
name: string;
dir: string;
output: string;
entryPoints: StarlightTypeDocOptions['entryPoints'];
}): StarlightTypeDocOptions {
return {
tsconfig: getFilePathToPackage(o.dir, 'tsconfig.json'),
entryPoints: o.entryPoints,
output: `en/typedoc/${o.output}`,
typeDoc: {
plugin: [
'typedoc-plugin-zod',
'typedoc-plugin-frontmatter',
'./src/plugins/frontmatter.js',
'./src/plugins/readmes.js',
],
skipErrorChecking: true,
gitRemote: 'https://github.com/withstudiocms/studiocms/blob',
gitRevision: 'main',
sourceLinkTemplate:
'https://github.com/withstudiocms/studiocms/blob/{gitRevision}/{path}#L{line}',
includeVersion: true,
expandObjects: true,
expandParameters: true,
useCodeBlocks: true,
useHTMLAnchors: true,
sourceLinkExternal: true,
outputFileStrategy: 'modules',
pretty: true,
},
};
}
// Create Starlight TypeDoc Plugins for different parts of the Astro StudioCMS Project
// studiocms
const tdStudioCMS = createStarlightTypeDocPlugin()[0];
// @studiocms/devapps
const tdDevApps = createStarlightTypeDocPlugin()[0];
// @studiocms/blog
const tdBlog = createStarlightTypeDocPlugin()[0];
// @studiocms/markdoc
const tdMarkDoc = createStarlightTypeDocPlugin()[0];
// @studiocms/mdx
const tdMDX = createStarlightTypeDocPlugin()[0];
// Set to true to enable testing mode for TypeDoc
const testTypeDoc = false;
const isProd = process.env.NODE_ENV === 'production';
const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[] => {
if (isProd || testingMode) {
return [
tdStudioCMS(
makeTypedocOpts({
name: 'studiocms',
output: 'studiocms',
dir: 'studiocms',
entryPoints: [
getFilePathToPackage('studiocms', 'src/index.ts'),
getFilePathToPackage('studiocms', 'src/config.ts'),
getFilePathToPackage('studiocms', 'src/consts.ts'),
getFilePathToPackage('studiocms', 'src/errors.ts'),
getFilePathToPackage('studiocms', 'src/plugins.ts'),
getFilePathToPackage('studiocms', 'src/types.ts'),
getFilePathToPackage('studiocms', 'src/db/config.ts'),
getFilePathToPackage('studiocms', 'src/db/tables.ts'),
getFilePathToPackage('studiocms', 'src/sdk/index.ts'),
getFilePathToPackage('studiocms', 'src/sdk/cache.ts'),
getFilePathToPackage('studiocms', 'src/sdk/core.ts'),
getFilePathToPackage('studiocms', 'src/sdk/StudioCMSVirtualCache.ts'),
getFilePathToPackage('studiocms', 'src/sdk/errors.ts'),
getFilePathToPackage('studiocms', 'src/sdk/tables.ts'),
getFilePathToPackage('studiocms', 'src/sdk/types/index.ts'),
getFilePathToPackage('studiocms', 'src/sdk/types/tableDefs.ts'),
getFilePathToPackage('studiocms', 'src/sdk/types/tsAlias.ts'),
getFilePathToPackage('studiocms', 'src/sdk/lib/foldertree.ts'),
getFilePathToPackage('studiocms', 'src/sdk/lib/generators.ts'),
getFilePathToPackage('studiocms', 'src/sdk/lib/packages.ts'),
getFilePathToPackage('studiocms', 'src/sdk/lib/parsers.ts'),
getFilePathToPackage('studiocms', 'src/sdk/lib/users.ts'),
getFilePathToPackage('studiocms', 'src/schemas/index.ts'),
getFilePathToPackage('studiocms', 'src/schemas/plugins/index.ts'),
getFilePathToPackage('studiocms', 'src/schemas/plugins/shared.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/index.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/auth.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/componentoverrides.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/dashboard.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/defaultFrontend.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/developer.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/imageService.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/integrations.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/pageTypeOptions.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/sdk.ts'),
getFilePathToPackage('studiocms', 'src/schemas/config/studiocms-markdown-remark.ts'),
getFilePathToPackage('studiocms', 'src/lib/auth/encryption.ts'),
getFilePathToPackage('studiocms', 'src/lib/auth/password.ts'),
getFilePathToPackage('studiocms', 'src/lib/auth/rate-limit.ts'),
getFilePathToPackage('studiocms', 'src/lib/auth/session.ts'),
getFilePathToPackage('studiocms', 'src/lib/auth/types.ts'),
getFilePathToPackage('studiocms', 'src/lib/auth/user.ts'),
getFilePathToPackage('studiocms', 'src/lib/auth/verify-email.ts'),
getFilePathToPackage('studiocms', 'src/lib/dynamic-sitemap/index.ts'),
getFilePathToPackage('studiocms', 'src/lib/dynamic-sitemap/sitemap-index.xml.ts'),
getFilePathToPackage('studiocms', 'src/lib/i18n/index.ts'),
getFilePathToPackage('studiocms', 'src/lib/robots/index.ts'),
getFilePathToPackage('studiocms', 'src/lib/robots/core.ts'),
getFilePathToPackage('studiocms', 'src/lib/robots/types.ts'),
getFilePathToPackage('studiocms', 'src/lib/robots/utils.ts'),
getFilePathToPackage('studiocms', 'src/lib/webVitals/checkForWebVitalsPlugin.ts'),
getFilePathToPackage('studiocms', 'src/lib/webVitals/consts.ts'),
getFilePathToPackage('studiocms', 'src/lib/webVitals/schemas.ts'),
getFilePathToPackage('studiocms', 'src/lib/webVitals/types.ts'),
getFilePathToPackage('studiocms', 'src/lib/webVitals/webVital.ts'),
getFilePathToPackage('studiocms', 'src/lib/webVitals/webVitalsRouteSummary.ts'),
getFilePathToPackage('studiocms', 'src/lib/webVitals/webVitalsSummary.ts'),
getFilePathToPackage('studiocms', 'src/lib/dashboardGrid.ts'),
getFilePathToPackage('studiocms', 'src/lib/head.ts'),
getFilePathToPackage('studiocms', 'src/lib/headDefaults.ts'),
getFilePathToPackage('studiocms', 'src/lib/makeAPIRoute.ts'),
getFilePathToPackage('studiocms', 'src/lib/makePublicRoute.ts'),
getFilePathToPackage('studiocms', 'src/lib/pathGenerators.ts'),
getFilePathToPackage('studiocms', 'src/lib/removeLeadingTrailingSlashes.ts'),
getFilePathToPackage('studiocms', 'src/lib/routeMap.ts'),
getFilePathToPackage('studiocms', 'src/lib/urlGen.ts'),
getFilePathToPackage('studiocms', 'src/lib/mailer/index.ts'),
getFilePathToPackage('studiocms', 'src/lib/mailer/template.ts'),
getFilePathToPackage('studiocms', 'src/lib/notifier/index.ts'),
getFilePathToPackage('studiocms', 'src/lib/notifier/client.ts'),
getFilePathToPackage('studiocms', 'src/lib/renderer/errors.ts'),
getFilePathToPackage('studiocms', 'src/lib/renderer/runtime.ts'),
getFilePathToPackage('studiocms', 'src/lib/renderer/shared.ts'),
getFilePathToPackage('studiocms', 'src/lib/renderer/types.ts'),
getFilePathToPackage('studiocms', 'src/runtime/AstroComponentProxy.ts'),
getFilePathToPackage('studiocms', 'src/runtime/decoder/index.ts'),
getFilePathToPackage('studiocms', 'src/runtime/decoder/decode-codepoint.ts'),
getFilePathToPackage('studiocms', 'src/runtime/decoder/decode-data-html.ts'),
getFilePathToPackage('studiocms', 'src/runtime/decoder/decode-data-xml.ts'),
getFilePathToPackage('studiocms', 'src/runtime/decoder/utils.ts'),
getFilePathToPackage('studiocms', 'src/scripts/formListener.ts'),
getFilePathToPackage('studiocms', 'src/scripts/three.ts'),
getFilePathToPackage('studiocms', 'src/scripts/utils/fitModelToViewport.ts'),
],
})
),
tdDevApps(
makeTypedocOpts({
name: '@studiocms/devapps',
output: 'studiocms-devapps',
dir: 'studiocms_devapps',
entryPoints: [
getFilePathToPackage('studiocms_devapps', 'src/index.ts'),
getFilePathToPackage('studiocms_devapps', 'src/apps/libsql-viewer.ts'),
getFilePathToPackage('studiocms_devapps', 'src/apps/wp-importer.ts'),
getFilePathToPackage('studiocms_devapps', 'src/routes/wp-importer.ts'),
getFilePathToPackage('studiocms_devapps', 'src/schema/index.ts'),
getFilePathToPackage('studiocms_devapps', 'src/schema/wp-api.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/converters.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/index.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/pages.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/posts.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/settings.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/utils.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/app-utils.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/pathGenerator.ts'),
],
})
),
tdBlog(
makeTypedocOpts({
name: '@studiocms/blog',
output: 'studiocms-blog',
dir: 'studiocms_blog',
entryPoints: [
getFilePathToPackage('studiocms_blog', 'src/index.ts'),
getFilePathToPackage('studiocms_blog', 'src/types.ts'),
],
})
),
tdMarkDoc(
makeTypedocOpts({
name: '@studiocms/markdoc',
output: 'studiocms-markdoc',
dir: 'studiocms_markdoc',
entryPoints: [
getFilePathToPackage('studiocms_markdoc', 'src/index.ts'),
getFilePathToPackage('studiocms_markdoc', 'src/types.ts'),
getFilePathToPackage('studiocms_markdoc', 'src/lib/render.ts'),
getFilePathToPackage('studiocms_markdoc', 'src/lib/shared.ts'),
getFilePathToPackage('studiocms_markdoc', 'src/react-renderer/renderReact.ts'),
],
})
),
tdMDX(
makeTypedocOpts({
name: '@studiocms/mdx',
output: 'studiocms-mdx',
dir: 'studiocms_mdx',
entryPoints: [
getFilePathToPackage('studiocms_mdx', 'src/index.ts'),
getFilePathToPackage('studiocms_mdx', 'src/types.ts'),
getFilePathToPackage('studiocms_mdx', 'src/lib/render.ts'),
getFilePathToPackage('studiocms_mdx', 'src/lib/shared.ts'),
],
})
),
];
}
return [] as StarlightPlugin[];
};
export const typeDocPlugins = TypeDocPlugins(isProd, testTypeDoc);