Start ALPHA - Breaking Changes

[SeanCassiere]

This is to keep track of any and all BREAKING CHANGES that are made during the Start ALPHA period so that our testers have a single location to find out what's changed between versions.

v1.58.7 - Rename deployment to server in app.config.ts

The key deployment used in defineConfig has now been renamed to server.

// app.config.ts
import { defineConfig } from '@tanstack/start/config'

export default defineConfig({
- deployment: {
+ server: {
    preset: 'vercel',
  },
})

v1.68.0 - plugins is not a function anymore

but the whole vite property can be a function!

 export default defineConfig({
   vite: {
-    plugins: () => [
+    plugins: [
       tsConfigPaths({
         projects: ['./tsconfig.json'],
       }),

👀 Coming soon - Unify meta, scripts, and links under the headmethod

A Route configuration can accept a new method named head which returns an object keyed to accept meta, links, and scripts. These returned properties are the same as what was previously returned by the individual methods.

The individual methods for meta, links, and scripts are being dropped in favour of this head method.

// src/routes/posts.$postId.tsx
import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/posts/$postId')({
-	meta: ({ loaderData }) => [],
-	links: () => [],
-	scripts: () => [],
+	head: ({ loaderData }) => {
+		const data = loaderData // type -> LoaderData | undefined
+		return {
+			meta: [],
+			links: [],
+			scripts: [],
+		}
+	} 
})

👀 Coming soon - Rewrite the interface of createServerFn

...