db/scripts/generate-docs.ts at skillz · devagrawal09/db · GitHub

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
import { resolve } from 'node:path'
import { fileURLToPath } from 'node:url'
import { generateReferenceDocs } from '@tanstack/typedoc-config'

const __dirname = fileURLToPath(new URL(`.`, import.meta.url))

await generateReferenceDocs({
  packages: [
    {
      name: `db`,
      entryPoints: [resolve(__dirname, `../packages/db/src/index.ts`)],
      tsconfig: resolve(__dirname, `../packages/db/tsconfig.docs.json`),
      outputDir: resolve(__dirname, `../docs/reference`),
    },
    {
      name: `electric-db-collection`,
      entryPoints: [
        resolve(__dirname, `../packages/electric-db-collection/src/index.ts`),
      ],
      tsconfig: resolve(
        __dirname,
        `../packages/electric-db-collection/tsconfig.docs.json`,
      ),
      outputDir: resolve(__dirname, `../docs/reference/electric-db-collection`),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `query-db-collection`,
      entryPoints: [
        resolve(__dirname, `../packages/query-db-collection/src/index.ts`),
      ],
      tsconfig: resolve(
        __dirname,
        `../packages/query-db-collection/tsconfig.docs.json`,
      ),
      outputDir: resolve(__dirname, `../docs/reference/query-db-collection`),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `powersync-db-collection`,
      entryPoints: [
        resolve(__dirname, `../packages/powersync-db-collection/src/index.ts`),
      ],
      tsconfig: resolve(
        __dirname,
        `../packages/powersync-db-collection/tsconfig.docs.json`,
      ),
      outputDir: resolve(
        __dirname,
        `../docs/reference/powersync-db-collection`,
      ),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `rxdb-db-collection`,
      entryPoints: [
        resolve(__dirname, `../packages/rxdb-db-collection/src/index.ts`),
      ],
      tsconfig: resolve(
        __dirname,
        `../packages/rxdb-db-collection/tsconfig.docs.json`,
      ),
      outputDir: resolve(__dirname, `../docs/reference/rxdb-db-collection`),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `react-db`,
      entryPoints: [resolve(__dirname, `../packages/react-db/src/index.ts`)],
      tsconfig: resolve(__dirname, `../packages/react-db/tsconfig.docs.json`),
      outputDir: resolve(__dirname, `../docs/framework/react/reference`),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `solid-db`,
      entryPoints: [resolve(__dirname, `../packages/solid-db/src/index.ts`)],
      tsconfig: resolve(__dirname, `../packages/solid-db/tsconfig.docs.json`),
      outputDir: resolve(__dirname, `../docs/framework/solid/reference`),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `svelte-db`,
      entryPoints: [resolve(__dirname, `../packages/svelte-db/src/index.ts`)],
      tsconfig: resolve(__dirname, `../packages/svelte-db/tsconfig.docs.json`),
      outputDir: resolve(__dirname, `../docs/framework/svelte/reference`),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `trailbase-db-collection`,
      entryPoints: [
        resolve(__dirname, `../packages/trailbase-db-collection/src/index.ts`),
      ],
      tsconfig: resolve(
        __dirname,
        `../packages/trailbase-db-collection/tsconfig.docs.json`,
      ),
      outputDir: resolve(
        __dirname,
        `../docs/reference/trailbase-db-collection`,
      ),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `vue-db`,
      entryPoints: [resolve(__dirname, `../packages/vue-db/src/index.ts`)],
      tsconfig: resolve(__dirname, `../packages/vue-db/tsconfig.docs.json`),
      outputDir: resolve(__dirname, `../docs/framework/vue/reference`),
      exclude: [`packages/db/**/*`],
    },
    {
      name: `angular-db`,
      entryPoints: [resolve(__dirname, `../packages/angular-db/src/index.ts`)],
      tsconfig: resolve(__dirname, `../packages/angular-db/tsconfig.docs.json`),
      outputDir: resolve(__dirname, `../docs/framework/angular/reference`),
      exclude: [`packages/db/**/*`],
    },
  ],
})

console.log(`\n✅ All markdown files have been processed!`)

process.exit(0)