Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(start): expose all customizable vite options #2544

Merged
merged 1 commit into from
Oct 14, 2024
Merged

feat(start): expose all customizable vite options #2544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/framework/react/start/path-aliases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import viteTsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
// this is the plugin that enables path aliases
viteTsConfigPaths({
projects: ['./tsconfig.json'],
Expand Down
2 changes: 1 addition & 1 deletion e2e/start/basic-auth/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion e2e/start/basic-react-query/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion e2e/start/basic-rsc/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion e2e/start/basic/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion e2e/start/clerk-basic/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-basic-auth/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-basic-react-query/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-basic-rsc/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-basic/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-clerk-basic/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-convex-trellaux/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-trellaux/app.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
vite: {
plugins: () => [
plugins: [
tsConfigPaths({
projects: ['./tsconfig.json'],
}),
Expand Down
59 changes: 35 additions & 24 deletions packages/start/src/config/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@ import type { Manifest } from '@tanstack/react-router'
import type * as vite from 'vite'
import type { NitroOptions } from 'nitropack'

import type { CustomizableConfig } from 'vinxi/dist/types/lib/vite-dev'

type RouterType = 'client' | 'server' | 'ssr' | 'api'

type StartUserViteConfig = CustomizableConfig | (() => CustomizableConfig)

function getUserConfig(config?: StartUserViteConfig) {
const { plugins, ...userConfig } =
typeof config === 'function' ? config() : { ...config }
return { plugins, userConfig }
}
/**
* Not all the deployment presets are fully functional or tested.
* @see https://github.com/TanStack/router/pull/2002
Expand Down Expand Up @@ -153,13 +164,7 @@ const serverSchema = z
})
.and(z.custom<ServerOptions>())

const viteSchema = z.object({
optimizeDeps: z.custom<vite.UserConfig['optimizeDeps']>().optional(),
plugins: z
.function()
.returns(z.array(z.custom<vite.PluginOption>()))
.optional(),
})
const viteSchema = z.custom<StartUserViteConfig>()

const babelSchema = z.object({
plugins: z
Expand Down Expand Up @@ -285,8 +290,8 @@ export function defineConfig(
sourcemap: true,
},
plugins: () => [
...(opts.vite?.plugins?.() || []),
...(opts.routers?.client?.vite?.plugins?.() || []),
...(getUserConfig(opts.vite).plugins || []),
...(getUserConfig(opts.routers?.client?.vite).plugins || []),
serverFunctions.client({
runtime: '@tanstack/start/client-runtime',
}),
Expand All @@ -303,13 +308,14 @@ export function defineConfig(
? [
withPlugins([
config('start-vite', {
...getUserConfig(opts.vite).userConfig,
...getUserConfig(opts.routers?.api?.vite).userConfig,
ssr: {
...(getUserConfig(opts.vite).userConfig.ssr || {}),
...(getUserConfig(opts.routers?.api?.vite).userConfig.ssr ||
{}),
noExternal: ['@tanstack/start', 'tsr:routes-manifest'],
},
optimizeDeps: {
...opts.vite?.optimizeDeps,
...opts.routers?.api?.vite?.optimizeDeps,
},
}),
TanStackRouterVite({
...tsrConfig,
Expand All @@ -326,8 +332,8 @@ export function defineConfig(
handler: apiEntry,
routes: tsrFileRouter({ tsrConfig, apiBase }),
plugins: () => [
...(opts.vite?.plugins?.() || []),
...(opts.routers?.api?.vite?.plugins?.() || []),
...(getUserConfig(opts.vite).plugins || []),
...(getUserConfig(opts.routers?.api?.vite).plugins || []),
// serverTransform({
// runtime: '@tanstack/start/server-runtime',
// }),
Expand Down Expand Up @@ -356,8 +362,8 @@ export function defineConfig(
tsrConfig,
clientBase,
}),
...(opts.vite?.plugins?.() || []),
...(opts.routers?.ssr?.vite?.plugins?.() || []),
...(getUserConfig(opts.vite).plugins || []),
...(getUserConfig(opts.routers?.ssr?.vite).plugins || []),
serverTransform({
runtime: '@tanstack/start/server-runtime',
}),
Expand Down Expand Up @@ -403,8 +409,8 @@ export function defineConfig(
// runtime: '@vinxi/react-server-dom/runtime',
// transpileDeps: ['react', 'react-dom', '@vinxi/react-server-dom'],
// }),
...(opts.vite?.plugins?.() || []),
...(opts.routers?.server?.vite?.plugins?.() || []),
...(getUserConfig(opts.vite).plugins || []),
...(getUserConfig(opts.routers?.server?.vite).plugins || []),
],
}),
],
Expand Down Expand Up @@ -442,19 +448,24 @@ function withPlugins(prePlugins: Array<any>, postPlugins?: Array<any>) {

function withStartPlugins(
opts: TanStackStartDefineConfigOptions,
router: 'client' | 'server' | 'ssr',
router: RouterType,
) {
const tsrConfig = getConfig(setTsrDefaults(opts.tsr))
const { userConfig } = getUserConfig(opts.vite)
const { userConfig: routerUserConfig } = getUserConfig(
opts.routers?.[router]?.vite,
)

return withPlugins(
[
config('start-vite', {
...userConfig,
...routerUserConfig,
ssr: {
...(userConfig.ssr || {}),
...(routerUserConfig.ssr || {}),
noExternal: ['@tanstack/start', 'tsr:routes-manifest'],
},
optimizeDeps: {
...opts.vite?.optimizeDeps,
...opts.routers?.[router]?.vite?.optimizeDeps,
},
// optimizeDeps: {
// include: ['@tanstack/start/server-runtime'],
// },
Expand Down