diff options
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/apidoc.ts | 29 | ||||
| -rw-r--r-- | scripts/apidoc/utils.ts | 38 |
2 files changed, 41 insertions, 26 deletions
diff --git a/scripts/apidoc.ts b/scripts/apidoc.ts index 4ac4fbf9..d519a320 100644 --- a/scripts/apidoc.ts +++ b/scripts/apidoc.ts @@ -1,32 +1,14 @@ import { resolve } from 'path'; -import * as TypeDoc from 'typedoc'; import { writeApiPagesIndex } from './apidoc/apiDocsWriter'; import { processDirectMethods } from './apidoc/directMethods'; import { processModuleMethods } from './apidoc/moduleMethods'; -import { - DefaultParameterAwareSerializer, - parameterDefaultReader, - patchProjectParameterDefaults, -} from './apidoc/parameterDefaults'; import type { PageIndex } from './apidoc/utils'; -import { pathOutputDir } from './apidoc/utils'; +import { newTypeDocApp, patchProject, pathOutputDir } from './apidoc/utils'; const pathOutputJson = resolve(pathOutputDir, 'typedoc.json'); async function build(): Promise<void> { - const app = new TypeDoc.Application(); - - app.options.addReader(new TypeDoc.TSConfigReader()); - // If you want TypeDoc to load typedoc.json files - //app.options.addReader(new TypeDoc.TypeDocReader()); - - // Read parameter defaults - app.converter.on( - TypeDoc.Converter.EVENT_CREATE_DECLARATION, - parameterDefaultReader - ); - // Add to debug json output - app.serializer.addSerializer(new DefaultParameterAwareSerializer(undefined)); + const app = newTypeDocApp(); app.bootstrap({ entryPoints: ['src/index.ts'], @@ -36,15 +18,10 @@ async function build(): Promise<void> { const project = app.convert(); - if (!project) { - // Project may not have converted correctly - return; - } // Useful for manually analyzing the content await app.generateJson(project, pathOutputJson); - console.log(pathOutputDir); - patchProjectParameterDefaults(project); + patchProject(project); const modulesPages: PageIndex = []; modulesPages.push({ text: 'Localization', link: '/api/localization.html' }); diff --git a/scripts/apidoc/utils.ts b/scripts/apidoc/utils.ts index ee38d58d..68b69746 100644 --- a/scripts/apidoc/utils.ts +++ b/scripts/apidoc/utils.ts @@ -1,4 +1,10 @@ import { resolve } from 'node:path'; +import * as TypeDoc from 'typedoc'; +import { + DefaultParameterAwareSerializer, + parameterDefaultReader, + patchProjectParameterDefaults, +} from './parameterDefaults'; export type Page = { text: string; link: string }; export type PageIndex = Array<Page>; @@ -6,3 +12,35 @@ export type PageIndex = Array<Page>; const pathRoot = resolve(__dirname, '..', '..'); export const pathDocsDir = resolve(pathRoot, 'docs'); export const pathOutputDir = resolve(pathDocsDir, 'api'); + +/** + * Creates and configures a new typedoc application. + */ +export function newTypeDocApp(): TypeDoc.Application { + const app = new TypeDoc.Application(); + + app.options.addReader(new TypeDoc.TSConfigReader()); + // If you want TypeDoc to load typedoc.json files + //app.options.addReader(new TypeDoc.TypeDocReader()); + + // Read parameter defaults + app.converter.on( + TypeDoc.Converter.EVENT_CREATE_DECLARATION, + parameterDefaultReader + ); + // Add to debug json output + app.serializer.addSerializer(new DefaultParameterAwareSerializer(undefined)); + + return app; +} + +/** + * Apply our patches to the generated typedoc data. + * + * This is moved to a separate method to allow printing/saving the original content before patching it. + * + * @param project The project to patch. + */ +export function patchProject(project: TypeDoc.ProjectReflection): void { + patchProjectParameterDefaults(project); +} |
