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

vite.ts

79 lines2.1 KB

1import { createVitePlugin } from 'unplugin'
2​
3import { configSchema, getConfig } from './core/config'
4import { createRouterCodeSplitterPlugin } from './core/router-code-splitter-plugin'
5import { createRouterGeneratorPlugin } from './core/router-generator-plugin'
6import { unpluginRouterComposedFactory } from './core/router-composed-plugin'
7import { createRouterPluginContext } from './core/router-plugin-context'
8import type { CodeSplittingOptions, Config } from './core/config'
9import type { RouterPluginContext } from './core/router-plugin-context'
10​
11type RouterPluginOptions = Partial<Config | (() => Config)> | undefined
12​
13const defaultRouterPluginContext = createRouterPluginContext()
14​
15/**
16 * @example
17 * ```ts
18 * export default defineConfig({
19 * plugins: [tanstackRouterGenerator()],
20 * // ...
21 * })
22 * ```
23 */
24const tanstackRouterGenerator = (
25 options?: RouterPluginOptions,
26 routerPluginContext?: RouterPluginContext,
27) => {
28 const pluginContext = routerPluginContext ?? defaultRouterPluginContext
29 return createVitePlugin((pluginOptions: RouterPluginOptions) =>
30 createRouterGeneratorPlugin(pluginOptions, pluginContext),
31 )(options)
33​
34/**
35 * @example
36 * ```ts
37 * export default defineConfig({
38 * plugins: [tanStackRouterCodeSplitter()],
39 * // ...
40 * })
41 * ```
42 */
43const tanStackRouterCodeSplitter = (
44 options?: RouterPluginOptions,
45 routerPluginContext?: RouterPluginContext,
46) => {
47 const pluginContext = routerPluginContext ?? defaultRouterPluginContext
48 return createVitePlugin((pluginOptions: RouterPluginOptions) =>
49 createRouterCodeSplitterPlugin(pluginOptions, pluginContext),
50 )(options)
52​
53/**
54 * @example
55 * ```ts
56 * export default defineConfig({
57 * plugins: [tanstackRouter()],
58 * // ...
59 * })
60 * ```
61 */
62const tanstackRouter = createVitePlugin(unpluginRouterComposedFactory)
63​
64/**
65 * @deprecated Use `tanstackRouter` instead.
66 */
67const TanStackRouterVite = tanstackRouter
68​
69export default tanstackRouter
70export {
71 configSchema,
72 getConfig,
73 tanStackRouterCodeSplitter,
74 tanstackRouterGenerator,
75 TanStackRouterVite,
76 tanstackRouter,
78​
79export type { Config, CodeSplittingOptions, RouterPluginContext }