Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

generateDocs.ts

137 lines4.6 KB

1import { readFileSync, writeFileSync } from "node:fs"
2import { resolve } from "node:path"
3import { fileURLToPath } from "node:url"
4import { generateReferenceDocs } from "@tanstack/config/typedoc"
5import { glob } from "tinyglobby"
6​
7const __dirname = fileURLToPath(new URL(`.`, import.meta.url))
8​
9await generateReferenceDocs({
10 packages: [
11 {
12 name: `db`,
13 entryPoints: [resolve(__dirname, `../packages/db/src/index.ts`)],
14 tsconfig: resolve(__dirname, `../packages/db/tsconfig.docs.json`),
15 outputDir: resolve(__dirname, `../docs/reference`),
16 },
17 {
18 name: `electric-db-collection`,
19 entryPoints: [
20 resolve(__dirname, `../packages/electric-db-collection/src/index.ts`),
21 ],
22 tsconfig: resolve(
23 __dirname,
24 `../packages/electric-db-collection/tsconfig.docs.json`
25 ),
26 outputDir: resolve(__dirname, `../docs/reference/electric-db-collection`),
27 exclude: [`packages/db/**/*`],
28 },
29 {
30 name: `query-db-collection`,
31 entryPoints: [
32 resolve(__dirname, `../packages/query-db-collection/src/index.ts`),
33 ],
34 tsconfig: resolve(
35 __dirname,
36 `../packages/query-db-collection/tsconfig.docs.json`
37 ),
38 outputDir: resolve(__dirname, `../docs/reference/query-db-collection`),
39 exclude: [`packages/db/**/*`],
40 },
41 {
42 name: `powersync-db-collection`,
43 entryPoints: [
44 resolve(__dirname, `../packages/powersync-db-collection/src/index.ts`),
45 ],
46 tsconfig: resolve(
47 __dirname,
48 `../packages/powersync-db-collection/tsconfig.docs.json`
49 ),
50 outputDir: resolve(
51 __dirname,
52 `../docs/reference/powersync-db-collection`
53 ),
54 exclude: [`packages/db/**/*`],
55 },
56 {
57 name: `react-db`,
58 entryPoints: [resolve(__dirname, `../packages/react-db/src/index.ts`)],
59 tsconfig: resolve(__dirname, `../packages/react-db/tsconfig.docs.json`),
60 outputDir: resolve(__dirname, `../docs/framework/react/reference`),
61 exclude: [`packages/db/**/*`],
62 },
63 {
64 name: `solid-db`,
65 entryPoints: [resolve(__dirname, `../packages/solid-db/src/index.ts`)],
66 tsconfig: resolve(__dirname, `../packages/solid-db/tsconfig.docs.json`),
67 outputDir: resolve(__dirname, `../docs/framework/solid/reference`),
68 exclude: [`packages/db/**/*`],
69 },
70 {
71 name: `svelte-db`,
72 entryPoints: [resolve(__dirname, `../packages/svelte-db/src/index.ts`)],
73 tsconfig: resolve(__dirname, `../packages/svelte-db/tsconfig.docs.json`),
74 outputDir: resolve(__dirname, `../docs/framework/svelte/reference`),
75 exclude: [`packages/db/**/*`],
76 },
77 {
78 name: `trailbase-db-collection`,
79 entryPoints: [
80 resolve(__dirname, `../packages/trailbase-db-collection/src/index.ts`),
81 ],
82 tsconfig: resolve(
83 __dirname,
84 `../packages/trailbase-db-collection/tsconfig.docs.json`
85 ),
86 outputDir: resolve(
87 __dirname,
88 `../docs/reference/trailbase-db-collection`
89 ),
90 exclude: [`packages/db/**/*`],
91 },
92 {
93 name: `vue-db`,
94 entryPoints: [resolve(__dirname, `../packages/vue-db/src/index.ts`)],
95 tsconfig: resolve(__dirname, `../packages/vue-db/tsconfig.docs.json`),
96 outputDir: resolve(__dirname, `../docs/framework/vue/reference`),
97 exclude: [`packages/db/**/*`],
98 },
99 {
100 name: `angular-db`,
101 entryPoints: [resolve(__dirname, `../packages/angular-db/src/index.ts`)],
102 tsconfig: resolve(__dirname, `../packages/angular-db/tsconfig.docs.json`),
103 outputDir: resolve(__dirname, `../docs/framework/angular/reference`),
104 exclude: [`packages/db/**/*`],
105 },
106 ],
107})
108​
109// Find all markdown files matching the pattern
110const markdownFiles = [
111 ...(await glob(`docs/reference/**/*.md`)),
112 ...(await glob(`docs/framework/*/reference/**/*.md`)),
114​
115console.log(`Found ${markdownFiles.length} markdown files to process\n`)
116​
117// Process each markdown file
118markdownFiles.forEach((file) => {
119 const content = readFileSync(file, `utf-8`)
120 let updatedContent = content
121 updatedContent = updatedContent.replaceAll(/\]\(\.\.\//gm, `](../../`)
122 // updatedContent = content.replaceAll(/\]\(\.\//gm, '](../')
123 updatedContent = updatedContent.replaceAll(
124 /\]\((?!https?:\/\/|\/\/|\/|\.\/|\.\.\/|#)([^)]+)\)/gm,
125 (match, p1) => `](../${p1})`
126 )
127​
128 // Write the updated content back to the file
129 if (updatedContent !== content) {
130 writeFileSync(file, updatedContent, `utf-8`)
131 console.log(`Processed file: ${file}`)
132 }
133})
134​
135console.log(`\n✅ All markdown files have been processed!`)
136​
137process.exit(0)