forked from remix-run/remix
-
Notifications
You must be signed in to change notification settings - Fork 0
/
routesConvention.ts
291 lines (244 loc) · 7.48 KB
/
routesConvention.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
import * as fs from "fs";
import * as path from "path";
import minimatch from "minimatch";
import type { RouteManifest, DefineRouteFunction } from "./routes";
import { defineRoutes, createRouteId } from "./routes";
const routeModuleExts = [".js", ".jsx", ".ts", ".tsx", ".md", ".mdx"];
export function isRouteModuleFile(filename: string): boolean {
return routeModuleExts.includes(path.extname(filename));
}
/**
* Defines routes using the filesystem convention in `app/routes`. The rules are:
*
* - Route paths are derived from the file path. A `.` in the filename indicates
* a `/` in the URL (a "nested" URL, but no route nesting). A `$` in the
* filename indicates a dynamic URL segment.
* - Subdirectories are used for nested routes.
*
* For example, a file named `app/routes/gists/$username.tsx` creates a route
* with a path of `gists/:username`.
*/
export function defineConventionalRoutes(
appDir: string,
ignoredFilePatterns?: string[]
): RouteManifest {
let files: { [routeId: string]: string } = {};
// First, find all route modules in app/routes
visitFiles(path.join(appDir, "routes"), (file) => {
if (
ignoredFilePatterns &&
ignoredFilePatterns.some((pattern) => minimatch(file, pattern))
) {
return;
}
if (isRouteModuleFile(file)) {
let routeId = createRouteId(path.join("routes", file));
files[routeId] = path.join("routes", file);
return;
}
throw new Error(
`Invalid route module file: ${path.join(appDir, "routes", file)}`
);
});
let routeIds = Object.keys(files).sort(byLongestFirst);
let uniqueRoutes = new Map<string, string>();
// Then, recurse through all routes using the public defineRoutes() API
function defineNestedRoutes(
defineRoute: DefineRouteFunction,
parentId?: string
): void {
let childRouteIds = routeIds.filter(
(id) => findParentRouteId(routeIds, id) === parentId
);
for (let routeId of childRouteIds) {
let routePath: string | undefined = createRoutePath(
routeId.slice((parentId || "routes").length + 1)
);
let isIndexRoute = routeId.endsWith("/index");
let fullPath = createRoutePath(routeId.slice("routes".length + 1));
let uniqueRouteId = (fullPath || "") + (isIndexRoute ? "?index" : "");
if (uniqueRouteId) {
if (uniqueRoutes.has(uniqueRouteId)) {
throw new Error(
`Path ${JSON.stringify(fullPath)} defined by route ${JSON.stringify(
routeId
)} conflicts with route ${JSON.stringify(
uniqueRoutes.get(uniqueRouteId)
)}`
);
} else {
uniqueRoutes.set(uniqueRouteId, routeId);
}
}
if (isIndexRoute) {
let invalidChildRoutes = routeIds.filter(
(id) => findParentRouteId(routeIds, id) === routeId
);
if (invalidChildRoutes.length > 0) {
throw new Error(
`Child routes are not allowed in index routes. Please remove child routes of ${routeId}`
);
}
defineRoute(routePath, files[routeId], {
index: true,
});
} else {
defineRoute(routePath, files[routeId], () => {
defineNestedRoutes(defineRoute, routeId);
});
}
}
}
return defineRoutes(defineNestedRoutes);
}
let escapeStart = "[";
let escapeEnd = "]";
let optionalStart = "(";
let optionalEnd = ")";
// TODO: Cleanup and write some tests for this function
export function createRoutePath(partialRouteId: string): string | undefined {
let result = "";
let rawSegmentBuffer = "";
let inEscapeSequence = 0;
let inOptionalSegment = 0;
let optionalSegmentIndex = null;
let skipSegment = false;
for (let i = 0; i < partialRouteId.length; i++) {
let char = partialRouteId.charAt(i);
let lastChar = i > 0 ? partialRouteId.charAt(i - 1) : undefined;
let nextChar =
i < partialRouteId.length - 1 ? partialRouteId.charAt(i + 1) : undefined;
function isNewEscapeSequence() {
return (
!inEscapeSequence && char === escapeStart && lastChar !== escapeStart
);
}
function isCloseEscapeSequence() {
return inEscapeSequence && char === escapeEnd && nextChar !== escapeEnd;
}
function isStartOfLayoutSegment() {
return char === "_" && nextChar === "_" && !rawSegmentBuffer;
}
function isSegmentSeparator(checkChar = char) {
return (
checkChar === "/" || checkChar === "." || checkChar === path.win32.sep
);
}
function isNewOptionalSegment() {
return (
char === optionalStart &&
lastChar !== optionalStart &&
(isSegmentSeparator(lastChar) || lastChar === undefined) &&
!inOptionalSegment &&
!inEscapeSequence
);
}
function isCloseOptionalSegment() {
return (
char === optionalEnd &&
nextChar !== optionalEnd &&
(isSegmentSeparator(nextChar) || nextChar === undefined) &&
inOptionalSegment &&
!inEscapeSequence
);
}
if (skipSegment) {
if (isSegmentSeparator()) {
skipSegment = false;
}
continue;
}
if (isNewEscapeSequence()) {
inEscapeSequence++;
continue;
}
if (isCloseEscapeSequence()) {
inEscapeSequence--;
continue;
}
if (isNewOptionalSegment()) {
inOptionalSegment++;
optionalSegmentIndex = result.length;
result += "(";
continue;
}
if (isCloseOptionalSegment()) {
if (optionalSegmentIndex !== null) {
result =
result.slice(0, optionalSegmentIndex) +
result.slice(optionalSegmentIndex + 1);
}
optionalSegmentIndex = null;
inOptionalSegment--;
result += "?";
continue;
}
if (inEscapeSequence) {
result += char;
continue;
}
if (isSegmentSeparator()) {
if (rawSegmentBuffer === "index" && result.endsWith("index")) {
result = result.replace(/\/?index$/, "");
} else {
result += "/";
}
rawSegmentBuffer = "";
inOptionalSegment = 0;
optionalSegmentIndex = null;
continue;
}
if (isStartOfLayoutSegment()) {
skipSegment = true;
continue;
}
rawSegmentBuffer += char;
if (char === "$") {
if (nextChar === ")") {
throw new Error(
`Invalid route path: ${partialRouteId}. Splat route $ is already optional`
);
}
result += typeof nextChar === "undefined" ? "*" : ":";
continue;
}
result += char;
}
if (rawSegmentBuffer === "index" && result.endsWith("index")) {
result = result.replace(/\/?index$/, "");
}
if (rawSegmentBuffer === "index" && result.endsWith("index?")) {
throw new Error(
`Invalid route path: ${partialRouteId}. Make index route optional by using [index]`
);
}
return result || undefined;
}
function findParentRouteId(
routeIds: string[],
childRouteId: string
): string | undefined {
return routeIds.find((id) => childRouteId.startsWith(`${id}/`));
}
function byLongestFirst(a: string, b: string): number {
return b.length - a.length;
}
function visitFiles(
dir: string,
visitor: (file: string) => void,
baseDir = dir
): void {
for (let filename of fs.readdirSync(dir)) {
let file = path.resolve(dir, filename);
let stat = fs.lstatSync(file);
if (stat.isDirectory()) {
visitFiles(file, visitor, baseDir);
} else if (stat.isFile()) {
visitor(path.relative(baseDir, file));
}
}
}
/*
eslint
no-loop-func: "off",
*/