@tanstack/create 0.61.3 → 0.61.5

package/dist/types/types.d.ts

@@ -198,6 +198,28 @@ export declare const AddOnBaseSchema: z.ZodObject<{
         default: string;
         description?: string | undefined;
     }>]>>>;
+    envVars: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodString>;
+        secret: z.ZodOptional<z.ZodBoolean>;
+        file: z.ZodOptional<z.ZodEnum<[".env", ".env.local"]>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }>, "many">>;
     default: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     type: "add-on" | "example" | "starter" | "toolchain" | "deployment";
@@ -247,6 +269,14 @@ export declare const AddOnBaseSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
 }, {
     type: "add-on" | "example" | "starter" | "toolchain" | "deployment";
     description: string;
@@ -295,6 +325,14 @@ export declare const AddOnBaseSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
 }>;
 export declare const StarterSchema: z.ZodObject<{
     id: z.ZodString;
@@ -391,6 +429,28 @@ export declare const StarterSchema: z.ZodObject<{
         default: string;
         description?: string | undefined;
     }>]>>>;
+    envVars: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodString>;
+        secret: z.ZodOptional<z.ZodBoolean>;
+        file: z.ZodOptional<z.ZodEnum<[".env", ".env.local"]>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }>, "many">>;
     default: z.ZodOptional<z.ZodBoolean>;
 } & {
     framework: z.ZodString;
@@ -448,6 +508,14 @@ export declare const StarterSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     banner?: string | undefined;
 }, {
     type: "add-on" | "example" | "starter" | "toolchain" | "deployment";
@@ -500,6 +568,14 @@ export declare const StarterSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     banner?: string | undefined;
 }>;
 export declare const StarterCompiledSchema: z.ZodObject<{
@@ -597,6 +673,28 @@ export declare const StarterCompiledSchema: z.ZodObject<{
         default: string;
         description?: string | undefined;
     }>]>>>;
+    envVars: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodString>;
+        secret: z.ZodOptional<z.ZodBoolean>;
+        file: z.ZodOptional<z.ZodEnum<[".env", ".env.local"]>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }>, "many">>;
     default: z.ZodOptional<z.ZodBoolean>;
 } & {
     framework: z.ZodString;
@@ -659,6 +757,14 @@ export declare const StarterCompiledSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     banner?: string | undefined;
 }, {
     type: "add-on" | "example" | "starter" | "toolchain" | "deployment";
@@ -713,6 +819,14 @@ export declare const StarterCompiledSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     banner?: string | undefined;
 }>;
 export declare const IntegrationSchema: z.ZodObject<{
@@ -829,6 +943,28 @@ export declare const AddOnInfoSchema: z.ZodObject<{
         default: string;
         description?: string | undefined;
     }>]>>>;
