@benjavicente/router-generator 1.166.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/LICENSE +21 -0
  2. package/dist/cjs/_virtual/_rolldown/runtime.cjs +23 -0
  3. package/dist/cjs/config.cjs +134 -0
  4. package/dist/cjs/config.cjs.map +1 -0
  5. package/dist/cjs/config.d.cts +254 -0
  6. package/dist/cjs/filesystem/physical/getRouteNodes.cjs +234 -0
  7. package/dist/cjs/filesystem/physical/getRouteNodes.cjs.map +1 -0
  8. package/dist/cjs/filesystem/physical/getRouteNodes.d.cts +25 -0
  9. package/dist/cjs/filesystem/physical/rootPathId.cjs +6 -0
  10. package/dist/cjs/filesystem/physical/rootPathId.cjs.map +1 -0
  11. package/dist/cjs/filesystem/physical/rootPathId.d.cts +1 -0
  12. package/dist/cjs/filesystem/virtual/config.cjs +39 -0
  13. package/dist/cjs/filesystem/virtual/config.cjs.map +1 -0
  14. package/dist/cjs/filesystem/virtual/config.d.cts +3 -0
  15. package/dist/cjs/filesystem/virtual/getRouteNodes.cjs +175 -0
  16. package/dist/cjs/filesystem/virtual/getRouteNodes.cjs.map +1 -0
  17. package/dist/cjs/filesystem/virtual/getRouteNodes.d.cts +9 -0
  18. package/dist/cjs/filesystem/virtual/loadConfigFile.cjs +12 -0
  19. package/dist/cjs/filesystem/virtual/loadConfigFile.cjs.map +1 -0
  20. package/dist/cjs/filesystem/virtual/loadConfigFile.d.cts +1 -0
  21. package/dist/cjs/generator.cjs +805 -0
  22. package/dist/cjs/generator.cjs.map +1 -0
  23. package/dist/cjs/generator.d.cts +116 -0
  24. package/dist/cjs/index.cjs +33 -0
  25. package/dist/cjs/index.d.cts +12 -0
  26. package/dist/cjs/logger.cjs +31 -0
  27. package/dist/cjs/logger.cjs.map +1 -0
  28. package/dist/cjs/logger.d.cts +10 -0
  29. package/dist/cjs/plugin/types.d.cts +18 -0
  30. package/dist/cjs/template.cjs +203 -0
  31. package/dist/cjs/template.cjs.map +1 -0
  32. package/dist/cjs/template.d.cts +34 -0
  33. package/dist/cjs/transform/transform.cjs +302 -0
  34. package/dist/cjs/transform/transform.cjs.map +1 -0
  35. package/dist/cjs/transform/transform.d.cts +4 -0
  36. package/dist/cjs/transform/types.d.cts +31 -0
  37. package/dist/cjs/transform/utils.cjs +34 -0
  38. package/dist/cjs/transform/utils.cjs.map +1 -0
  39. package/dist/cjs/transform/utils.d.cts +2 -0
  40. package/dist/cjs/types.d.cts +57 -0
  41. package/dist/cjs/utils.cjs +653 -0
  42. package/dist/cjs/utils.cjs.map +1 -0
  43. package/dist/cjs/utils.d.cts +212 -0
  44. package/dist/cjs/validate-route-params.cjs +73 -0
  45. package/dist/cjs/validate-route-params.cjs.map +1 -0
  46. package/dist/cjs/validate-route-params.d.cts +9 -0
  47. package/dist/esm/config.d.ts +254 -0
  48. package/dist/esm/config.js +129 -0
  49. package/dist/esm/config.js.map +1 -0
  50. package/dist/esm/filesystem/physical/getRouteNodes.d.ts +25 -0
  51. package/dist/esm/filesystem/physical/getRouteNodes.js +230 -0
  52. package/dist/esm/filesystem/physical/getRouteNodes.js.map +1 -0
  53. package/dist/esm/filesystem/physical/rootPathId.d.ts +1 -0
  54. package/dist/esm/filesystem/physical/rootPathId.js +6 -0
  55. package/dist/esm/filesystem/physical/rootPathId.js.map +1 -0
  56. package/dist/esm/filesystem/virtual/config.d.ts +3 -0
  57. package/dist/esm/filesystem/virtual/config.js +38 -0
  58. package/dist/esm/filesystem/virtual/config.js.map +1 -0
  59. package/dist/esm/filesystem/virtual/getRouteNodes.d.ts +9 -0
  60. package/dist/esm/filesystem/virtual/getRouteNodes.js +173 -0
  61. package/dist/esm/filesystem/virtual/getRouteNodes.js.map +1 -0
  62. package/dist/esm/filesystem/virtual/loadConfigFile.d.ts +1 -0
  63. package/dist/esm/filesystem/virtual/loadConfigFile.js +11 -0
  64. package/dist/esm/filesystem/virtual/loadConfigFile.js.map +1 -0
  65. package/dist/esm/generator.d.ts +116 -0
  66. package/dist/esm/generator.js +801 -0
  67. package/dist/esm/generator.js.map +1 -0
  68. package/dist/esm/index.d.ts +12 -0
  69. package/dist/esm/index.js +8 -0
  70. package/dist/esm/logger.d.ts +10 -0
  71. package/dist/esm/logger.js +31 -0
  72. package/dist/esm/logger.js.map +1 -0
  73. package/dist/esm/plugin/types.d.ts +18 -0
  74. package/dist/esm/template.d.ts +34 -0
  75. package/dist/esm/template.js +202 -0
  76. package/dist/esm/template.js.map +1 -0
  77. package/dist/esm/transform/transform.d.ts +4 -0
  78. package/dist/esm/transform/transform.js +301 -0
  79. package/dist/esm/transform/transform.js.map +1 -0
  80. package/dist/esm/transform/types.d.ts +31 -0
  81. package/dist/esm/transform/utils.d.ts +2 -0
  82. package/dist/esm/transform/utils.js +34 -0
  83. package/dist/esm/transform/utils.js.map +1 -0
  84. package/dist/esm/types.d.ts +57 -0
  85. package/dist/esm/utils.d.ts +212 -0
  86. package/dist/esm/utils.js +609 -0
  87. package/dist/esm/utils.js.map +1 -0
  88. package/dist/esm/validate-route-params.d.ts +9 -0
  89. package/dist/esm/validate-route-params.js +73 -0
  90. package/dist/esm/validate-route-params.js.map +1 -0
  91. package/package.json +82 -0
  92. package/src/config.ts +247 -0
  93. package/src/filesystem/physical/getRouteNodes.ts +541 -0
  94. package/src/filesystem/physical/rootPathId.ts +1 -0
  95. package/src/filesystem/virtual/config.ts +45 -0
  96. package/src/filesystem/virtual/getRouteNodes.ts +307 -0
  97. package/src/filesystem/virtual/loadConfigFile.ts +8 -0
  98. package/src/generator.ts +1686 -0
  99. package/src/index.ts +54 -0
  100. package/src/logger.ts +43 -0
  101. package/src/plugin/types.ts +18 -0
  102. package/src/template.ts +313 -0
  103. package/src/transform/transform.ts +534 -0
  104. package/src/transform/types.ts +39 -0
  105. package/src/transform/utils.ts +42 -0
  106. package/src/types.ts +74 -0
  107. package/src/utils.ts +1067 -0
  108. package/src/validate-route-params.ts +118 -0
