@tanstack/router-generator 1.121.0-alpha.5 → 1.121.0

package/dist/cjs/plugin/types.d.cts

@@ -0,0 +1,46 @@
+import { TransformPlugin } from '../transform/types.cjs';
+import { HandleNodeAccumulator, ImportDeclaration, RouteNode } from '../types.cjs';
+import { Generator } from '../generator.cjs';
+export type GeneratorPlugin = GeneratorPluginBase | GeneratorPluginWithTransform;
+export interface GeneratorPluginBase {
+    name: string;
+    onRouteTreesChanged?: (opts: {
+        routeTrees: Array<{
+            sortedRouteNodes: Array<RouteNode>;
+            acc: HandleNodeAccumulator;
+            exportName: string;
+        }>;
+        rootRouteNode: RouteNode;
+        generator: Generator;
+    }) => void;
+}
+export interface GeneratorPluginWithTransform extends GeneratorPluginBase {
+    transformPlugin: TransformPlugin;
+    moduleAugmentation: (opts: {
+        generator: Generator;
+    }) => {
+        module: string;
+        interfaceName: string;
+    };
+    imports: (opts: {
+        rootRouteNode: RouteNode;
+        sortedRouteNodes: Array<RouteNode>;
+        acc: HandleNodeAccumulator;
+        generator: Generator;
+    }) => Array<ImportDeclaration>;
+    routeModuleAugmentation: (opts: {
+        routeNode: RouteNode;
+    }) => string | undefined;
+    createRootRouteCode: () => string;
+    createVirtualRouteCode: (opts: {
+        node: RouteNode;
+    }) => string;
+    config: (opts: {
+        generator: Generator;
+        rootRouteNode: RouteNode;
+        sortedRouteNodes: Array<RouteNode>;
+    }) => {
+        virtualRootRoute?: boolean;
+    };
+}
+export {};

package/dist/cjs/template.cjs

@@ -8,9 +8,9 @@ function fillTemplate(config, template, values) {
   );
   return utils.format(replaced, config);
 }
-function getTargetTemplate(target) {
+function getTargetTemplate(config) {
+  const target = config.target;
   switch (target) {
-    // TODO: Remove this disabled eslint rule when more target types are added.
     case "react":
       return {
         fullPkg: "@tanstack/react-router",
@@ -37,8 +37,8 @@ function getTargetTemplate(target) {
             'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n'
           ].join(""),
           imports: {
-            tsrImports: () => "",
-            tsrExportStart: () => `export const Route = createFileRoute(`,
+            tsrImports: () => config.verboseFileRoutes === false ? "" : "import { createFileRoute } from '@tanstack/react-router';",
+            tsrExportStart: (routePath) => config.verboseFileRoutes === false ? "export const Route = createFileRoute(" : `export const Route = createFileRoute('${routePath}')(`,
             tsrExportEnd: () => ");"
           }
         },
@@ -50,8 +50,8 @@ function getTargetTemplate(target) {
             'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n'
           ].join(""),
           imports: {
-            tsrImports: () => "import { createLazyFileRoute } from '@tanstack/react-router';",
-            tsrExportStart: (routePath) => `export const Route = createLazyFileRoute('${routePath}')(`,
+            tsrImports: () => config.verboseFileRoutes === false ? "" : "import { createLazyFileRoute } from '@tanstack/react-router';",
+            tsrExportStart: (routePath) => config.verboseFileRoutes === false ? "export const Route = createLazyFileRoute(" : `export const Route = createLazyFileRoute('${routePath}')(`,
             tsrExportEnd: () => ");"
           }
         }
@@ -82,8 +82,8 @@ function getTargetTemplate(target) {
             'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n'
           ].join(""),
           imports: {
-            tsrImports: () => "",
-            tsrExportStart: () => `export const Route = createFileRoute(`,
+            tsrImports: () => config.verboseFileRoutes === false ? "" : "import { createFileRoute } from '@tanstack/solid-router';",
+            tsrExportStart: (routePath) => config.verboseFileRoutes === false ? "export const Route = createFileRoute(" : `export const Route = createFileRoute('${routePath}')(`,
             tsrExportEnd: () => ");"
           }
         },
@@ -95,8 +95,8 @@ function getTargetTemplate(target) {
             'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n'
           ].join(""),
           imports: {
-            tsrImports: () => "import { createLazyFileRoute } from '@tanstack/solid-router';",
-            tsrExportStart: (routePath) => `export const Route = createLazyFileRoute('${routePath}')(`,
+            tsrImports: () => config.verboseFileRoutes === false ? "" : "import { createLazyFileRoute } from '@tanstack/solid-router';",
+            tsrExportStart: (routePath) => config.verboseFileRoutes === false ? "export const Route = createLazyFileRoute(" : `export const Route = createLazyFileRoute('${routePath}')(`,
             tsrExportEnd: () => ");"
           }
         }

