Open History to see the last commit
1import { resolve } from 'node:path'
2import { readFile, writeFile } from 'node:fs/promises'
3import { fileURLToPath } from 'node:url'
4import { generateReferenceDocs } from '@tanstack/typedoc-config'
5β
6const __dirname = fileURLToPath(new URL('.', import.meta.url))
7const octaneReferenceDir = resolve(
8 __dirname,
9 '../docs/framework/octane/reference',
10)
11β
12async function replaceOverloadHeadings(
13 relativePath: string,
14 headings: Array<string>,
15) {
16 const path = resolve(octaneReferenceDir, relativePath)
17 let markdown = await readFile(path, 'utf8')
18β
19 for (const heading of headings) {
20 markdown = markdown.replace('## Call Signature', `## ${heading}`)
21 }
22β
23 await writeFile(path, markdown)
24}
25β
26async function polishOctaneReferenceDocs() {
27 await replaceOverloadHeadings('functions/useCreateAtom.md', [
28 'Readonly atom',
29 'Writable atom',
30 ])
31 await replaceOverloadHeadings('functions/useCreateStore.md', [
32 'Readonly store',
33 'Writable store',
34 'Store with actions',
35 ])
36β
37 const useAtomPath = resolve(octaneReferenceDir, 'functions/useAtom.md')
38 const useAtom = (await readFile(useAtomPath, 'utf8'))
39 .replace(
40 'function useAtom<TValue>(atom, options?): [TValue, (fn) => void & (value) => void];',
41 [
42 'function useAtom<TValue>(',
43 ' atom,',
44 ' options?,',
45 "): [TValue, Atom<TValue>['set']];",
46 ].join('\n'),
47 )
48 .replace(
49 '\\[`TValue`, (`fn`) => `void` & (`value`) => `void`\\]',
50 '\\[`TValue`, `Atom`\\<`TValue`\\>\\[`"set"`\\]\\]',
51 )
52 await writeFile(useAtomPath, useAtom)
53}
54β
55await generateReferenceDocs({
56 packages: [
57 {
58 name: 'store',
59 entryPoints: [resolve(__dirname, '../packages/store/src/index.ts')],
60 tsconfig: resolve(__dirname, '../packages/store/tsconfig.docs.json'),
61 outputDir: resolve(__dirname, '../docs/reference'),
62 },
63 {
64 name: 'angular-store',
65 entryPoints: [
66 resolve(__dirname, '../packages/angular-store/src/index.ts'),
67 ],
68 tsconfig: resolve(
69 __dirname,
70 '../packages/angular-store/tsconfig.docs.json',
71 ),
72 outputDir: resolve(__dirname, '../docs/framework/angular/reference'),
73 exclude: ['packages/store/**/*'],
74 },
75 {
76 name: 'react-store',
77 entryPoints: [resolve(__dirname, '../packages/react-store/src/index.ts')],
78 tsconfig: resolve(
79 __dirname,
80 '../packages/react-store/tsconfig.docs.json',
81 ),
82 outputDir: resolve(__dirname, '../docs/framework/react/reference'),
83 exclude: ['packages/store/**/*'],
84 },
85 {
86 name: 'preact-store',
87 entryPoints: [
88 resolve(__dirname, '../packages/preact-store/src/index.ts'),
89 ],
90 tsconfig: resolve(
91 __dirname,
92 '../packages/preact-store/tsconfig.docs.json',
93 ),
94 outputDir: resolve(__dirname, '../docs/framework/preact/reference'),
95 exclude: ['packages/store/**/*'],
96 },
97 {
98 name: 'solid-store',
99 entryPoints: [
100 resolve(__dirname, '../packages/solid-store/src/index.tsx'),
101 ],
102 tsconfig: resolve(
103 __dirname,
104 '../packages/solid-store/tsconfig.docs.json',
105 ),
106 outputDir: resolve(__dirname, '../docs/framework/solid/reference'),
107 exclude: ['packages/store/**/*'],
108 },
109 {
110 name: 'svelte-store',
111 entryPoints: [
112 resolve(__dirname, '../packages/svelte-store/src/index.ts'),
113 ],
114 tsconfig: resolve(
115 __dirname,
116 '../packages/svelte-store/tsconfig.docs.json',
117 ),
118 outputDir: resolve(__dirname, '../docs/framework/svelte/reference'),
119 exclude: ['packages/store/**/*'],
120 },
121 {
122 name: 'vue-store',
123 entryPoints: [resolve(__dirname, '../packages/vue-store/src/index.ts')],
124 tsconfig: resolve(__dirname, '../packages/vue-store/tsconfig.docs.json'),
125 outputDir: resolve(__dirname, '../docs/framework/vue/reference'),
126 exclude: ['packages/store/**/*'],
127 },
128 {
129 name: 'lit-store',
130 entryPoints: [resolve(__dirname, '../packages/lit-store/src/index.ts')],
131 tsconfig: resolve(__dirname, '../packages/lit-store/tsconfig.docs.json'),
132 outputDir: resolve(__dirname, '../docs/framework/lit/reference'),
133 exclude: ['packages/store/**/*'],
134 },
135 {
136 name: 'octane-store',
137 entryPoints: [
138 resolve(__dirname, '../packages/octane-store/src/index.ts'),
139 ],
140 tsconfig: resolve(
141 __dirname,
142 '../packages/octane-store/tsconfig.docs.json',
143 ),
144 outputDir: resolve(__dirname, '../docs/framework/octane/reference'),
145 exclude: ['packages/store/**/*'],
146 },
147 ],
148})
149β
150await polishOctaneReferenceDocs()
151β
152console.log('\nβ
All markdown files have been processed!')
153β
154process.exit(0)