mirror of
https://github.com/kevin-DL/sapper.git
synced 2026-01-22 15:15:19 +00:00
tidy up
This commit is contained in:
Rich Harris
@@ -1,7 +1,6 @@
|
|||||||
import * as fs from 'fs';
|
import * as fs from 'fs';
|
||||||
import * as path from 'path';
|
import * as path from 'path';
|
||||||
import { locations } from '../config';
|
import { locations } from '../config';
|
||||||
import { Route } from '../interfaces';
|
|
||||||
|
|
||||||
type Component = {
|
type Component = {
|
||||||
name: string;
|
name: string;
|
||||||
|
|||||||
@@ -1,186 +0,0 @@
|
|||||||
import * as path from 'path';
|
|
||||||
import glob from 'glob';
|
|
||||||
import { locations } from '../config';
|
|
||||||
import { Route } from '../interfaces';
|
|
||||||
|
|
||||||
export default function create_routes({
|
|
||||||
files
|
|
||||||
} = {
|
|
||||||
files: glob.sync('**/*.*', {
|
|
||||||
cwd: locations.routes(),
|
|
||||||
dot: true,
|
|
||||||
nodir: true
|
|
||||||
})
|
|
||||||
}) {
|
|
||||||
const all_routes = files
|
|
||||||
.filter((file: string) => !/(^|\/|\\)(_(?!error\.html)|\.(?!well-known))/.test(file))
|
|
||||||
.map((file: string) => {
|
|
||||||
if (/]\[/.test(file)) {
|
|
||||||
throw new Error(`Invalid route ${file} — parameters must be separated`);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (file === '4xx.html' || file === '5xx.html') {
|
|
||||||
throw new Error('As of Sapper 0.14, 4xx.html and 5xx.html should be replaced with _error.html');
|
|
||||||
}
|
|
||||||
|
|
||||||
const base = file.replace(/\.[^/.]+$/, '');
|
|
||||||
const parts = base.split('/'); // glob output is always posix-style
|
|
||||||
if (/^index(\..+)?/.test(parts[parts.length - 1])) {
|
|
||||||
const part = parts.pop();
|
|
||||||
if (parts.length > 0) parts[parts.length - 1] += part.slice(5);
|
|
||||||
}
|
|
||||||
|
|
||||||
const id = (
|
|
||||||
parts.join('_').replace(/[[\]]/g, '$').replace(/^\d/, '_$&').replace(/[^a-zA-Z0-9_$]/g, '_')
|
|
||||||
) || '_';
|
|
||||||
|
|
||||||
const type = file.endsWith('.html') ? 'page' : 'route';
|
|
||||||
|
|
||||||
const params: string[] = [];
|
|
||||||
const match_patterns: Record<string, string> = {};
|
|
||||||
const param_pattern = /\[([^\(\]]+)(?:\((.+?)\))?\]/g;
|
|
||||||
|
|
||||||
let match;
|
|
||||||
while (match = param_pattern.exec(base)) {
|
|
||||||
params.push(match[1]);
|
|
||||||
if (typeof match[2] !== 'undefined') {
|
|
||||||
if (/[\(\)\?\:]/.exec(match[2])) {
|
|
||||||
throw new Error('Sapper does not allow (, ), ? or : in RegExp routes yet');
|
|
||||||
}
|
|
||||||
// Make a map of the regexp patterns
|
|
||||||
match_patterns[match[1]] = `(${match[2]}?)`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO can we do all this with sub-parts? or does
|
|
||||||
// nesting make that impossible?
|
|
||||||
let pattern_string = '';
|
|
||||||
let i = parts.length;
|
|
||||||
let nested = true;
|
|
||||||
while (i--) {
|
|
||||||
const part = encodeURI(parts[i].normalize()).replace(/\?/g, '%3F').replace(/#/g, '%23').replace(/%5B/g, '[').replace(/%5D/g, ']');
|
|
||||||
const dynamic = ~part.indexOf('[');
|
|
||||||
|
|
||||||
if (dynamic) {
|
|
||||||
// Get keys from part and replace with stored match patterns
|
|
||||||
const keys = part.replace(/\(.*?\)/, '').split(/[\[\]]/).filter((x, i) => { if (i % 2) return x });
|
|
||||||
let matcher = part;
|
|
||||||
keys.forEach(k => {
|
|
||||||
const key_pattern = new RegExp('\\[' + k + '(?:\\((.+?)\\))?\\]');
|
|
||||||
matcher = matcher.replace(key_pattern, match_patterns[k] || `([^/]+?)`);
|
|
||||||
})
|
|
||||||
pattern_string = (nested && type === 'page') ? `(?:\\/${matcher}${pattern_string})?` : `\\/${matcher}${pattern_string}`;
|
|
||||||
} else {
|
|
||||||
nested = false;
|
|
||||||
pattern_string = `\\/${part}${pattern_string}`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const pattern = new RegExp(`^${pattern_string}\\/?$`);
|
|
||||||
|
|
||||||
const test = (url: string) => pattern.test(url);
|
|
||||||
|
|
||||||
const exec = (url: string) => {
|
|
||||||
const match = pattern.exec(url);
|
|
||||||
if (!match) return;
|
|
||||||
|
|
||||||
const result: Record<string, string> = {};
|
|
||||||
params.forEach((param, i) => {
|
|
||||||
result[param] = match[i + 1];
|
|
||||||
});
|
|
||||||
|
|
||||||
return result;
|
|
||||||
};
|
|
||||||
|
|
||||||
return {
|
|
||||||
id,
|
|
||||||
base,
|
|
||||||
type,
|
|
||||||
file,
|
|
||||||
pattern,
|
|
||||||
test,
|
|
||||||
exec,
|
|
||||||
parts,
|
|
||||||
params
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
const pages = all_routes
|
|
||||||
.filter(r => r.type === 'page')
|
|
||||||
.sort(comparator);
|
|
||||||
|
|
||||||
const server_routes = all_routes
|
|
||||||
.filter(r => r.type === 'route')
|
|
||||||
.sort(comparator);
|
|
||||||
|
|
||||||
return { pages, server_routes };
|
|
||||||
}
|
|
||||||
|
|
||||||
function comparator(a, b) {
|
|
||||||
if (a.parts[0] === '_error') return -1;
|
|
||||||
if (b.parts[0] === '_error') return 1;
|
|
||||||
|
|
||||||
const max = Math.max(a.parts.length, b.parts.length);
|
|
||||||
|
|
||||||
for (let i = 0; i < max; i += 1) {
|
|
||||||
const a_part = a.parts[i];
|
|
||||||
const b_part = b.parts[i];
|
|
||||||
|
|
||||||
if (!a_part) return -1;
|
|
||||||
if (!b_part) return 1;
|
|
||||||
|
|
||||||
const a_sub_parts = get_sub_parts(a_part);
|
|
||||||
const b_sub_parts = get_sub_parts(b_part);
|
|
||||||
const max = Math.max(a_sub_parts.length, b_sub_parts.length);
|
|
||||||
|
|
||||||
for (let i = 0; i < max; i += 1) {
|
|
||||||
const a_sub_part = a_sub_parts[i];
|
|
||||||
const b_sub_part = b_sub_parts[i];
|
|
||||||
|
|
||||||
if (!a_sub_part) return 1; // b is more specific, so goes first
|
|
||||||
if (!b_sub_part) return -1;
|
|
||||||
|
|
||||||
if (a_sub_part.dynamic !== b_sub_part.dynamic) {
|
|
||||||
return a_sub_part.dynamic ? 1 : -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!a_sub_part.dynamic && a_sub_part.content !== b_sub_part.content) {
|
|
||||||
return (
|
|
||||||
(b_sub_part.content.length - a_sub_part.content.length) ||
|
|
||||||
(a_sub_part.content < b_sub_part.content ? -1 : 1)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// If both parts dynamic, check for regexp patterns
|
|
||||||
if (a_sub_part.dynamic && b_sub_part.dynamic) {
|
|
||||||
const regexp_pattern = /\((.*?)\)/;
|
|
||||||
const a_match = regexp_pattern.exec(a_sub_part.content);
|
|
||||||
const b_match = regexp_pattern.exec(b_sub_part.content);
|
|
||||||
|
|
||||||
if (!a_match && b_match) {
|
|
||||||
return 1; // No regexp, so less specific than b
|
|
||||||
}
|
|
||||||
if (!b_match && a_match) {
|
|
||||||
return -1;
|
|
||||||
}
|
|
||||||
if (a_match && b_match && a_match[1] !== b_match[1]) {
|
|
||||||
return b_match[1].length - a_match[1].length;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Error(`The ${a.base} and ${b.base} routes clash`);
|
|
||||||
}
|
|
||||||
|
|
||||||
function get_sub_parts(part: string) {
|
|
||||||
return part.split(/\[(.+)\]/)
|
|
||||||
.map((content, i) => {
|
|
||||||
if (!content) return null;
|
|
||||||
return {
|
|
||||||
content,
|
|
||||||
dynamic: i % 2 === 1
|
|
||||||
};
|
|
||||||
})
|
|
||||||
.filter(Boolean);
|
|
||||||
}
|
|
||||||
@@ -1,366 +0,0 @@
|
|||||||
const assert = require('assert');
|
|
||||||
const { create_routes } = require('../../dist/core.ts.js');
|
|
||||||
|
|
||||||
describe('create_routes', () => {
|
|
||||||
it('encodes characters not allowed in path', () => {
|
|
||||||
const { server_routes } = create_routes({
|
|
||||||
files: [
|
|
||||||
'"',
|
|
||||||
'#',
|
|
||||||
'?'
|
|
||||||
]
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
server_routes.map(r => r.pattern),
|
|
||||||
[
|
|
||||||
/^\/%22\/?$/,
|
|
||||||
/^\/%23\/?$/,
|
|
||||||
/^\/%3F\/?$/
|
|
||||||
]
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('sorts routes correctly', () => {
|
|
||||||
const { pages, server_routes } = create_routes({
|
|
||||||
files: [
|
|
||||||
'index.html',
|
|
||||||
'about.html',
|
|
||||||
'post/f[xx].html',
|
|
||||||
'[wildcard].html',
|
|
||||||
'post/foo.html',
|
|
||||||
'post/[id].html',
|
|
||||||
'post/bar.html',
|
|
||||||
'post/[id].json.js',
|
|
||||||
'post/[id([0-9-a-z]{3,})].html',
|
|
||||||
]
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
pages.map(r => r.file),
|
|
||||||
[
|
|
||||||
'index.html',
|
|
||||||
'about.html',
|
|
||||||
'post/bar.html',
|
|
||||||
'post/foo.html',
|
|
||||||
'post/f[xx].html',
|
|
||||||
'post/[id([0-9-a-z]{3,})].html', // RegExp is more specific
|
|
||||||
'post/[id].html',
|
|
||||||
'[wildcard].html'
|
|
||||||
]
|
|
||||||
);
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
server_routes.map(r => r.file),
|
|
||||||
[
|
|
||||||
'post/[id].json.js'
|
|
||||||
]
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('distinguishes and sorts regexp routes correctly', () => {
|
|
||||||
const { pages } = create_routes({
|
|
||||||
files: [
|
|
||||||
'[slug].html',
|
|
||||||
'[slug([a-z]{2})].html',
|
|
||||||
'[slug([0-9-a-z]{3,})].html',
|
|
||||||
]
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
pages.map(r => r.file),
|
|
||||||
[
|
|
||||||
'[slug([0-9-a-z]{3,})].html',
|
|
||||||
'[slug([a-z]{2})].html',
|
|
||||||
'[slug].html',
|
|
||||||
]
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('prefers index page to nested route', () => {
|
|
||||||
let { pages, server_routes } = create_routes({
|
|
||||||
files: [
|
|
||||||
'api/examples/[slug].js',
|
|
||||||
'api/examples/index.js',
|
|
||||||
'blog/[slug].html',
|
|
||||||
'api/gists/[id].js',
|
|
||||||
'api/gists/index.js',
|
|
||||||
'_error.html',
|
|
||||||
'blog/index.html',
|
|
||||||
'blog/rss.xml.js',
|
|
||||||
'guide/index.html',
|
|
||||||
'index.html'
|
|
||||||
]
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
pages.map(r => r.file),
|
|
||||||
[
|
|
||||||
'_error.html',
|
|
||||||
'index.html',
|
|
||||||
'guide/index.html',
|
|
||||||
'blog/index.html',
|
|
||||||
'blog/[slug].html'
|
|
||||||
]
|
|
||||||
);
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
server_routes.map(r => r.file),
|
|
||||||
[
|
|
||||||
'blog/rss.xml.js',
|
|
||||||
'api/examples/index.js',
|
|
||||||
'api/examples/[slug].js',
|
|
||||||
'api/gists/index.js',
|
|
||||||
'api/gists/[id].js',
|
|
||||||
]
|
|
||||||
);
|
|
||||||
|
|
||||||
({ pages, server_routes } = create_routes({
|
|
||||||
files: [
|
|
||||||
'_error.html',
|
|
||||||
'api/blog/[slug].js',
|
|
||||||
'api/blog/index.js',
|
|
||||||
'api/guide/contents.js',
|
|
||||||
'api/guide/index.js',
|
|
||||||
'blog/[slug].html',
|
|
||||||
'blog/index.html',
|
|
||||||
'blog/rss.xml.js',
|
|
||||||
'gist/[id].js',
|
|
||||||
'gist/create.js',
|
|
||||||
'guide/index.html',
|
|
||||||
'index.html',
|
|
||||||
'repl/index.html'
|
|
||||||
]
|
|
||||||
}));
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
pages.map(r => r.file),
|
|
||||||
[
|
|
||||||
'_error.html',
|
|
||||||
'index.html',
|
|
||||||
'guide/index.html',
|
|
||||||
'blog/index.html',
|
|
||||||
'blog/[slug].html',
|
|
||||||
'repl/index.html'
|
|
||||||
]
|
|
||||||
);
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
server_routes.map(r => r.file),
|
|
||||||
[
|
|
||||||
'blog/rss.xml.js',
|
|
||||||
'gist/create.js',
|
|
||||||
'gist/[id].js',
|
|
||||||
'api/guide/index.js',
|
|
||||||
'api/guide/contents.js',
|
|
||||||
'api/blog/index.js',
|
|
||||||
'api/blog/[slug].js',
|
|
||||||
]
|
|
||||||
);
|
|
||||||
|
|
||||||
// RegExp routes
|
|
||||||
({ pages } = create_routes({
|
|
||||||
files: [
|
|
||||||
'blog/[slug].html',
|
|
||||||
'blog/index.html',
|
|
||||||
'blog/[slug([^0-9]+)].html',
|
|
||||||
]
|
|
||||||
}));
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
pages.map(r => r.file),
|
|
||||||
[
|
|
||||||
'blog/index.html',
|
|
||||||
'blog/[slug([^0-9]+)].html',
|
|
||||||
'blog/[slug].html',
|
|
||||||
]
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('generates params', () => {
|
|
||||||
const { pages } = create_routes({
|
|
||||||
files: ['index.html', 'about.html', '[wildcard].html', 'post/[id].html']
|
|
||||||
});
|
|
||||||
|
|
||||||
let file;
|
|
||||||
let params;
|
|
||||||
for (let i = 0; i < pages.length; i += 1) {
|
|
||||||
const route = pages[i];
|
|
||||||
if (params = route.exec('/post/123')) {
|
|
||||||
file = route.file;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.equal(file, 'post/[id].html');
|
|
||||||
assert.deepEqual(params, {
|
|
||||||
id: '123'
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('ignores files and directories with leading underscores', () => {
|
|
||||||
const { pages } = create_routes({
|
|
||||||
files: ['index.html', '_foo.html', 'a/_b/c/d.html', 'e/f/g/h.html', 'i/_j.html']
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
pages.map(r => r.file),
|
|
||||||
[
|
|
||||||
'index.html',
|
|
||||||
'e/f/g/h.html'
|
|
||||||
]
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('ignores files and directories with leading dots except .well-known', () => {
|
|
||||||
const { server_routes } = create_routes({
|
|
||||||
files: ['.well-known/dnt-policy.txt.js', '.unknown/foo.txt.js']
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
server_routes.map(r => r.file),
|
|
||||||
['.well-known/dnt-policy.txt.js']
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('matches /foo/:bar before /:baz/qux', () => {
|
|
||||||
const a = create_routes({
|
|
||||||
files: ['foo/[bar].html', '[baz]/qux.html']
|
|
||||||
});
|
|
||||||
const b = create_routes({
|
|
||||||
files: ['[baz]/qux.html', 'foo/[bar].html']
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
a.pages.map(r => r.file),
|
|
||||||
['foo/[bar].html', '[baz]/qux.html']
|
|
||||||
);
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
b.pages.map(r => r.file),
|
|
||||||
['foo/[bar].html', '[baz]/qux.html']
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('fails if routes are indistinguishable', () => {
|
|
||||||
assert.throws(() => {
|
|
||||||
create_routes({
|
|
||||||
files: ['[foo].html', '[bar]/index.html']
|
|
||||||
});
|
|
||||||
}, /The \[foo\] and \[bar\]\/index routes clash/);
|
|
||||||
|
|
||||||
assert.throws(() => {
|
|
||||||
create_routes({
|
|
||||||
files: ['[foo([0-9-a-z]+)].html', '[bar([0-9-a-z]+)]/index.html']
|
|
||||||
});
|
|
||||||
}, /The \[foo\(\[0-9-a-z\]\+\)\] and \[bar\(\[0-9-a-z\]\+\)\]\/index routes clash/);
|
|
||||||
});
|
|
||||||
|
|
||||||
|
|
||||||
it('matches nested routes', () => {
|
|
||||||
const page = create_routes({
|
|
||||||
files: ['settings/[submenu].html']
|
|
||||||
}).pages[0];
|
|
||||||
|
|
||||||
assert.deepEqual(page.exec('/settings/foo'), {
|
|
||||||
submenu: 'foo'
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(page.exec('/settings'), {
|
|
||||||
submenu: null
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('prefers index routes to nested routes', () => {
|
|
||||||
const { pages } = create_routes({
|
|
||||||
files: ['settings/[submenu].html', 'settings.html']
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
pages.map(r => r.file),
|
|
||||||
['settings.html', 'settings/[submenu].html']
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('matches deeply nested routes', () => {
|
|
||||||
const page = create_routes({
|
|
||||||
files: ['settings/[a]/[b]/index.html']
|
|
||||||
}).pages[0];
|
|
||||||
|
|
||||||
assert.deepEqual(page.exec('/settings/foo/bar'), {
|
|
||||||
a: 'foo',
|
|
||||||
b: 'bar'
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(page.exec('/settings/foo'), {
|
|
||||||
a: 'foo',
|
|
||||||
b: null
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.deepEqual(page.exec('/settings'), {
|
|
||||||
a: null,
|
|
||||||
b: null
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('matches a dynamic part within a part', () => {
|
|
||||||
const route = create_routes({
|
|
||||||
files: ['things/[slug].json.js']
|
|
||||||
}).server_routes[0];
|
|
||||||
|
|
||||||
assert.deepEqual(route.exec('/things/foo.json'), {
|
|
||||||
slug: 'foo'
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('matches multiple dynamic parts within a part', () => {
|
|
||||||
const route = create_routes({
|
|
||||||
files: ['things/[id]_[slug].json.js']
|
|
||||||
}).server_routes[0];
|
|
||||||
|
|
||||||
assert.deepEqual(route.exec('/things/someid_someslug.json'), {
|
|
||||||
id: 'someid',
|
|
||||||
slug: 'someslug'
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('fails if dynamic params are not separated', () => {
|
|
||||||
assert.throws(() => {
|
|
||||||
create_routes({
|
|
||||||
files: ['[foo][bar].js']
|
|
||||||
});
|
|
||||||
}, /Invalid route \[foo\]\[bar\]\.js — parameters must be separated/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('errors when trying to use reserved characters in route regexp', () => {
|
|
||||||
assert.throws(() => {
|
|
||||||
create_routes({
|
|
||||||
files: ['[lang([a-z]{2}(?:-[a-z]{2,4})?)]']
|
|
||||||
});
|
|
||||||
}, /Sapper does not allow \(, \), \? or \: in RegExp routes yet/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('errors on 4xx.html', () => {
|
|
||||||
assert.throws(() => {
|
|
||||||
create_routes({
|
|
||||||
files: ['4xx.html']
|
|
||||||
});
|
|
||||||
}, /As of Sapper 0.14, 4xx.html and 5xx.html should be replaced with _error.html/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('errors on 5xx.html', () => {
|
|
||||||
assert.throws(() => {
|
|
||||||
create_routes({
|
|
||||||
files: ['5xx.html']
|
|
||||||
});
|
|
||||||
}, /As of Sapper 0.14, 4xx.html and 5xx.html should be replaced with _error.html/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('treats foo/index.json.js the same as foo.json.js', () => {
|
|
||||||
const route = create_routes({
|
|
||||||
files: ['foo/index.json.js']
|
|
||||||
}).server_routes[0];
|
|
||||||
|
|
||||||
assert.ok(route.test('/foo.json'));
|
|
||||||
});
|
|
||||||
});
|
|
||||||
Reference in New Issue
Block a user