package/dist/cjs/template.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"template.cjs","sources":["../../src/template.ts"],"sourcesContent":["import { format } from './utils'\nimport type { Config } from './config'\n\ntype TemplateTag = 'tsrImports' | 'tsrPath' | 'tsrExportStart' | 'tsrExportEnd'\n\nexport function fillTemplate(\n  config: Config,\n  template: string,\n  values: Record<TemplateTag, string>,\n) {\n  const replaced = template.replace(\n    /%%(\\w+)%%/g,\n    (_, key) => values[key as TemplateTag] || '',\n  )\n  return format(replaced, config)\n}\n\ntype TargetTemplate = {\n  fullPkg: string\n  subPkg: string\n  rootRoute: {\n    template: () => string\n    imports: {\n      tsrImports: () => string\n      tsrExportStart: () => string\n      tsrExportEnd: () => string\n    }\n  }\n  route: {\n    template: () => string\n    imports: {\n      tsrImports: () => string\n      tsrExportStart: (routePath: string) => string\n      tsrExportEnd: () => string\n    }\n  }\n  lazyRoute: {\n    template: () => string\n    imports: {\n      tsrImports: () => string\n      tsrExportStart: (routePath: string) => string\n      tsrExportEnd: () => string\n    }\n  }\n}\n\nexport function getTargetTemplate(target: Config['target']): TargetTemplate {\n  switch (target) {\n    // TODO: Remove this disabled eslint rule when more target types are added.\n\n    case 'react':\n      return {\n        fullPkg: '@tanstack/react-router',\n        subPkg: 'react-router',\n        rootRoute: {\n          template: () =>\n            [\n              'import * as React from \"react\"\\n',\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RootComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RootComponent() { return (<React.Fragment><div>Hello \"%%tsrPath%%\"!</div><Outlet /></React.Fragment>) };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              \"import { Outlet, createRootRoute } from '@tanstack/react-router';\",\n            tsrExportStart: () => 'export const Route = createRootRoute(',\n            tsrExportEnd: () => ');',\n          },\n        },\n        route: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () => '',\n            tsrExportStart: () => `export const Route = createFileRoute(`,\n            tsrExportEnd: () => ');',\n          },\n        },\n        lazyRoute: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              \"import { createLazyFileRoute } from '@tanstack/react-router';\",\n            tsrExportStart: (routePath) =>\n              `export const Route = createLazyFileRoute('${routePath}')(`,\n            tsrExportEnd: () => ');',\n          },\n        },\n      }\n    case 'solid':\n      return {\n        fullPkg: '@tanstack/solid-router',\n        subPkg: 'solid-router',\n        rootRoute: {\n          template: () =>\n            [\n              'import * as Solid from \"solid-js\"\\n',\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RootComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RootComponent() { return (<><div>Hello \"%%tsrPath%%\"!</div><Outlet /></>) };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              \"import { Outlet, createRootRoute } from '@tanstack/solid-router';\",\n            tsrExportStart: () => 'export const Route = createRootRoute(',\n            tsrExportEnd: () => ');',\n          },\n        },\n        route: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () => '',\n            tsrExportStart: () => `export const Route = createFileRoute(`,\n            tsrExportEnd: () => ');',\n          },\n        },\n        lazyRoute: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              \"import { createLazyFileRoute } from '@tanstack/solid-router';\",\n            tsrExportStart: (routePath) =>\n              `export const Route = createLazyFileRoute('${routePath}')(`,\n            tsrExportEnd: () => ');',\n          },\n        },\n      }\n    default:\n      throw new Error(`router-generator: Unknown target type: ${target}`)\n  }\n}\n"],"names":["format"],"mappings":";;;AAKgB,SAAA,aACd,QACA,UACA,QACA;AACA,QAAM,WAAW,SAAS;AAAA,IACxB;AAAA,IACA,CAAC,GAAG,QAAQ,OAAO,GAAkB,KAAK;AAAA,EAC5C;AACO,SAAAA,MAAA,OAAO,UAAU,MAAM;AAChC;AA+BO,SAAS,kBAAkB,QAA0C;AAC1E,UAAQ,QAAQ;AAAA;AAAA,IAGd,KAAK;AACI,aAAA;AAAA,QACL,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV;AAAA,YACF,gBAAgB,MAAM;AAAA,YACtB,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,OAAO;AAAA,UACL,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MAAM;AAAA,YAClB,gBAAgB,MAAM;AAAA,YACtB,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV;AAAA,YACF,gBAAgB,CAAC,cACf,6CAA6C,SAAS;AAAA,YACxD,cAAc,MAAM;AAAA,UAAA;AAAA,QACtB;AAAA,MAEJ;AAAA,IACF,KAAK;AACI,aAAA;AAAA,QACL,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV;AAAA,YACF,gBAAgB,MAAM;AAAA,YACtB,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,OAAO;AAAA,UACL,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MAAM;AAAA,YAClB,gBAAgB,MAAM;AAAA,YACtB,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV;AAAA,YACF,gBAAgB,CAAC,cACf,6CAA6C,SAAS;AAAA,YACxD,cAAc,MAAM;AAAA,UAAA;AAAA,QACtB;AAAA,MAEJ;AAAA,IACF;AACE,YAAM,IAAI,MAAM,0CAA0C,MAAM,EAAE;AAAA,EAAA;AAExE;;;"}
+{"version":3,"file":"template.cjs","sources":["../../src/template.ts"],"sourcesContent":["import { format } from './utils'\nimport type { Config } from './config'\n\ntype TemplateTag = 'tsrImports' | 'tsrPath' | 'tsrExportStart' | 'tsrExportEnd'\n\nexport function fillTemplate(\n  config: Config,\n  template: string,\n  values: Record<TemplateTag, string>,\n) {\n  const replaced = template.replace(\n    /%%(\\w+)%%/g,\n    (_, key) => values[key as TemplateTag] || '',\n  )\n  return format(replaced, config)\n}\n\nexport type TargetTemplate = {\n  fullPkg: string\n  subPkg: string\n  rootRoute: {\n    template: () => string\n    imports: {\n      tsrImports: () => string\n      tsrExportStart: () => string\n      tsrExportEnd: () => string\n    }\n  }\n  route: {\n    template: () => string\n    imports: {\n      tsrImports: () => string\n      tsrExportStart: (routePath: string) => string\n      tsrExportEnd: () => string\n    }\n  }\n  lazyRoute: {\n    template: () => string\n    imports: {\n      tsrImports: () => string\n      tsrExportStart: (routePath: string) => string\n      tsrExportEnd: () => string\n    }\n  }\n}\n\nexport function getTargetTemplate(config: Config): TargetTemplate {\n  const target = config.target\n  switch (target) {\n    case 'react':\n      return {\n        fullPkg: '@tanstack/react-router',\n        subPkg: 'react-router',\n        rootRoute: {\n          template: () =>\n            [\n              'import * as React from \"react\"\\n',\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RootComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RootComponent() { return (<React.Fragment><div>Hello \"%%tsrPath%%\"!</div><Outlet /></React.Fragment>) };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              \"import { Outlet, createRootRoute } from '@tanstack/react-router';\",\n            tsrExportStart: () => 'export const Route = createRootRoute(',\n            tsrExportEnd: () => ');',\n          },\n        },\n        route: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              config.verboseFileRoutes === false\n                ? ''\n                : \"import { createFileRoute } from '@tanstack/react-router';\",\n            tsrExportStart: (routePath) =>\n              config.verboseFileRoutes === false\n                ? 'export const Route = createFileRoute('\n                : `export const Route = createFileRoute('${routePath}')(`,\n            tsrExportEnd: () => ');',\n          },\n        },\n        lazyRoute: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              config.verboseFileRoutes === false\n                ? ''\n                : \"import { createLazyFileRoute } from '@tanstack/react-router';\",\n            tsrExportStart: (routePath) =>\n              config.verboseFileRoutes === false\n                ? 'export const Route = createLazyFileRoute('\n                : `export const Route = createLazyFileRoute('${routePath}')(`,\n            tsrExportEnd: () => ');',\n          },\n        },\n      }\n    case 'solid':\n      return {\n        fullPkg: '@tanstack/solid-router',\n        subPkg: 'solid-router',\n        rootRoute: {\n          template: () =>\n            [\n              'import * as Solid from \"solid-js\"\\n',\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RootComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RootComponent() { return (<><div>Hello \"%%tsrPath%%\"!</div><Outlet /></>) };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              \"import { Outlet, createRootRoute } from '@tanstack/solid-router';\",\n            tsrExportStart: () => 'export const Route = createRootRoute(',\n            tsrExportEnd: () => ');',\n          },\n        },\n        route: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              config.verboseFileRoutes === false\n                ? ''\n                : \"import { createFileRoute } from '@tanstack/solid-router';\",\n            tsrExportStart: (routePath) =>\n              config.verboseFileRoutes === false\n                ? 'export const Route = createFileRoute('\n                : `export const Route = createFileRoute('${routePath}')(`,\n            tsrExportEnd: () => ');',\n          },\n        },\n        lazyRoute: {\n          template: () =>\n            [\n              '%%tsrImports%%',\n              '\\n\\n',\n              '%%tsrExportStart%%{\\n component: RouteComponent\\n }%%tsrExportEnd%%\\n\\n',\n              'function RouteComponent() { return <div>Hello \"%%tsrPath%%\"!</div> };\\n',\n            ].join(''),\n          imports: {\n            tsrImports: () =>\n              config.verboseFileRoutes === false\n                ? ''\n                : \"import { createLazyFileRoute } from '@tanstack/solid-router';\",\n\n            tsrExportStart: (routePath) =>\n              config.verboseFileRoutes === false\n                ? 'export const Route = createLazyFileRoute('\n                : `export const Route = createLazyFileRoute('${routePath}')(`,\n\n            tsrExportEnd: () => ');',\n          },\n        },\n      }\n    default:\n      throw new Error(`router-generator: Unknown target type: ${target}`)\n  }\n}\n"],"names":["format"],"mappings":";;;AAKgB,SAAA,aACd,QACA,UACA,QACA;AACA,QAAM,WAAW,SAAS;AAAA,IACxB;AAAA,IACA,CAAC,GAAG,QAAQ,OAAO,GAAkB,KAAK;AAAA,EAC5C;AACO,SAAAA,MAAA,OAAO,UAAU,MAAM;AAChC;AA+BO,SAAS,kBAAkB,QAAgC;AAChE,QAAM,SAAS,OAAO;AACtB,UAAQ,QAAQ;AAAA,IACd,KAAK;AACI,aAAA;AAAA,QACL,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV;AAAA,YACF,gBAAgB,MAAM;AAAA,YACtB,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,OAAO;AAAA,UACL,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV,OAAO,sBAAsB,QACzB,KACA;AAAA,YACN,gBAAgB,CAAC,cACf,OAAO,sBAAsB,QACzB,0CACA,yCAAyC,SAAS;AAAA,YACxD,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV,OAAO,sBAAsB,QACzB,KACA;AAAA,YACN,gBAAgB,CAAC,cACf,OAAO,sBAAsB,QACzB,8CACA,6CAA6C,SAAS;AAAA,YAC5D,cAAc,MAAM;AAAA,UAAA;AAAA,QACtB;AAAA,MAEJ;AAAA,IACF,KAAK;AACI,aAAA;AAAA,QACL,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV;AAAA,YACF,gBAAgB,MAAM;AAAA,YACtB,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,OAAO;AAAA,UACL,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV,OAAO,sBAAsB,QACzB,KACA;AAAA,YACN,gBAAgB,CAAC,cACf,OAAO,sBAAsB,QACzB,0CACA,yCAAyC,SAAS;AAAA,YACxD,cAAc,MAAM;AAAA,UAAA;AAAA,QAExB;AAAA,QACA,WAAW;AAAA,UACT,UAAU,MACR;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,EACA,KAAK,EAAE;AAAA,UACX,SAAS;AAAA,YACP,YAAY,MACV,OAAO,sBAAsB,QACzB,KACA;AAAA,YAEN,gBAAgB,CAAC,cACf,OAAO,sBAAsB,QACzB,8CACA,6CAA6C,SAAS;AAAA,YAE5D,cAAc,MAAM;AAAA,UAAA;AAAA,QACtB;AAAA,MAEJ;AAAA,IACF;AACE,YAAM,IAAI,MAAM,0CAA0C,MAAM,EAAE;AAAA,EAAA;AAExE;;;"}

