@tanstack/router-generator 1.120.5 → 1.121.0-alpha.3

package/src/index.ts

@@ -1,9 +1,34 @@
-export { configSchema, getConfig, resolveConfigPath } from './config'
-export type { Config } from './config'
+export {
+  configSchema,
+  getConfig,
+  resolveConfigPath,
+  baseConfigSchema,
+} from './config'
+export type { Config, BaseConfig } from './config'
+
+export { generator } from './generator'
 
 export {
-  generator,
-  startAPIRouteSegmentsFromTSRFilePath,
-  CONSTANTS,
-} from './generator'
-export type { StartAPIRoutePathSegment } from './generator'
+  logging,
+  capitalize,
+  cleanPath,
+  trimPathLeft,
+  removeLeadingSlash,
+  removeTrailingSlash,
+  determineInitialRoutePath,
+  replaceBackslash,
+  routePathToVariable,
+  removeUnderscores,
+  resetRegex,
+  multiSortBy,
+  writeIfDifferent,
+  format,
+  removeExt,
+} from './utils'
+
+export type { RouteNode, GetRouteNodesResult } from './types'
+
+export { getRouteNodes as physicalGetRouteNodes } from './filesystem/physical/getRouteNodes'
+export { getRouteNodes as virtualGetRouteNodes } from './filesystem/virtual/getRouteNodes'
+
+export { rootPathId } from './filesystem/physical/rootPathId'

package/src/template.ts

@@ -77,10 +77,8 @@ export function getTargetTemplate(target: Config['target']): TargetTemplate {
               'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n',
             ].join(''),
           imports: {
-            tsrImports: () =>
-              "import { createFileRoute } from '@tanstack/react-router';",
-            tsrExportStart: (routePath) =>
-              `export const Route = createFileRoute('${routePath}')(`,
+            tsrImports: () => '',
+            tsrExportStart: () => `export const Route = createFileRoute(`,
             tsrExportEnd: () => ');',
           },
         },
@@ -130,10 +128,8 @@ export function getTargetTemplate(target: Config['target']): TargetTemplate {
               'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n',
             ].join(''),
           imports: {
-            tsrImports: () =>
-              "import { createFileRoute } from '@tanstack/solid-router';",
-            tsrExportStart: (routePath) =>
-              `export const Route = createFileRoute('${routePath}')(`,
+            tsrImports: () => '',
+            tsrExportStart: () => `export const Route = createFileRoute(`,
             tsrExportEnd: () => ');',
           },
         },
@@ -158,10 +154,3 @@ export function getTargetTemplate(target: Config['target']): TargetTemplate {
       throw new Error(`router-generator: Unknown target type: ${target}`)
   }
 }
-
-export const defaultAPIRouteTemplate = [
-  'import { json } from "@tanstack/react-start";\n',
-  '%%tsrImports%%',
-  '\n\n',
-  '%%tsrExportStart%%{ GET: ({ request, params }) => { return json({ message:\'Hello "%%tsrPath%%"!\' }) }}%%tsrExportEnd%%\n',
-].join('')

package/src/types.ts

@@ -25,7 +25,6 @@ export type FsRouteType =
   | 'layout'
   | 'pathless_layout'
   | 'lazy'
-  | 'api'
   | 'loader' // @deprecated
   | 'component' // @deprecated
   | 'pendingComponent' // @deprecated

package/src/utils.ts

@@ -1,6 +1,5 @@
-import * as fs from 'node:fs'
+import * as fsp from 'node:fs/promises'
 import * as prettier from 'prettier'
