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
|
import { resolve } from 'node:path';
import type { Options } from 'prettier';
import { format } from 'prettier';
import * as TypeDoc from 'typedoc';
import prettierConfig from '../../.prettierrc.cjs';
import {
DefaultParameterAwareSerializer,
parameterDefaultReader,
patchProjectParameterDefaults,
} from './parameterDefaults';
export type Page = { text: string; link: string };
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);
}
/**
* Formats markdown contents.
*
* @param text The text to format.
*/
export function formatMarkdown(text: string): string {
return format(text, prettierMarkdown);
}
/**
* Formats typedoc contents.
*
* @param text The text to format.
*/
export function formatTypescript(text: string): string {
return format(text, prettierTypescript);
}
const prettierMarkdown: Options = {
...prettierConfig,
parser: 'markdown',
};
const prettierTypescript: Options = {
...prettierConfig,
parser: 'typescript',
};
|