package/dist/cjs/template.d.cts

@@ -1,7 +1,7 @@
 import { Config } from './config.cjs';
 type TemplateTag = 'tsrImports' | 'tsrPath' | 'tsrExportStart' | 'tsrExportEnd';
 export declare function fillTemplate(config: Config, template: string, values: Record<TemplateTag, string>): Promise<string>;
-type TargetTemplate = {
+export type TargetTemplate = {
     fullPkg: string;
     subPkg: string;
     rootRoute: {
@@ -29,5 +29,5 @@ type TargetTemplate = {
         };
     };
 };
-export declare function getTargetTemplate(target: Config['target']): TargetTemplate;
+export declare function getTargetTemplate(config: Config): TargetTemplate;
 export {};

package/dist/cjs/transform/default-transform-plugin.cjs

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const recast = require("recast");
+const utils = require("./utils.cjs");
+const b = recast.types.builders;
+const defaultTransformPlugin = {
+  name: "default-transform",
+  exportName: "Route",
+  imports: (ctx) => {
+    const imports = {};
+    const targetModule = `@tanstack/${ctx.target}-router`;
+    if (ctx.verboseFileRoutes === false) {
+      imports.banned = [
+        {
+          source: targetModule,
+          specifiers: [
+            { imported: "createLazyFileRoute" },
+            { imported: "createFileRoute" }
+          ]
+        }
+      ];
+    } else {
+      if (ctx.lazy) {
+        imports.required = [
+          {
+            source: targetModule,
+            specifiers: [{ imported: "createLazyFileRoute" }]
+          }
+        ];
+        imports.banned = [
+          {
+            source: targetModule,
+            specifiers: [{ imported: "createFileRoute" }]
+          }
+        ];
+      } else {
+        imports.required = [
+          {
+            source: targetModule,
+            specifiers: [{ imported: "createFileRoute" }]
+          }
+        ];
+        imports.banned = [
+          {
+            source: targetModule,
+            specifiers: [{ imported: "createLazyFileRoute" }]
+          }
+        ];
+      }
+    }
+    return imports;
+  },
+  onExportFound: ({ decl, ctx }) => {
+    var _a;
+    let appliedChanges = false;
+    if (((_a = decl.init) == null ? void 0 : _a.type) === "CallExpression") {
+      const callExpression = decl.init;
+      let identifier;
+      if (callExpression.callee.type === "Identifier") {
+        identifier = callExpression.callee;
+        if (ctx.verboseFileRoutes) {
+          callExpression.callee = b.callExpression(identifier, [
+            b.stringLiteral(ctx.routeId)
+          ]);
+          appliedChanges = true;
+        }
+      } else if (callExpression.callee.type === "CallExpression" && callExpression.callee.callee.type === "Identifier") {
+        identifier = callExpression.callee.callee;
+        if (!ctx.verboseFileRoutes) {
+          callExpression.callee = identifier;
+          appliedChanges = true;
+        } else {
+          appliedChanges = utils.ensureStringArgument(
+            callExpression.callee,
+            ctx.routeId,
+            ctx.preferredQuote
+          );
+        }
+      }
+      if (identifier === void 0) {
+        throw new Error(`expected identifier to be present`);
+      }
+      if (identifier.name === "createFileRoute" && ctx.lazy) {
+        identifier.name = "createLazyFileRoute";
+        appliedChanges = true;
+      } else if (identifier.name === "createLazyFileRoute" && !ctx.lazy) {
+        identifier.name = "createFileRoute";
+        appliedChanges = true;
+      }
+    }
+    return appliedChanges;
+  }
+};
+exports.defaultTransformPlugin = defaultTransformPlugin;
+//# sourceMappingURL=default-transform-plugin.cjs.map

package/dist/cjs/transform/default-transform-plugin.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-transform-plugin.cjs","sources":["../../../src/transform/default-transform-plugin.ts"],"sourcesContent":["import { types } from 'recast'\nimport { ensureStringArgument } from './utils'\nimport type { TransformImportsConfig, TransformPlugin } from './types'\n\nconst b = types.builders\n\nexport const defaultTransformPlugin: TransformPlugin = {\n  name: 'default-transform',\n  exportName: 'Route',\n  imports: (ctx) => {\n    const imports: TransformImportsConfig = {}\n    const targetModule = `@tanstack/${ctx.target}-router`\n    if (ctx.verboseFileRoutes === false) {\n      imports.banned = [\n        {\n          source: targetModule,\n          specifiers: [\n            { imported: 'createLazyFileRoute' },\n            { imported: 'createFileRoute' },\n          ],\n        },\n      ]\n    } else {\n      if (ctx.lazy) {\n        imports.required = [\n          {\n            source: targetModule,\n            specifiers: [{ imported: 'createLazyFileRoute' }],\n          },\n        ]\n        imports.banned = [\n          {\n            source: targetModule,\n            specifiers: [{ imported: 'createFileRoute' }],\n          },\n        ]\n      } else {\n        imports.required = [\n          {\n            source: targetModule,\n            specifiers: [{ imported: 'createFileRoute' }],\n          },\n        ]\n        imports.banned = [\n          {\n            source: targetModule,\n            specifiers: [{ imported: 'createLazyFileRoute' }],\n          },\n        ]\n      }\n    }\n    return imports\n  },\n  onExportFound: ({ decl, ctx }) => {\n    let appliedChanges = false\n    if (decl.init?.type === 'CallExpression') {\n      const callExpression = decl.init\n      let identifier: types.namedTypes.Identifier | undefined\n      // `const Route = createFileRoute({ ... })`\n      if (callExpression.callee.type === 'Identifier') {\n        identifier = callExpression.callee\n        if (ctx.verboseFileRoutes) {\n          // we need to add the string literal via another CallExpression\n          callExpression.callee = b.callExpression(identifier, [\n            b.stringLiteral(ctx.routeId),\n          ])\n          appliedChanges = true\n        }\n      }\n      // `const Route = createFileRoute('/path')({ ... })`\n      else if (\n        callExpression.callee.type === 'CallExpression' &&\n        callExpression.callee.callee.type === 'Identifier'\n      ) {\n        identifier = callExpression.callee.callee\n        if (!ctx.verboseFileRoutes) {\n          // we need to remove the route id\n          callExpression.callee = identifier\n          appliedChanges = true\n        } else {\n          // check if the route id is correct\n          appliedChanges = ensureStringArgument(\n            callExpression.callee,\n            ctx.routeId,\n            ctx.preferredQuote,\n          )\n        }\n      }\n      if (identifier === undefined) {\n        throw new Error(`expected identifier to be present`)\n      }\n      if (identifier.name === 'createFileRoute' && ctx.lazy) {\n        identifier.name = 'createLazyFileRoute'\n        appliedChanges = true\n      } else if (identifier.name === 'createLazyFileRoute' && !ctx.lazy) {\n        identifier.name = 'createFileRoute'\n        appliedChanges = true\n      }\n    }\n\n    return appliedChanges\n  },\n}\n"],"names":["types","ensureStringArgument"],"mappings":";;;;AAIA,MAAM,IAAIA,OAAM,MAAA;AAET,MAAM,yBAA0C;AAAA,EACrD,MAAM;AAAA,EACN,YAAY;AAAA,EACZ,SAAS,CAAC,QAAQ;AAChB,UAAM,UAAkC,CAAC;AACnC,UAAA,eAAe,aAAa,IAAI,MAAM;AACxC,QAAA,IAAI,sBAAsB,OAAO;AACnC,cAAQ,SAAS;AAAA,QACf;AAAA,UACE,QAAQ;AAAA,UACR,YAAY;AAAA,YACV,EAAE,UAAU,sBAAsB;AAAA,YAClC,EAAE,UAAU,kBAAkB;AAAA,UAAA;AAAA,QAChC;AAAA,MAEJ;AAAA,IAAA,OACK;AACL,UAAI,IAAI,MAAM;AACZ,gBAAQ,WAAW;AAAA,UACjB;AAAA,YACE,QAAQ;AAAA,YACR,YAAY,CAAC,EAAE,UAAU,sBAAuB,CAAA;AAAA,UAAA;AAAA,QAEpD;AACA,gBAAQ,SAAS;AAAA,UACf;AAAA,YACE,QAAQ;AAAA,YACR,YAAY,CAAC,EAAE,UAAU,kBAAmB,CAAA;AAAA,UAAA;AAAA,QAEhD;AAAA,MAAA,OACK;AACL,gBAAQ,WAAW;AAAA,UACjB;AAAA,YACE,QAAQ;AAAA,YACR,YAAY,CAAC,EAAE,UAAU,kBAAmB,CAAA;AAAA,UAAA;AAAA,QAEhD;AACA,gBAAQ,SAAS;AAAA,UACf;AAAA,YACE,QAAQ;AAAA,YACR,YAAY,CAAC,EAAE,UAAU,sBAAuB,CAAA;AAAA,UAAA;AAAA,QAEpD;AAAA,MAAA;AAAA,IACF;AAEK,WAAA;AAAA,EACT;AAAA,EACA,eAAe,CAAC,EAAE,MAAM,UAAU;;AAChC,QAAI,iBAAiB;AACjB,UAAA,UAAK,SAAL,mBAAW,UAAS,kBAAkB;AACxC,YAAM,iBAAiB,KAAK;AACxB,UAAA;AAEA,UAAA,eAAe,OAAO,SAAS,cAAc;AAC/C,qBAAa,eAAe;AAC5B,YAAI,IAAI,mBAAmB;AAEV,yBAAA,SAAS,EAAE,eAAe,YAAY;AAAA,YACnD,EAAE,cAAc,IAAI,OAAO;AAAA,UAAA,CAC5B;AACgB,2BAAA;AAAA,QAAA;AAAA,MACnB,WAIA,eAAe,OAAO,SAAS,oBAC/B,eAAe,OAAO,OAAO,SAAS,cACtC;AACA,qBAAa,eAAe,OAAO;AAC/B,YAAA,CAAC,IAAI,mBAAmB;AAE1B,yBAAe,SAAS;AACP,2BAAA;AAAA,QAAA,OACZ;AAEY,2BAAAC,MAAA;AAAA,YACf,eAAe;AAAA,YACf,IAAI;AAAA,YACJ,IAAI;AAAA,UACN;AAAA,QAAA;AAAA,MACF;AAEF,UAAI,eAAe,QAAW;AACtB,cAAA,IAAI,MAAM,mCAAmC;AAAA,MAAA;AAErD,UAAI,WAAW,SAAS,qBAAqB,IAAI,MAAM;AACrD,mBAAW,OAAO;AACD,yBAAA;AAAA,MAAA,WACR,WAAW,SAAS,yBAAyB,CAAC,IAAI,MAAM;AACjE,mBAAW,OAAO;AACD,yBAAA;AAAA,MAAA;AAAA,IACnB;AAGK,WAAA;AAAA,EAAA;AAEX;;"}

package/dist/cjs/transform/default-transform-plugin.d.cts

@@ -0,0 +1,2 @@
+import { TransformPlugin } from './types.cjs';
+export declare const defaultTransformPlugin: TransformPlugin;

package/dist/cjs/transform/transform.cjs

@@ -0,0 +1,351 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const routerUtils = require("@tanstack/router-utils");
+const recast = require("recast");
+const sourceMap = require("source-map");
+const utils = require("../utils.cjs");
+const b = recast.types.builders;
+async function transform({
+  ctx,
+  source,
+  plugins
+}) {
+  var _a, _b, _c;
+  let appliedChanges = false;
+  let ast;
+  const foundExports = [];
+  try {
+    ast = recast.parse(source, {
+      sourceFileName: "output.ts",
+      parser: {
+        parse(code) {
+          return routerUtils.parseAst({
+            code,
+            // we need to instruct babel to produce tokens,
+            // otherwise recast will try to generate the tokens via its own parser and will fail
+            tokens: true
+          });
+        }
+      }
+    });
+  } catch (e) {
+    console.error("Error parsing code", ctx.routeId, source, e);
+    return {
+      result: "error",
+      error: e
+    };
+  }
+  const preferredQuote = detectPreferredQuoteStyle(ast);
+  const registeredExports = /* @__PURE__ */ new Map();
+  for (const plugin of plugins ?? []) {
+    const exportName = plugin.exportName;
+    if (registeredExports.has(exportName)) {
+      throw new Error(
+        `Export ${exportName} is already registered by plugin ${(_a = registeredExports.get(exportName)) == null ? void 0 : _a.name}`
+      );
+    }
+    registeredExports.set(exportName, plugin);
+  }
+  const program = ast.program;
+  for (const n of program.body) {
+    if (registeredExports.size > 0 && n.type === "ExportNamedDeclaration" && ((_b = n.declaration) == null ? void 0 : _b.type) === "VariableDeclaration") {
+      const decl = n.declaration.declarations[0];
+      if (decl && decl.type === "VariableDeclarator" && decl.id.type === "Identifier") {
+        const plugin = registeredExports.get(decl.id.name);
+        if (plugin) {
+          const pluginAppliedChanges = plugin.onExportFound({
+            decl,
+            ctx: { ...ctx, preferredQuote }
+          });
+          if (pluginAppliedChanges) {
+            appliedChanges = true;
+          }
+          registeredExports.delete(decl.id.name);
+          foundExports.push(decl.id.name);
+        }
+      }
+    }
+  }
+  const imports = {
+    required: [],
+    banned: []
+  };
+  for (const plugin of plugins ?? []) {
+    const exportName = plugin.exportName;
+    if (foundExports.includes(exportName)) {
+      const pluginImports = plugin.imports(ctx);
+      if (pluginImports.required) {
+        imports.required.push(...pluginImports.required);
+      }
+      if (pluginImports.banned) {
+        imports.banned.push(...pluginImports.banned);
+      }
+    }
+  }
+  imports.required = utils.mergeImportDeclarations(imports.required);
+  imports.banned = utils.mergeImportDeclarations(imports.banned);
+  const importStatementCandidates = [];
+  const importDeclarationsToRemove = [];
+  for (const n of program.body) {
+    const findImport = (opts) => (i) => {
+      if (i.source === opts.source) {
+        const importKind = i.importKind || "value";
+        const expectedImportKind = opts.importKind || "value";
+        return expectedImportKind === importKind;
+      }
+      return false;
+    };
+    if (n.type === "ImportDeclaration" && typeof n.source.value === "string") {
+      const filterImport = findImport({
+        source: n.source.value,
+        importKind: n.importKind
+      });
+      let requiredImports = imports.required.filter(filterImport)[0];
+      const bannedImports = imports.banned.filter(filterImport)[0];
+      if (!requiredImports && !bannedImports) {
+        continue;
+      }
+      const importSpecifiersToRemove = [];
+      if (n.specifiers) {
+        for (const spec of n.specifiers) {
+          if (!requiredImports && !bannedImports) {
+            break;
+          }
+          if (spec.type === "ImportSpecifier" && typeof spec.imported.name === "string") {
+            if (requiredImports) {
+              const requiredImportIndex = requiredImports.specifiers.findIndex(
+                (imp) => imp.imported === spec.imported.name
+              );
+              if (requiredImportIndex !== -1) {
+                requiredImports.specifiers.splice(requiredImportIndex, 1);
+                if (requiredImports.specifiers.length === 0) {
+                  imports.required = imports.required.splice(
+                    imports.required.indexOf(requiredImports),
+                    1
+                  );
+                  requiredImports = void 0;
+                }
+              } else {
+                importStatementCandidates.push(n);
+              }
+            }
+            if (bannedImports) {
+              const bannedImportIndex = bannedImports.specifiers.findIndex(
+                (imp) => imp.imported === spec.imported.name
+              );
+              if (bannedImportIndex !== -1) {
+                importSpecifiersToRemove.push(spec);
+              }
+            }
+          }
+        }
+        if (importSpecifiersToRemove.length > 0) {
+          appliedChanges = true;
+          n.specifiers = n.specifiers.filter(
+            (spec) => !importSpecifiersToRemove.includes(spec)
+          );
+          if (n.specifiers.length === 0) {
+            importDeclarationsToRemove.push(n);
+          }
+        }
+      }
+    }
+  }
+  imports.required.forEach((requiredImport) => {
+    if (requiredImport.specifiers.length > 0) {
+      appliedChanges = true;
+      if (importStatementCandidates.length > 0) {
+        const importStatement2 = importStatementCandidates.find(
+          (importStatement3) => {
+            if (importStatement3.source.value === requiredImport.source) {
+              const importKind = importStatement3.importKind || "value";
+              const requiredImportKind = requiredImport.importKind || "value";
+              return importKind === requiredImportKind;
+            }
+            return false;
+          }
+        );
+        if (importStatement2) {
+          if (importStatement2.specifiers === void 0) {
+            importStatement2.specifiers = [];
+          }
+          const importSpecifiersToAdd = requiredImport.specifiers.map(
+            (spec) => b.importSpecifier(
+              b.identifier(spec.imported),
+              b.identifier(spec.imported)
+            )
+          );
+          importStatement2.specifiers = [
+            ...importStatement2.specifiers,
+            ...importSpecifiersToAdd
+          ];
+          return;
+        }
+      }
+      const importStatement = b.importDeclaration(
+        requiredImport.specifiers.map(
+          (spec) => b.importSpecifier(
+            b.identifier(spec.imported),
+            spec.local ? b.identifier(spec.local) : null
+          )
+        ),
+        b.stringLiteral(requiredImport.source)
+      );
+      program.body.unshift(importStatement);
+    }
+  });
+  if (importDeclarationsToRemove.length > 0) {
+    appliedChanges = true;
+    for (const importDeclaration of importDeclarationsToRemove) {
+      if (((_c = importDeclaration.specifiers) == null ? void 0 : _c.length) === 0) {
+        const index = program.body.indexOf(importDeclaration);
+        if (index !== -1) {
+          program.body.splice(index, 1);
+        }
+      }
+    }
+  }
+  if (!appliedChanges) {
+    return {
+      exports: foundExports,
+      result: "not-modified"
+    };
+  }
+  const printResult = recast.print(ast, {
+    reuseWhitespace: true,
+    sourceMapName: "output.map"
+  });
+  let transformedCode = printResult.code;
+  if (printResult.map) {
+    const fixedOutput = await fixTransformedOutputText({
+      originalCode: source,
+      transformedCode,
+      sourceMap: printResult.map,
+      preferredQuote
+    });
+    transformedCode = fixedOutput;
+  }
+  return {
+    result: "modified",
+    exports: foundExports,
+    output: transformedCode
+  };
+}
+async function fixTransformedOutputText({
+  originalCode,
+  transformedCode,
+  sourceMap: sourceMap$1,
+  preferredQuote
+}) {
+  const originalLines = originalCode.split("\n");
+  const transformedLines = transformedCode.split("\n");
+  const defaultUsesSemicolons = detectSemicolonUsage(originalCode);
+  const consumer = await new sourceMap.SourceMapConsumer(sourceMap$1);
+  const fixedLines = transformedLines.map((line, i) => {
+    const transformedLineNum = i + 1;
+    let origLineText = void 0;
+    for (let col = 0; col < line.length; col++) {
+      const mapped = consumer.originalPositionFor({
+        line: transformedLineNum,
+        column: col
+      });
+      if (mapped.line != null && mapped.line > 0) {
+        origLineText = originalLines[mapped.line - 1];
+        break;
+      }
+    }
+    if (origLineText !== void 0) {
+      if (origLineText === line) {
+        return origLineText;
+      }
+      return fixLine(line, {
+        originalLine: origLineText,
+        useOriginalSemicolon: true,
+        useOriginalQuotes: true,
+        fallbackQuote: preferredQuote
+      });
+    } else {
+      return fixLine(line, {
+        originalLine: null,
+        useOriginalSemicolon: false,
+        useOriginalQuotes: false,
+        fallbackQuote: preferredQuote,
+        fallbackSemicolon: defaultUsesSemicolons
+      });
+    }
+  });
+  return fixedLines.join("\n");
+}
+function fixLine(line, {
+  originalLine,
+  useOriginalSemicolon,
+  useOriginalQuotes,
+  fallbackQuote,
+  fallbackSemicolon = true
+}) {
+  let result = line;
+  if (useOriginalQuotes && originalLine) {
+    result = fixQuotes(result, originalLine, fallbackQuote);
+  } else if (!useOriginalQuotes && fallbackQuote) {
+    result = fixQuotesToPreferred(result, fallbackQuote);
+  }
+  if (useOriginalSemicolon && originalLine) {
+    const hadSemicolon = originalLine.trimEnd().endsWith(";");
+    const hasSemicolon = result.trimEnd().endsWith(";");
+    if (hadSemicolon && !hasSemicolon) result += ";";
+    if (!hadSemicolon && hasSemicolon) result = result.replace(/;\s*$/, "");
+  } else if (!useOriginalSemicolon) {
+    const hasSemicolon = result.trimEnd().endsWith(";");
+    if (!fallbackSemicolon && hasSemicolon) result = result.replace(/;\s*$/, "");
+    if (fallbackSemicolon && !hasSemicolon && result.trim()) result += ";";
+  }
+  return result;
+}
+function fixQuotes(line, originalLine, fallbackQuote) {
+  let originalQuote = detectQuoteFromLine(originalLine);
+  if (!originalQuote) {
+    originalQuote = fallbackQuote;
+  }
+  return fixQuotesToPreferred(line, originalQuote);
+}
+function fixQuotesToPreferred(line, quote) {
+  return line.replace(
+    /(['"`])([^'"`\\]*(?:\\.[^'"`\\]*)*)\1/g,
+    (_, q, content) => {
+      const escaped = content.replaceAll(quote, `\\${quote}`);
+      return `${quote}${escaped}${quote}`;
+    }
+  );
+}
+function detectQuoteFromLine(line) {
+  const match = line.match(/(['"`])(?:\\.|[^\\])*?\1/);
+  return match ? match[1] : null;
+}
+function detectSemicolonUsage(code) {
+  const lines = code.split("\n").map((l) => l.trim());
+  const total = lines.length;
+  const withSemis = lines.filter((l) => l.endsWith(";")).length;
+  return withSemis > total / 2;
+}
+function detectPreferredQuoteStyle(ast) {
+  let single = 0;
+  let double = 0;
+  recast.visit(ast, {
+    visitStringLiteral(path) {
+      var _a;
+      if (path.parent.node.type !== "JSXAttribute") {
+        const raw = (_a = path.node.extra) == null ? void 0 : _a.raw;
+        if (raw == null ? void 0 : raw.startsWith("'")) single++;
+        else if (raw == null ? void 0 : raw.startsWith('"')) double++;
+      }
+      return false;
+    }
+  });
+  if (single >= double) {
+    return "'";
+  }
+  return '"';
+}
+exports.detectPreferredQuoteStyle = detectPreferredQuoteStyle;
+exports.transform = transform;
+//# sourceMappingURL=transform.cjs.map