-import type { Config } from './config'
 
 export function multiSortBy<T>(
   arr: Array<T>,
@@ -86,7 +85,55 @@ export function removeTrailingSlash(s: string) {
 }
 
 export function determineInitialRoutePath(routePath: string) {
-  return cleanPath(`/${routePath.split('.').join('/')}`) || ''
+  const DISALLOWED_ESCAPE_CHARS = new Set([
+    '/',
+    '\\',
+    '?',
+    '#',
+    ':',
+    '*',
+    '<',
+    '>',
+    '|',
+    '!',
+    '$',
+    '%',
+  ])
+
+  const parts = routePath.split(/(?<!\[)\.(?!\])/g)
+
+  // Escape any characters that in square brackets
+  const escapedParts = parts.map((part) => {
+    // Check if any disallowed characters are used in brackets
+    const BRACKET_CONTENT_RE = /\[(.*?)\]/g
+
+    let match
+    while ((match = BRACKET_CONTENT_RE.exec(part)) !== null) {
+      const character = match[1]
+      if (character === undefined) continue
+      if (DISALLOWED_ESCAPE_CHARS.has(character)) {
+        console.error(
+          `Error: Disallowed character "${character}" found in square brackets in route path "${routePath}".\nYou cannot use any of the following characters in square brackets: ${Array.from(
+            DISALLOWED_ESCAPE_CHARS,
+          ).join(', ')}\nPlease remove and/or replace them.`,
+        )
+        process.exit(1)
+      }
+    }
+
+    // Since this split segment is safe at this point, we can
+    // remove the brackets and replace them with the content inside
+    return part.replace(/\[(.)\]/g, '$1')
+  })
+
+  // If the syntax for prefix/suffix is different, from the path
+  // matching internals of router-core, we'd perform those changes here
+  // on the `escapedParts` array before it is joined back together in
+  // `final`
+
+  const final = cleanPath(`/${escapedParts.join('/')}`) || ''
+
+  return final
 }
 
 export function replaceBackslash(s: string) {
@@ -94,15 +141,43 @@ export function replaceBackslash(s: string) {
 }
 
 export function routePathToVariable(routePath: string): string {
+  const toVariableSafeChar = (char: string): string => {
+    if (/[a-zA-Z0-9_]/.test(char)) {
+      return char // Keep alphanumeric characters and underscores as is
+    }
+
+    // Replace special characters with meaningful text equivalents
+    switch (char) {
+      case '.':
+        return 'Dot'
+      case '-':
+        return 'Dash'
+      case '@':
+        return 'At'
+      case '(':
+        return '' // Removed since route groups use parentheses
+      case ')':
+        return '' // Removed since route groups use parentheses
+      case ' ':
+        return '' // Remove spaces
+      default:
+        return `Char${char.charCodeAt(0)}` // For any other characters
+    }
+  }
+
   return (
     removeUnderscores(routePath)
       ?.replace(/\/\$\//g, '/splat/')
       .replace(/\$$/g, 'splat')
+      .replace(/\$\{\$\}/g, 'splat')
       .replace(/\$/g, '')
       .split(/[/-]/g)
       .map((d, i) => (i > 0 ? capitalize(d) : d))
       .join('')
-      .replace(/([^a-zA-Z0-9]|[.])/gm, '')
+      .split('')
+      .map(toVariableSafeChar)
+      .join('')
+      // .replace(/([^a-zA-Z0-9]|[.])/gm, '')
       .replace(/^(\d)/g, 'R$1') ?? ''
   )
 }
@@ -137,7 +212,7 @@ export async function writeIfDifferent(
 ): Promise<boolean> {
   if (content !== incomingContent) {
     callbacks?.beforeWrite?.()
-    fs.writeFileSync(filepath, incomingContent)
+    await fsp.writeFile(filepath, incomingContent)
     callbacks?.afterWrite?.()
     return true
   }
@@ -151,7 +226,13 @@ export async function writeIfDifferent(
  * @param config The configuration object
  * @returns The formatted content
  */
-export async function format(source: string, config: Config): Promise<string> {
+export async function format(
+  source: string,
+  config: {
+    quoteStyle: 'single' | 'double'
+    semicolons: boolean
+  },
+): Promise<string> {
   const prettierOptions: prettier.Config = {
     semi: config.semicolons,
     singleQuote: config.quoteStyle === 'single',
@@ -172,3 +253,18 @@ export function resetRegex(regex: RegExp) {
   regex.lastIndex = 0
   return
 }
+
+/**
+ * This function checks if a file exists.
+ *
+ * @param file The path to the file
+ * @returns Whether the file exists
+ */
+export async function checkFileExists(file: string) {
+  try {
+    await fsp.access(file, fsp.constants.F_OK)
+    return true
+  } catch {
+    return false
+  }
+}