@@ -0,0 +1,254 @@
1
+ import { z } from 'zod';
2
+ import { GeneratorPlugin } from './plugin/types.js';
3
+ declare const tokenJsonRegexSchema: z.ZodObject<{
4
+ regex: z.ZodString;
5
+ flags: z.ZodOptional<z.ZodString>;
6
+ }, "strip", z.ZodTypeAny, {
7
+ regex: string;
8
+ flags?: string | undefined;
9
+ }, {
10
+ regex: string;
11
+ flags?: string | undefined;
12
+ }>;
13
+ declare const tokenMatcherSchema: z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>, z.ZodObject<{
14
+ regex: z.ZodString;
15
+ flags: z.ZodOptional<z.ZodString>;
16
+ }, "strip", z.ZodTypeAny, {
17
+ regex: string;
18
+ flags?: string | undefined;
19
+ }, {
20
+ regex: string;
21
+ flags?: string | undefined;
22
+ }>]>;
23
+ export type TokenMatcherJson = string | z.infer<typeof tokenJsonRegexSchema>;
24
+ export type TokenMatcher = z.infer<typeof tokenMatcherSchema>;
25
+ export declare const baseConfigSchema: z.ZodObject<{
26
+ target: z.ZodDefault<z.ZodOptional<z.ZodEnum<["react", "solid", "vue", "angular"]>>>;
27
+ virtualRouteConfig: z.ZodOptional<z.ZodUnion<[z.ZodType<import('@benjavicente/virtual-file-routes').VirtualRootRoute, z.ZodTypeDef, import('@benjavicente/virtual-file-routes').VirtualRootRoute>, z.ZodString]>>;
28
+ routeFilePrefix: z.ZodOptional<z.ZodString>;
29
+ routeFileIgnorePrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
30
+ routeFileIgnorePattern: z.ZodOptional<z.ZodString>;
31
+ routesDirectory: z.ZodDefault<z.ZodOptional<z.ZodString>>;
32
+ quoteStyle: z.ZodDefault<z.ZodOptional<z.ZodEnum<["single", "double"]>>>;
33
+ semicolons: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
34
+ disableLogging: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
35
+ routeTreeFileHeader: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
36
+ indexToken: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>, z.ZodObject<{
37
+ regex: z.ZodString;
38
+ flags: z.ZodOptional<z.ZodString>;
39
+ }, "strip", z.ZodTypeAny, {
40
+ regex: string;
41
+ flags?: string | undefined;
42
+ }, {
43
+ regex: string;
44
+ flags?: string | undefined;
45
+ }>]>>>;
46
+ routeToken: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>, z.ZodObject<{
47
+ regex: z.ZodString;
48
+ flags: z.ZodOptional<z.ZodString>;
49
+ }, "strip", z.ZodTypeAny, {
50
+ regex: string;
51
+ flags?: string | undefined;
52
+ }, {
53
+ regex: string;
54
+ flags?: string | undefined;
55
+ }>]>>>;
56
+ pathParamsAllowedCharacters: z.ZodOptional<z.ZodArray<z.ZodEnum<[";", ":", "@", "&", "=", "+", "$", ","]>, "many">>;
57
+ }, "strip", z.ZodTypeAny, {
58
+ target: "angular" | "vue" | "react" | "solid";
59
+ routeFileIgnorePrefix: string;
60
+ routesDirectory: string;
61
+ quoteStyle: "single" | "double";
62
+ semicolons: boolean;
63
+ disableLogging: boolean;
64
+ routeTreeFileHeader: string[];
65
+ indexToken: string | RegExp | {
66
+ regex: string;
67
+ flags?: string | undefined;
68
+ };
69
+ routeToken: string | RegExp | {
70
+ regex: string;
71
+ flags?: string | undefined;
72
+ };
73
+ virtualRouteConfig?: string | import('@benjavicente/virtual-file-routes').VirtualRootRoute | undefined;
74
+ routeFilePrefix?: string | undefined;
75
+ routeFileIgnorePattern?: string | undefined;
76
+ pathParamsAllowedCharacters?: (":" | "$" | ";" | "@" | "&" | "=" | "+" | ",")[] | undefined;
77
+ }, {
78
+ target?: "angular" | "vue" | "react" | "solid" | undefined;
79
+ virtualRouteConfig?: string | import('@benjavicente/virtual-file-routes').VirtualRootRoute | undefined;
80
+ routeFilePrefix?: string | undefined;
81
+ routeFileIgnorePrefix?: string | undefined;
82
+ routeFileIgnorePattern?: string | undefined;
83
+ routesDirectory?: string | undefined;
84
+ quoteStyle?: "single" | "double" | undefined;
85
+ semicolons?: boolean | undefined;
86
+ disableLogging?: boolean | undefined;
87
+ routeTreeFileHeader?: string[] | undefined;
88
+ indexToken?: string | RegExp | {
89
+ regex: string;
90
+ flags?: string | undefined;
91
+ } | undefined;
92
+ routeToken?: string | RegExp | {
93
+ regex: string;
94
+ flags?: string | undefined;
95
+ } | undefined;
96
+ pathParamsAllowedCharacters?: (":" | "$" | ";" | "@" | "&" | "=" | "+" | ",")[] | undefined;
97
+ }>;
98
+ export type BaseConfig = z.infer<typeof baseConfigSchema>;
99
+ export declare const configSchema: z.ZodObject<{
100
+ target: z.ZodDefault<z.ZodOptional<z.ZodEnum<["react", "solid", "vue", "angular"]>>>;
101
+ virtualRouteConfig: z.ZodOptional<z.ZodUnion<[z.ZodType<import('@benjavicente/virtual-file-routes').VirtualRootRoute, z.ZodTypeDef, import('@benjavicente/virtual-file-routes').VirtualRootRoute>, z.ZodString]>>;
102
+ routeFilePrefix: z.ZodOptional<z.ZodString>;
103
+ routeFileIgnorePrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
104
+ routeFileIgnorePattern: z.ZodOptional<z.ZodString>;
105
+ routesDirectory: z.ZodDefault<z.ZodOptional<z.ZodString>>;
106
+ quoteStyle: z.ZodDefault<z.ZodOptional<z.ZodEnum<["single", "double"]>>>;
107
+ semicolons: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
108
+ disableLogging: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
109
+ routeTreeFileHeader: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
110
+ indexToken: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>, z.ZodObject<{
111
+ regex: z.ZodString;
112
+ flags: z.ZodOptional<z.ZodString>;
113
+ }, "strip", z.ZodTypeAny, {
114
+ regex: string;
115
+ flags?: string | undefined;
116
+ }, {
117
+ regex: string;
118
+ flags?: string | undefined;
119
+ }>]>>>;
120
+ routeToken: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>, z.ZodObject<{
121
+ regex: z.ZodString;
122
+ flags: z.ZodOptional<z.ZodString>;
123
+ }, "strip", z.ZodTypeAny, {
124
+ regex: string;
125
+ flags?: string | undefined;
126
+ }, {
127
+ regex: string;
128
+ flags?: string | undefined;
129
+ }>]>>>;
130
+ pathParamsAllowedCharacters: z.ZodOptional<z.ZodArray<z.ZodEnum<[";", ":", "@", "&", "=", "+", "$", ","]>, "many">>;
131
+ } & {
132
+ generatedRouteTree: z.ZodDefault<z.ZodOptional<z.ZodString>>;
133
+ disableTypes: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
134
+ verboseFileRoutes: z.ZodOptional<z.ZodBoolean>;
135
+ addExtensions: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>>, string | boolean, string | boolean | undefined>;
136
+ enableRouteTreeFormatting: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
137
+ routeTreeFileFooter: z.ZodOptional<z.ZodUnion<[z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodArray<z.ZodString, "many">>]>>;
138
+ autoCodeSplitting: z.ZodOptional<z.ZodBoolean>;
139
+ customScaffolding: z.ZodOptional<z.ZodObject<{
140
+ routeTemplate: z.ZodOptional<z.ZodString>;
141
+ lazyRouteTemplate: z.ZodOptional<z.ZodString>;
142
+ }, "strip", z.ZodTypeAny, {
143
+ routeTemplate?: string | undefined;
144
+ lazyRouteTemplate?: string | undefined;
145
+ }, {
146
+ routeTemplate?: string | undefined;
147
+ lazyRouteTemplate?: string | undefined;
148
+ }>>;
149
+ experimental: z.ZodOptional<z.ZodObject<{
150
+ enableCodeSplitting: z.ZodOptional<z.ZodBoolean>;
151
+ }, "strip", z.ZodTypeAny, {
152
+ enableCodeSplitting?: boolean | undefined;
153
+ }, {
154
+ enableCodeSplitting?: boolean | undefined;
155
+ }>>;
156
+ plugins: z.ZodOptional<z.ZodArray<z.ZodType<GeneratorPlugin, z.ZodTypeDef, GeneratorPlugin>, "many">>;
157
+ /**
158
+ * When `target` is `angular`, use this package in generated route imports and
159
+ * `FileRoutesByPath` augmentation (default `@benjavicente/angular-router-experimental`).
160
+ */
161
+ angularRouterPackage: z.ZodOptional<z.ZodString>;
162
+ /**
163
+ * When `target` is `angular`, use this package in the Start `declare module` block
164
+ * appended to the route tree (default `@benjavicente/angular-start-experimental`).
165
+ */
166
+ angularStartPackage: z.ZodOptional<z.ZodString>;
167
+ tmpDir: z.ZodDefault<z.ZodOptional<z.ZodString>>;
168
+ importRoutesUsingAbsolutePaths: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
169
+ }, "strip", z.ZodTypeAny, {
170
+ target: "angular" | "vue" | "react" | "solid";
171
+ routeFileIgnorePrefix: string;
172
+ routesDirectory: string;
173
+ quoteStyle: "single" | "double";
174
+ semicolons: boolean;
175
+ disableLogging: boolean;
176
+ routeTreeFileHeader: string[];
177
+ indexToken: string | RegExp | {
178
+ regex: string;
179
+ flags?: string | undefined;
180
+ };
181
+ routeToken: string | RegExp | {
182
+ regex: string;
183
+ flags?: string | undefined;
184
+ };
185
+ generatedRouteTree: string;
186
+ disableTypes: boolean;
187
+ addExtensions: string | boolean;
188
+ enableRouteTreeFormatting: boolean;
189
+ tmpDir: string;
190
+ importRoutesUsingAbsolutePaths: boolean;
191
+ plugins?: GeneratorPlugin[] | undefined;
192
+ virtualRouteConfig?: string | import('@benjavicente/virtual-file-routes').VirtualRootRoute | undefined;
193
+ routeFilePrefix?: string | undefined;
194
+ routeFileIgnorePattern?: string | undefined;
195
+ pathParamsAllowedCharacters?: (":" | "$" | ";" | "@" | "&" | "=" | "+" | ",")[] | undefined;
196
+ verboseFileRoutes?: boolean | undefined;
197
+ routeTreeFileFooter?: string[] | ((...args: unknown[]) => string[]) | undefined;
198
+ autoCodeSplitting?: boolean | undefined;
199
+ customScaffolding?: {
200
+ routeTemplate?: string | undefined;
201
+ lazyRouteTemplate?: string | undefined;
202
+ } | undefined;
203
+ experimental?: {
204
+ enableCodeSplitting?: boolean | undefined;
205
+ } | undefined;
206
+ angularRouterPackage?: string | undefined;
207
+ angularStartPackage?: string | undefined;
208
+ }, {
209
+ plugins?: GeneratorPlugin[] | undefined;
210
+ target?: "angular" | "vue" | "react" | "solid" | undefined;
211
+ virtualRouteConfig?: string | import('@benjavicente/virtual-file-routes').VirtualRootRoute | undefined;
212
+ routeFilePrefix?: string | undefined;
213
+ routeFileIgnorePrefix?: string | undefined;
214
+ routeFileIgnorePattern?: string | undefined;
215
+ routesDirectory?: string | undefined;
216
+ quoteStyle?: "single" | "double" | undefined;
217
+ semicolons?: boolean | undefined;
218
+ disableLogging?: boolean | undefined;
219
+ routeTreeFileHeader?: string[] | undefined;
220
+ indexToken?: string | RegExp | {
221
+ regex: string;
222
+ flags?: string | undefined;
223
+ } | undefined;
224
+ routeToken?: string | RegExp | {
225
+ regex: string;
226
+ flags?: string | undefined;
227
+ } | undefined;
228
+ pathParamsAllowedCharacters?: (":" | "$" | ";" | "@" | "&" | "=" | "+" | ",")[] | undefined;
229
+ generatedRouteTree?: string | undefined;
230
+ disableTypes?: boolean | undefined;
231
+ verboseFileRoutes?: boolean | undefined;
232
+ addExtensions?: string | boolean | undefined;
233
+ enableRouteTreeFormatting?: boolean | undefined;
234
+ routeTreeFileFooter?: string[] | ((...args: unknown[]) => string[]) | undefined;
235
+ autoCodeSplitting?: boolean | undefined;
236
+ customScaffolding?: {
237
+ routeTemplate?: string | undefined;
238
+ lazyRouteTemplate?: string | undefined;
239
+ } | undefined;
240
+ experimental?: {
241
+ enableCodeSplitting?: boolean | undefined;
242
+ } | undefined;
243
+ angularRouterPackage?: string | undefined;
244
+ angularStartPackage?: string | undefined;
245
+ tmpDir?: string | undefined;
246
+ importRoutesUsingAbsolutePaths?: boolean | undefined;
247
+ }>;
248
+ export type Config = z.infer<typeof configSchema>;
249
+ type ResolveParams = {
250
+ configDirectory: string;
251
+ };
252
+ export declare function resolveConfigPath({ configDirectory }: ResolveParams): string;
253
+ export declare function getConfig(inlineConfig?: Partial<Config>, configDirectory?: string): Config;
254
+ export {};
@@ -0,0 +1,129 @@
1
+ import { virtualRootRouteSchema } from "./filesystem/virtual/config.js";
2
+ import path from "node:path";
3
+ import { existsSync, readFileSync } from "node:fs";
4
+ import { z } from "zod";
5
+ //#region src/config.ts
6
+ var tokenJsonRegexSchema = z.object({
7
+ regex: z.string(),
8
+ flags: z.string().optional()
9
+ });
10
+ var tokenMatcherSchema = z.union([
11
+ z.string(),
12
+ z.instanceof(RegExp),
13
+ tokenJsonRegexSchema
14
+ ]);
15
+ var baseConfigSchema = z.object({
16
+ target: z.enum([
17
+ "react",
18
+ "solid",
19
+ "vue",
20
+ "angular"
21
+ ]).optional().default("react"),
22
+ virtualRouteConfig: virtualRootRouteSchema.or(z.string()).optional(),
23
+ routeFilePrefix: z.string().optional(),
24
+ routeFileIgnorePrefix: z.string().optional().default("-"),
25
+ routeFileIgnorePattern: z.string().optional(),
26
+ routesDirectory: z.string().optional().default("./src/routes"),
27
+ quoteStyle: z.enum(["single", "double"]).optional().default("single"),
28
+ semicolons: z.boolean().optional().default(false),
29
+ disableLogging: z.boolean().optional().default(false),
30
+ routeTreeFileHeader: z.array(z.string()).optional().default([
31
+ "/* eslint-disable */",
32
+ "// @ts-nocheck",
33
+ "// noinspection JSUnusedGlobalSymbols"
34
+ ]),
35
+ indexToken: tokenMatcherSchema.optional().default("index"),
36
+ routeToken: tokenMatcherSchema.optional().default("route"),
37
+ pathParamsAllowedCharacters: z.array(z.enum([
38
+ ";",
39
+ ":",
40
+ "@",
41
+ "&",
42
+ "=",
43
+ "+",
44
+ "$",
45
+ ","
46
+ ])).optional()
47
+ });
48
+ var configSchema = baseConfigSchema.extend({
49
+ generatedRouteTree: z.string().optional().default("./src/routeTree.gen.ts"),
50
+ disableTypes: z.boolean().optional().default(false),
51
+ verboseFileRoutes: z.boolean().optional(),
52
+ addExtensions: z.union([z.boolean(), z.string()]).optional().default(false).transform((v) => typeof v === "string" ? v.startsWith(".") ? v : `.${v}` : v),
53
+ enableRouteTreeFormatting: z.boolean().optional().default(true),
54
+ routeTreeFileFooter: z.union([z.array(z.string()).optional().default([]), z.function().returns(z.array(z.string()))]).optional(),
55
+ autoCodeSplitting: z.boolean().optional(),
56
+ customScaffolding: z.object({
57
+ routeTemplate: z.string().optional(),
58
+ lazyRouteTemplate: z.string().optional()
59
+ }).optional(),
60
+ experimental: z.object({ enableCodeSplitting: z.boolean().optional() }).optional(),
61
+ plugins: z.array(z.custom()).optional(),
62
+ angularRouterPackage: z.string().optional(),
63
+ angularStartPackage: z.string().optional(),
64
+ tmpDir: z.string().optional().default(""),
65
+ importRoutesUsingAbsolutePaths: z.boolean().optional().default(false)
66
+ });
67
+ function resolveConfigPath({ configDirectory }) {
68
+ return path.resolve(configDirectory, "tsr.config.json");
69
+ }
70
+ function getConfig(inlineConfig = {}, configDirectory) {
71
+ if (configDirectory === void 0) configDirectory = process.cwd();
72
+ const configFilePathJson = resolveConfigPath({ configDirectory });
73
+ const exists = existsSync(configFilePathJson);
74
+ let config;
75
+ if (exists) {
76
+ const merged = {
77
+ ...JSON.parse(readFileSync(configFilePathJson, "utf-8")),
78
+ ...inlineConfig
79
+ };
80
+ config = configSchema.parse(merged);
81
+ } else config = configSchema.parse(inlineConfig);
82
+ if (config.disableTypes) config.generatedRouteTree = config.generatedRouteTree.replace(/\.(ts|tsx)$/, ".js");
83
+ if (configDirectory) if (path.isAbsolute(configDirectory)) {
84
+ config.routesDirectory = path.resolve(configDirectory, config.routesDirectory);
85
+ config.generatedRouteTree = path.resolve(configDirectory, config.generatedRouteTree);
86
+ } else {
87
+ config.routesDirectory = path.resolve(process.cwd(), configDirectory, config.routesDirectory);
88
+ config.generatedRouteTree = path.resolve(process.cwd(), configDirectory, config.generatedRouteTree);
89
+ }
90
+ const resolveTmpDir = (dir) => {
91
+ if (Array.isArray(dir)) dir = path.join(...dir);
92
+ if (!path.isAbsolute(dir)) dir = path.resolve(process.cwd(), dir);
93
+ return dir;
94
+ };
95
+ if (config.tmpDir) config.tmpDir = resolveTmpDir(config.tmpDir);
96
+ else if (process.env.TSR_TMP_DIR) config.tmpDir = resolveTmpDir(process.env.TSR_TMP_DIR);
97
+ else config.tmpDir = resolveTmpDir([".tanstack", "tmp"]);
98
+ validateConfig(config);
99
+ return config;
100
+ }
101
+ function validateConfig(config) {
102
+ if (typeof config.experimental?.enableCodeSplitting !== "undefined") {
103
+ const message = `
104
+ ------
105
+ ⚠️ ⚠️ ⚠️
106
+ ERROR: The "experimental.enableCodeSplitting" flag has been made stable and is now "autoCodeSplitting". Please update your configuration file to use "autoCodeSplitting" instead of "experimental.enableCodeSplitting".
107
+ ------
108
+ `;
109
+ console.error(message);
110
+ throw new Error(message);
111
+ }
112
+ if (areTokensEqual(config.indexToken, config.routeToken)) throw new Error(`The "indexToken" and "routeToken" options must be different.`);
113
+ if (config.routeFileIgnorePrefix && config.routeFileIgnorePrefix.trim() === "_") throw new Error(`The "routeFileIgnorePrefix" cannot be an underscore ("_"). This is a reserved character used to denote a pathless route. Please use a different prefix.`);
114
+ return config;
115
+ }
116
+ /**
117
+ * Compares two token matchers for equality.
118
+ * Handles strings, RegExp instances, and JSON regex objects.
119
+ */
120
+ function areTokensEqual(a, b) {
121
+ if (typeof a === "string" && typeof b === "string") return a === b;
122
+ if (a instanceof RegExp && b instanceof RegExp) return a.source === b.source && a.flags === b.flags;
123
+ if (typeof a === "object" && "regex" in a && typeof b === "object" && "regex" in b) return a.regex === b.regex && (a.flags ?? "") === (b.flags ?? "");
124
+ return false;
125
+ }
126
+ //#endregion
127
+ export { baseConfigSchema, configSchema, getConfig, resolveConfigPath };
128
+
129
+ //# sourceMappingURL=config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.js","names":[],"sources":["../../src/config.ts"],"sourcesContent":["import path from 'node:path'\nimport { existsSync, readFileSync } from 'node:fs'\nimport { z } from 'zod'\nimport { virtualRootRouteSchema } from './filesystem/virtual/config'\nimport type { GeneratorPlugin } from './plugin/types'\n\nconst tokenJsonRegexSchema = z.object({\n regex: z.string(),\n flags: z.string().optional(),\n})\n\nconst tokenMatcherSchema = z.union([\n z.string(),\n z.instanceof(RegExp),\n tokenJsonRegexSchema,\n])\n\nexport type TokenMatcherJson = string | z.infer<typeof tokenJsonRegexSchema>\n\nexport type TokenMatcher = z.infer<typeof tokenMatcherSchema>\n\nexport const baseConfigSchema = z.object({\n target: z.enum(['react', 'solid', 'vue', 'angular']).optional().default('react'),\n virtualRouteConfig: virtualRootRouteSchema.or(z.string()).optional(),\n routeFilePrefix: z.string().optional(),\n routeFileIgnorePrefix: z.string().optional().default('-'),\n routeFileIgnorePattern: z.string().optional(),\n routesDirectory: z.string().optional().default('./src/routes'),\n quoteStyle: z.enum(['single', 'double']).optional().default('single'),\n semicolons: z.boolean().optional().default(false),\n disableLogging: z.boolean().optional().default(false),\n routeTreeFileHeader: z\n .array(z.string())\n .optional()\n .default([\n '/* eslint-disable */',\n '// @ts-nocheck',\n '// noinspection JSUnusedGlobalSymbols',\n ]),\n indexToken: tokenMatcherSchema.optional().default('index'),\n routeToken: tokenMatcherSchema.optional().default('route'),\n pathParamsAllowedCharacters: z\n .array(z.enum([';', ':', '@', '&', '=', '+', '$', ',']))\n .optional(),\n})\n\nexport type BaseConfig = z.infer<typeof baseConfigSchema>\n\nexport const configSchema = baseConfigSchema.extend({\n generatedRouteTree: z.string().optional().default('./src/routeTree.gen.ts'),\n disableTypes: z.boolean().optional().default(false),\n verboseFileRoutes: z.boolean().optional(),\n addExtensions: z\n .union([z.boolean(), z.string()])\n .optional()\n .default(false)\n .transform((v) =>\n typeof v === 'string' ? (v.startsWith('.') ? v : `.${v}`) : v,\n ),\n enableRouteTreeFormatting: z.boolean().optional().default(true),\n routeTreeFileFooter: z\n .union([\n z.array(z.string()).optional().default([]),\n z.function().returns(z.array(z.string())),\n ])\n .optional(),\n autoCodeSplitting: z.boolean().optional(),\n customScaffolding: z\n .object({\n routeTemplate: z.string().optional(),\n lazyRouteTemplate: z.string().optional(),\n })\n .optional(),\n experimental: z\n .object({\n // TODO: This has been made stable and is now \"autoCodeSplitting\". Remove in next major version.\n enableCodeSplitting: z.boolean().optional(),\n })\n .optional(),\n plugins: z.array(z.custom<GeneratorPlugin>()).optional(),\n /**\n * When `target` is `angular`, use this package in generated route imports and\n * `FileRoutesByPath` augmentation (default `@benjavicente/angular-router-experimental`).\n */\n angularRouterPackage: z.string().optional(),\n /**\n * When `target` is `angular`, use this package in the Start `declare module` block\n * appended to the route tree (default `@benjavicente/angular-start-experimental`).\n */\n angularStartPackage: z.string().optional(),\n tmpDir: z.string().optional().default(''),\n importRoutesUsingAbsolutePaths: z.boolean().optional().default(false),\n})\n\nexport type Config = z.infer<typeof configSchema>\n\ntype ResolveParams = {\n configDirectory: string\n}\n\nexport function resolveConfigPath({ configDirectory }: ResolveParams) {\n return path.resolve(configDirectory, 'tsr.config.json')\n}\n\nexport function getConfig(\n inlineConfig: Partial<Config> = {},\n configDirectory?: string,\n): Config {\n if (configDirectory === undefined) {\n configDirectory = process.cwd()\n }\n const configFilePathJson = resolveConfigPath({ configDirectory })\n const exists = existsSync(configFilePathJson)\n\n let config: Config\n\n if (exists) {\n // Parse file config (allows JSON regex-object form)\n const fileConfigRaw = JSON.parse(readFileSync(configFilePathJson, 'utf-8'))\n\n // Merge raw configs (inline overrides file), then parse once to apply defaults\n // This ensures file config values aren't overwritten by inline defaults\n const merged = {\n ...fileConfigRaw,\n ...inlineConfig,\n }\n config = configSchema.parse(merged)\n } else {\n config = configSchema.parse(inlineConfig)\n }\n\n // If typescript is disabled, make sure the generated route tree is a .js file\n if (config.disableTypes) {\n config.generatedRouteTree = config.generatedRouteTree.replace(\n /\\.(ts|tsx)$/,\n '.js',\n )\n }\n\n // if a configDirectory is used, paths should be relative to that directory\n if (configDirectory) {\n // if absolute configDirectory is provided, use it as the root\n if (path.isAbsolute(configDirectory)) {\n config.routesDirectory = path.resolve(\n configDirectory,\n config.routesDirectory,\n )\n config.generatedRouteTree = path.resolve(\n configDirectory,\n config.generatedRouteTree,\n )\n } else {\n config.routesDirectory = path.resolve(\n process.cwd(),\n configDirectory,\n config.routesDirectory,\n )\n config.generatedRouteTree = path.resolve(\n process.cwd(),\n configDirectory,\n config.generatedRouteTree,\n )\n }\n }\n\n const resolveTmpDir = (dir: string | Array<string>) => {\n if (Array.isArray(dir)) {\n dir = path.join(...dir)\n }\n if (!path.isAbsolute(dir)) {\n dir = path.resolve(process.cwd(), dir)\n }\n return dir\n }\n\n if (config.tmpDir) {\n config.tmpDir = resolveTmpDir(config.tmpDir)\n } else if (process.env.TSR_TMP_DIR) {\n config.tmpDir = resolveTmpDir(process.env.TSR_TMP_DIR)\n } else {\n config.tmpDir = resolveTmpDir(['.tanstack', 'tmp'])\n }\n\n validateConfig(config)\n return config\n}\n\nfunction validateConfig(config: Config) {\n if (typeof config.experimental?.enableCodeSplitting !== 'undefined') {\n const message = `\n------\n⚠️ ⚠️ ⚠️\nERROR: The \"experimental.enableCodeSplitting\" flag has been made stable and is now \"autoCodeSplitting\". Please update your configuration file to use \"autoCodeSplitting\" instead of \"experimental.enableCodeSplitting\".\n------\n`\n console.error(message)\n throw new Error(message)\n }\n\n // Check that indexToken and routeToken are not identical\n // Works for strings, RegExp, and JSON regex objects\n if (areTokensEqual(config.indexToken, config.routeToken)) {\n throw new Error(\n `The \"indexToken\" and \"routeToken\" options must be different.`,\n )\n }\n\n if (\n config.routeFileIgnorePrefix &&\n config.routeFileIgnorePrefix.trim() === '_'\n ) {\n throw new Error(\n `The \"routeFileIgnorePrefix\" cannot be an underscore (\"_\"). This is a reserved character used to denote a pathless route. Please use a different prefix.`,\n )\n }\n\n return config\n}\n\n/**\n * Compares two token matchers for equality.\n * Handles strings, RegExp instances, and JSON regex objects.\n */\nfunction areTokensEqual(a: TokenMatcher, b: TokenMatcher): boolean {\n // Both strings\n if (typeof a === 'string' && typeof b === 'string') {\n return a === b\n }\n\n // Both RegExp instances\n if (a instanceof RegExp && b instanceof RegExp) {\n return a.source === b.source && a.flags === b.flags\n }\n\n // Both JSON regex objects\n if (\n typeof a === 'object' &&\n 'regex' in a &&\n typeof b === 'object' &&\n 'regex' in b\n ) {\n return a.regex === b.regex && (a.flags ?? '') === (b.flags ?? '')\n }\n\n // Mixed types - not equal\n return false\n}\n"],"mappings":";;;;;AAMA,IAAM,uBAAuB,EAAE,OAAO;CACpC,OAAO,EAAE,QAAQ;CACjB,OAAO,EAAE,QAAQ,CAAC,UAAU;CAC7B,CAAC;AAEF,IAAM,qBAAqB,EAAE,MAAM;CACjC,EAAE,QAAQ;CACV,EAAE,WAAW,OAAO;CACpB;CACD,CAAC;AAMF,IAAa,mBAAmB,EAAE,OAAO;CACvC,QAAQ,EAAE,KAAK;EAAC;EAAS;EAAS;EAAO;EAAU,CAAC,CAAC,UAAU,CAAC,QAAQ,QAAQ;CAChF,oBAAoB,uBAAuB,GAAG,EAAE,QAAQ,CAAC,CAAC,UAAU;CACpE,iBAAiB,EAAE,QAAQ,CAAC,UAAU;CACtC,uBAAuB,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,IAAI;CACzD,wBAAwB,EAAE,QAAQ,CAAC,UAAU;CAC7C,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,eAAe;CAC9D,YAAY,EAAE,KAAK,CAAC,UAAU,SAAS,CAAC,CAAC,UAAU,CAAC,QAAQ,SAAS;CACrE,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,MAAM;CACjD,gBAAgB,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,MAAM;CACrD,qBAAqB,EAClB,MAAM,EAAE,QAAQ,CAAC,CACjB,UAAU,CACV,QAAQ;EACP;EACA;EACA;EACD,CAAC;CACJ,YAAY,mBAAmB,UAAU,CAAC,QAAQ,QAAQ;CAC1D,YAAY,mBAAmB,UAAU,CAAC,QAAQ,QAAQ;CAC1D,6BAA6B,EAC1B,MAAM,EAAE,KAAK;EAAC;EAAK;EAAK;EAAK;EAAK;EAAK;EAAK;EAAK;EAAI,CAAC,CAAC,CACvD,UAAU;CACd,CAAC;AAIF,IAAa,eAAe,iBAAiB,OAAO;CAClD,oBAAoB,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,yBAAyB;CAC3E,cAAc,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,MAAM;CACnD,mBAAmB,EAAE,SAAS,CAAC,UAAU;CACzC,eAAe,EACZ,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,QAAQ,CAAC,CAAC,CAChC,UAAU,CACV,QAAQ,MAAM,CACd,WAAW,MACV,OAAO,MAAM,WAAY,EAAE,WAAW,IAAI,GAAG,IAAI,IAAI,MAAO,EAC7D;CACH,2BAA2B,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,KAAK;CAC/D,qBAAqB,EAClB,MAAM,CACL,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,EAC1C,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAC1C,CAAC,CACD,UAAU;CACb,mBAAmB,EAAE,SAAS,CAAC,UAAU;CACzC,mBAAmB,EAChB,OAAO;EACN,eAAe,EAAE,QAAQ,CAAC,UAAU;EACpC,mBAAmB,EAAE,QAAQ,CAAC,UAAU;EACzC,CAAC,CACD,UAAU;CACb,cAAc,EACX,OAAO,EAEN,qBAAqB,EAAE,SAAS,CAAC,UAAU,EAC5C,CAAC,CACD,UAAU;CACb,SAAS,EAAE,MAAM,EAAE,QAAyB,CAAC,CAAC,UAAU;CAKxD,sBAAsB,EAAE,QAAQ,CAAC,UAAU;CAK3C,qBAAqB,EAAE,QAAQ,CAAC,UAAU;CAC1C,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,GAAG;CACzC,gCAAgC,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,MAAM;CACtE,CAAC;AAQF,SAAgB,kBAAkB,EAAE,mBAAkC;AACpE,QAAO,KAAK,QAAQ,iBAAiB,kBAAkB;;AAGzD,SAAgB,UACd,eAAgC,EAAE,EAClC,iBACQ;AACR,KAAI,oBAAoB,KAAA,EACtB,mBAAkB,QAAQ,KAAK;CAEjC,MAAM,qBAAqB,kBAAkB,EAAE,iBAAiB,CAAC;CACjE,MAAM,SAAS,WAAW,mBAAmB;CAE7C,IAAI;AAEJ,KAAI,QAAQ;EAMV,MAAM,SAAS;GACb,GALoB,KAAK,MAAM,aAAa,oBAAoB,QAAQ,CAAC;GAMzE,GAAG;GACJ;AACD,WAAS,aAAa,MAAM,OAAO;OAEnC,UAAS,aAAa,MAAM,aAAa;AAI3C,KAAI,OAAO,aACT,QAAO,qBAAqB,OAAO,mBAAmB,QACpD,eACA,MACD;AAIH,KAAI,gBAEF,KAAI,KAAK,WAAW,gBAAgB,EAAE;AACpC,SAAO,kBAAkB,KAAK,QAC5B,iBACA,OAAO,gBACR;AACD,SAAO,qBAAqB,KAAK,QAC/B,iBACA,OAAO,mBACR;QACI;AACL,SAAO,kBAAkB,KAAK,QAC5B,QAAQ,KAAK,EACb,iBACA,OAAO,gBACR;AACD,SAAO,qBAAqB,KAAK,QAC/B,QAAQ,KAAK,EACb,iBACA,OAAO,mBACR;;CAIL,MAAM,iBAAiB,QAAgC;AACrD,MAAI,MAAM,QAAQ,IAAI,CACpB,OAAM,KAAK,KAAK,GAAG,IAAI;AAEzB,MAAI,CAAC,KAAK,WAAW,IAAI,CACvB,OAAM,KAAK,QAAQ,QAAQ,KAAK,EAAE,IAAI;AAExC,SAAO;;AAGT,KAAI,OAAO,OACT,QAAO,SAAS,cAAc,OAAO,OAAO;UACnC,QAAQ,IAAI,YACrB,QAAO,SAAS,cAAc,QAAQ,IAAI,YAAY;KAEtD,QAAO,SAAS,cAAc,CAAC,aAAa,MAAM,CAAC;AAGrD,gBAAe,OAAO;AACtB,QAAO;;AAGT,SAAS,eAAe,QAAgB;AACtC,KAAI,OAAO,OAAO,cAAc,wBAAwB,aAAa;EACnE,MAAM,UAAU;;;;;;AAMhB,UAAQ,MAAM,QAAQ;AACtB,QAAM,IAAI,MAAM,QAAQ;;AAK1B,KAAI,eAAe,OAAO,YAAY,OAAO,WAAW,CACtD,OAAM,IAAI,MACR,+DACD;AAGH,KACE,OAAO,yBACP,OAAO,sBAAsB,MAAM,KAAK,IAExC,OAAM,IAAI,MACR,0JACD;AAGH,QAAO;;;;;;AAOT,SAAS,eAAe,GAAiB,GAA0B;AAEjE,KAAI,OAAO,MAAM,YAAY,OAAO,MAAM,SACxC,QAAO,MAAM;AAIf,KAAI,aAAa,UAAU,aAAa,OACtC,QAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE;AAIhD,KACE,OAAO,MAAM,YACb,WAAW,KACX,OAAO,MAAM,YACb,WAAW,EAEX,QAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,SAAS,EAAE,SAAS;AAIhE,QAAO"}
@@ -0,0 +1,25 @@
1
+ import { FsRouteType, GetRouteNodesResult } from '../../types.js';
2
+ import { Config } from '../../config.js';
3
+ /**
4
+ * Pre-compiled segment regexes for matching token patterns against route segments.
5
+ * These are created once (in Generator constructor) and passed through to avoid
6
+ * repeated regex compilation during route crawling.
7
+ */
8
+ export interface TokenRegexBundle {
9
+ indexTokenSegmentRegex: RegExp;
10
+ routeTokenSegmentRegex: RegExp;
11
+ }
12
+ export declare function isVirtualConfigFile(fileName: string): boolean;
13
+ export declare function getRouteNodes(config: Pick<Config, 'routesDirectory' | 'routeFilePrefix' | 'routeFileIgnorePrefix' | 'routeFileIgnorePattern' | 'disableLogging' | 'routeToken' | 'indexToken'>, root: string, tokenRegexes: TokenRegexBundle): Promise<GetRouteNodesResult>;
14
+ /**
15
+ * Determines the metadata for a given route path based on the provided configuration.
16
+ *
17
+ * @param routePath - The determined initial routePath (with brackets removed).
18
+ * @param originalRoutePath - The original route path (may contain brackets for escaped content).
19
+ * @param tokenRegexes - Pre-compiled token regexes for matching.
20
+ * @returns An object containing the type of the route and the variable name derived from the route path.
21
+ */
22
+ export declare function getRouteMeta(routePath: string, originalRoutePath: string, tokenRegexes: TokenRegexBundle): {
23
+ fsRouteType: Extract<FsRouteType, 'static' | 'layout' | 'api' | 'lazy' | 'loader' | 'component' | 'pendingComponent' | 'errorComponent' | 'notFoundComponent'>;
24
+ variableName: string;
25
+ };