+    envVars: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodString>;
+        secret: z.ZodOptional<z.ZodBoolean>;
+        file: z.ZodOptional<z.ZodEnum<[".env", ".env.local"]>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }>, "many">>;
     default: z.ZodOptional<z.ZodBoolean>;
 } & {
     modes: z.ZodArray<z.ZodString, "many">;
@@ -904,6 +1040,14 @@ export declare const AddOnInfoSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     integrations?: {
         type?: string | undefined;
         code?: string | undefined;
@@ -963,6 +1107,14 @@ export declare const AddOnInfoSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     integrations?: {
         type?: string | undefined;
         code?: string | undefined;
@@ -1068,6 +1220,28 @@ export declare const AddOnCompiledSchema: z.ZodObject<{
         default: string;
         description?: string | undefined;
     }>]>>>;
+    envVars: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodString>;
+        secret: z.ZodOptional<z.ZodBoolean>;
+        file: z.ZodOptional<z.ZodEnum<[".env", ".env.local"]>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }, {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }>, "many">>;
     default: z.ZodOptional<z.ZodBoolean>;
 } & {
     modes: z.ZodArray<z.ZodString, "many">;
@@ -1149,6 +1323,14 @@ export declare const AddOnCompiledSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     integrations?: {
         type?: string | undefined;
         code?: string | undefined;
@@ -1211,6 +1393,14 @@ export declare const AddOnCompiledSchema: z.ZodObject<{
     addOnSpecialSteps?: string[] | undefined;
     createSpecialSteps?: string[] | undefined;
     postInitSpecialSteps?: string[] | undefined;
+    envVars?: {
+        name: string;
+        file?: ".env" | ".env.local" | undefined;
+        description?: string | undefined;
+        default?: string | undefined;
+        required?: boolean | undefined;
+        secret?: boolean | undefined;
+    }[] | undefined;
     integrations?: {
         type?: string | undefined;
         code?: string | undefined;
@@ -1274,6 +1464,9 @@ export interface Options {
     chosenAddOns: Array<AddOn>;
     addOnOptions: Record<string, Record<string, any>>;
     starter?: Starter | undefined;
+    routerOnly?: boolean;
+    includeExamples?: boolean;
+    envVarValues?: Record<string, string>;
 }
 export type SerializedOptions = Omit<Options, 'chosenAddOns' | 'starter' | 'framework'> & {
     chosenAddOns: Array<string>;

package/dist/types.js

@@ -75,6 +75,16 @@ export const AddOnBaseSchema = z.object({
     createSpecialSteps: z.array(z.string()).optional(),
     postInitSpecialSteps: z.array(z.string()).optional(),
     options: AddOnOptionsSchema.optional(),
+    envVars: z
+        .array(z.object({
+        name: z.string(),
+        description: z.string().optional(),
+        required: z.boolean().optional(),
+        default: z.string().optional(),
+        secret: z.boolean().optional(),
+        file: z.enum(['.env', '.env.local']).optional(),
+    }))
+        .optional(),
     default: z.boolean().optional(),
 });
 export const StarterSchema = AddOnBaseSchema.extend({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/create",
-  "version": "0.61.3",
+  "version": "0.61.5",
   "description": "TanStack Application Builder Engine",
   "type": "module",
   "main": "./dist/index.js",

package/src/create-app.ts

@@ -16,6 +16,51 @@ import { runSpecialSteps } from './special-steps/index.js'
 
 import type { Environment, FileBundleHandler, Options } from './types.js'
 
+function isDemoRoutePath(path?: string) {
+  if (!path) return false
+  const normalized = path.replace(/\\/g, '/')
+  return (
+    normalized.includes('/routes/demo/') ||
+    normalized.includes('/routes/demo.') ||
+    normalized.includes('/routes/example/') ||
+    normalized.includes('/routes/example.')
+  )
+}
+
+function stripExamplesFromOptions(options: Options): Options {
+  if (options.includeExamples !== false) {
+    return options
+  }
+
+  const chosenAddOns = options.chosenAddOns
+    .filter((addOn) => addOn.type !== 'example')
+    .map((addOn) => {
+      const filteredRoutes = (addOn.routes || []).filter(
+        (route) =>
+          !isDemoRoutePath(route.path) &&
+          !(route.url && route.url.startsWith('/demo')),
+      )
+
+      return {
+        ...addOn,
+        routes: filteredRoutes,
+        getFiles: async () => {
+          const files = await addOn.getFiles()
+          return files.filter((file) => !isDemoRoutePath(file))
+        },
+        getDeletedFiles: async () => {
+          const deletedFiles = await addOn.getDeletedFiles()
+          return deletedFiles.filter((file) => !isDemoRoutePath(file))
+        },
+      }
+    })
+
+  return {
+    ...options,
+    chosenAddOns,
+  }
+}
+
 async function writeFiles(environment: Environment, options: Options) {
   const templateFileFromContent = createTemplateFile(environment, options)
 
@@ -235,6 +280,32 @@ async function runCommandsAndInstallDependencies(
   await installShadcnComponents(environment, options.targetDir, options)
 }
 
+async function seedEnvValues(environment: Environment, options: Options) {
+  const envVarValues = options.envVarValues || {}
+  const entries = Object.entries(envVarValues)
+  if (entries.length === 0) return
+
+  const envLocalPath = resolve(options.targetDir, '.env.local')
+  if (!environment.exists(envLocalPath)) {
+    return
+  }
+
+  let envContents = await environment.readFile(envLocalPath)
+  for (const [key, value] of entries) {
+    const escapedValue = value.replace(/\n/g, '\\n')
+    const nextLine = `${key}=${escapedValue}`
+    const pattern = new RegExp(`^${key}=.*$`, 'm')
+
+    if (pattern.test(envContents)) {
+      envContents = envContents.replace(pattern, nextLine)
+    } else {
+      envContents += `${envContents.endsWith('\n') ? '' : '\n'}${nextLine}\n`
+    }
+  }
+
+  await environment.writeFile(envLocalPath, envContents)
+}
+
 function report(environment: Environment, options: Options) {
   const warnings: Array<string> = []
   for (const addOn of options.chosenAddOns) {
@@ -282,10 +353,13 @@ Please read the README.md file for information on testing, styling, adding route
 }
 
 export async function createApp(environment: Environment, options: Options) {
+  const effectiveOptions = stripExamplesFromOptions(options)
+
   environment.startRun()
-  await writeFiles(environment, options)
-  await runCommandsAndInstallDependencies(environment, options)
+  await writeFiles(environment, effectiveOptions)
+  await seedEnvValues(environment, effectiveOptions)
+  await runCommandsAndInstallDependencies(environment, effectiveOptions)
   environment.finishRun()
 
-  report(environment, options)
+  report(environment, effectiveOptions)
 }

package/src/custom-add-ons/add-on.ts

@@ -1,4 +1,4 @@
-import { readFile } from 'node:fs/promises'
+import { readFile, watch } from 'node:fs/promises'
 import { existsSync, mkdirSync, writeFileSync } from 'node:fs'
 import { basename, dirname, resolve } from 'node:path'
 
@@ -36,6 +36,22 @@ const COMPILED_FILE = 'add-on.json'
 
 const ASSETS_DIR = 'assets'
 
+const ADD_ON_DEV_IGNORE_PREFIXES = [
+  '.add-on/',
+  '.git/',
+  'node_modules/',
+  '.turbo/',
+  'dist/',
+]
+
+function shouldIgnoreDevPath(path: string) {
+  const normalized = path.replace(/\\/g, '/')
+  if (normalized === COMPILED_FILE) return true
+  return ADD_ON_DEV_IGNORE_PREFIXES.some((prefix) =>
+    normalized.startsWith(prefix),
+  )
+}
+
 export function camelCase(str: string) {
   return str
     .split(/(\.|-|\/)/)
@@ -122,6 +138,11 @@ export async function readOrGenerateAddOnInfo(
         },
         dependsOn: options.chosenAddOns,
       } as AddOnInfo)
+
+  if (!info.version) {
+    info.version = '0.0.1'
+  }
+
   return info
 }
 
@@ -213,6 +234,56 @@ export async function initAddOn(environment: Environment) {
   await compileAddOn(environment)
 }
 
+export async function devAddOn(environment: Environment) {
+  await initAddOn(environment)
+
+  environment.info(
+    'Add-on dev mode is running.',
+    'Watching project files and recompiling add-on output on changes. Press Ctrl+C to stop.',
+  )
+
+  const abortController = new AbortController()
+  let debounceTimeout: ReturnType<typeof setTimeout> | undefined
+
+  const rerun = async () => {
+    try {
+      await updateAddOnInfo(environment)
+      await compileAddOn(environment)
+      environment.info('Add-on updated.', 'Compiled add-on.json and refreshed .add-on')
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error)
+      environment.error('Failed to rebuild add-on.', message)
+    }
+  }
+
+  process.once('SIGINT', () => {
+    abortController.abort()
+  })
+
+  try {
+    for await (const event of watch(process.cwd(), {
+      recursive: true,
+      signal: abortController.signal,
+    })) {
+      const file = event.filename?.toString()
+      if (!file || shouldIgnoreDevPath(file)) continue
+
+      if (debounceTimeout) {
+        clearTimeout(debounceTimeout)
+      }
+
+      debounceTimeout = setTimeout(() => {
+        void rerun()
+      }, 200)
+    }
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error)
+    if (!message.includes('aborted')) {
+      throw error
+    }
+  }
+}
+
 export async function loadRemoteAddOn(url: string): Promise<AddOn> {
   const response = await fetch(url)
   const jsonContent = await response.json()

package/src/custom-add-ons/starter.ts

@@ -27,7 +27,7 @@ const COMPILED_FILE = 'starter.json'
 export async function readOrGenerateStarterInfo(
   options: PersistedOptions,
 ): Promise<StarterInfo> {
-  return existsSync(INFO_FILE)
+  const info = existsSync(INFO_FILE)
     ? JSON.parse((await readFile(INFO_FILE)).toString())
     : {
         id: `${options.projectName}-starter`,
@@ -51,6 +51,12 @@ export async function readOrGenerateStarterInfo(
         dependsOn: options.chosenAddOns,
         typescript: true,
       }
+
+  if (!info.version) {
+    info.version = '0.0.1'
+  }
+
+  return info
 }
 
 async function loadCurrentStarterInfo(environment: Environment) {

package/src/frameworks/react/add-ons/clerk/info.json

@@ -28,5 +28,14 @@
       "jsName": "ClerkProvider",
       "path": "src/integrations/clerk/provider.tsx"
     }
+  ],
+  "envVars": [
+    {
+      "name": "VITE_CLERK_PUBLISHABLE_KEY",
+      "description": "Clerk publishable key",
+      "required": true,
+      "secret": false,
+      "file": ".env.local"
+    }
   ]
 }

package/src/frameworks/react/add-ons/convex/info.json

@@ -23,5 +23,21 @@
       "path": "src/integrations/convex/provider.tsx",
       "jsName": "ConvexProvider"
     }
+  ],
+  "envVars": [
+    {
+      "name": "CONVEX_DEPLOYMENT",
+      "description": "Convex deployment name",
+      "required": false,
+      "secret": false,
+      "file": ".env.local"
+    },
+    {
+      "name": "VITE_CONVEX_URL",
+      "description": "Convex deployment URL",
+      "required": true,
+      "secret": false,
+      "file": ".env.local"
+    }
   ]
 }

package/src/frameworks/react/project/base/_dot_gitignore

@@ -3,7 +3,6 @@ node_modules
 dist
 dist-ssr
 *.local
-count.txt
 .env
 .nitro
 .tanstack

package/src/frameworks/react/project/base/index.html.ejs

@@ -0,0 +1,13 @@
+<% if (!routerOnly) { ignoreFile() } %>
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title><%= projectName %></title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/src/frameworks/react/project/base/src/main.tsx.ejs

@@ -0,0 +1,24 @@
+<% if (!routerOnly) { ignoreFile() } %>
+import React from 'react'
+import ReactDOM from 'react-dom/client'
+import { RouterProvider, createRouter } from '@tanstack/react-router'
+import { routeTree } from './routeTree.gen'
+
+const router = createRouter({
+  routeTree,
+  defaultPreload: 'intent',
+  scrollRestoration: true,
+})
+
+declare module '@tanstack/react-router' {
+  interface Register {
+    router: typeof router
+  }
+}
+
+const rootElement = document.getElementById('app')!
+
+if (!rootElement.innerHTML) {
+  const root = ReactDOM.createRoot(rootElement)
+  root.render(<RouterProvider router={router} />)
+}

package/src/frameworks/react/project/base/src/routes/__root.tsx.ejs

@@ -1,3 +1,33 @@
+<% if (routerOnly) { %>
+import { Outlet, createRootRoute } from '@tanstack/react-router'
+import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
+import { TanStackDevtools } from '@tanstack/react-devtools'
+
+import '../styles.css'
+
+export const Route = createRootRoute({
+  component: RootComponent,
+})
+
+function RootComponent() {
+  return (
+    <>
+      <Outlet />
+      <TanStackDevtools
+        config={{
+          position: 'bottom-right',
+        }}
+        plugins={[
+          {
+            name: 'TanStack Router',
+            render: <TanStackRouterDevtoolsPanel />,
+          },
+        ]}
+      />
+    </>
+  )
+}
+<% } else { %>
 <% let hasContext = addOnEnabled["apollo-client"] || addOnEnabled["tanstack-query"]; %>
 import {
   HeadContent, Scripts, <% if (hasContext) { %>createRootRouteWithContext<% } else { %>createRootRoute<% } %> } from '@tanstack/react-router'
@@ -93,3 +123,4 @@ function RootDocument({ children }: { children: React.ReactNode }) {
     </html>
   )
 }
+<% } %>