toiljs 0.0.14 → 0.0.16
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.
- package/.babelrc +13 -13
- package/.gitattributes +2 -2
- package/.github/ISSUE_TEMPLATE/bug_report.md +38 -38
- package/.github/ISSUE_TEMPLATE/bug_report.yml +90 -90
- package/.github/ISSUE_TEMPLATE/config.yml +8 -8
- package/.github/ISSUE_TEMPLATE/feature_request.md +20 -20
- package/.github/PULL_REQUEST_TEMPLATE.md +43 -43
- package/.github/changelog-config.json +45 -45
- package/.github/dependabot.yml +27 -27
- package/.github/workflows/ci.yml +191 -191
- package/.prettierrc.json +11 -11
- package/.vscode/settings.json +9 -9
- package/CHANGELOG.md +5 -5
- package/LICENSE +187 -187
- package/README.md +339 -315
- package/as-pect.asconfig.json +34 -34
- package/as-pect.config.js +65 -65
- package/assets/logo.svg +36 -36
- package/build/backend/.tsbuildinfo +1 -1
- package/build/cli/.tsbuildinfo +1 -1
- package/build/cli/index.js +2926 -191
- package/build/client/.tsbuildinfo +1 -1
- package/build/client/dev/devtools.d.ts +6 -0
- package/build/client/dev/devtools.js +442 -0
- package/build/client/dev/error-overlay.d.ts +9 -0
- package/build/client/dev/error-overlay.js +19 -4
- package/build/client/head/metadata.d.ts +3 -1
- package/build/client/head/metadata.js +8 -0
- package/build/client/index.d.ts +4 -4
- package/build/client/index.js +2 -2
- package/build/client/navigation/navigation.d.ts +2 -0
- package/build/client/navigation/navigation.js +9 -1
- package/build/client/navigation/prefetch.d.ts +1 -0
- package/build/client/navigation/prefetch.js +35 -0
- package/build/client/routing/Router.js +1 -1
- package/build/client/routing/hooks.js +6 -2
- package/build/client/routing/loader.d.ts +25 -0
- package/build/client/routing/loader.js +53 -7
- package/build/client/routing/mount.js +4 -3
- package/build/compiler/.tsbuildinfo +1 -1
- package/build/compiler/config.d.ts +18 -0
- package/build/compiler/config.js +8 -0
- package/build/compiler/docs.js +16 -16
- package/build/compiler/generate.js +3 -0
- package/build/compiler/index.d.ts +2 -2
- package/build/compiler/index.js +3 -1
- package/build/compiler/plugin.js +156 -0
- package/build/compiler/prerender.d.ts +1 -0
- package/build/compiler/prerender.js +2 -1
- package/build/compiler/seo.d.ts +2 -2
- package/build/compiler/seo.js +8 -6
- package/build/compiler/ssg.d.ts +5 -0
- package/build/compiler/ssg.js +121 -0
- package/build/io/.tsbuildinfo +1 -1
- package/build/logger/.tsbuildinfo +1 -1
- package/build/shared/.tsbuildinfo +1 -1
- package/eslint.config.js +48 -48
- package/examples/basic/client/404.tsx +11 -11
- package/examples/basic/client/components/.gitkeep +1 -1
- package/examples/basic/client/global-error.tsx +13 -13
- package/examples/basic/client/layout.tsx +25 -25
- package/examples/basic/client/public/images/.gitkeep +1 -1
- package/examples/basic/client/public/images/logo.svg +36 -36
- package/examples/basic/client/public/robots.txt +2 -2
- package/examples/basic/client/routes/docs/[...slug].tsx +12 -12
- package/examples/basic/client/routes/features/error/error.tsx +16 -16
- package/examples/basic/client/routes/features/template/b.tsx +14 -14
- package/examples/basic/client/routes/files/[[...slug]].tsx +21 -21
- package/examples/basic/client/routes/gallery/layout.tsx +13 -13
- package/examples/basic/client/routes/io.tsx +24 -24
- package/examples/basic/client/routes/loader-demo/loading.tsx +13 -13
- package/examples/basic/client/routes/search.tsx +61 -61
- package/examples/basic/client/toil.tsx +5 -5
- package/package.json +155 -147
- package/presets/eslint.js +88 -88
- package/presets/no-uint8array-tostring.js +200 -200
- package/presets/prettier.json +18 -18
- package/presets/tsconfig.json +37 -37
- package/src/backend/index.ts +160 -160
- package/src/cli/proc.ts +50 -50
- package/src/cli/updates.ts +69 -69
- package/src/cli/validate.ts +31 -31
- package/src/client/channel/channel.ts +146 -146
- package/src/client/components/Form.tsx +65 -65
- package/src/client/components/Script.tsx +113 -113
- package/src/client/components/Slot.tsx +21 -21
- package/src/client/dev/devtools.tsx +973 -0
- package/src/client/dev/error-overlay.tsx +30 -4
- package/src/client/head/head.ts +167 -167
- package/src/client/head/metadata.ts +19 -1
- package/src/client/index.ts +19 -9
- package/src/client/navigation/NavLink.tsx +86 -86
- package/src/client/navigation/navigation.ts +25 -5
- package/src/client/navigation/prefetch.ts +169 -130
- package/src/client/navigation/scroll.ts +53 -53
- package/src/client/routing/Router.tsx +8 -2
- package/src/client/routing/action.ts +122 -122
- package/src/client/routing/error-boundary.tsx +43 -43
- package/src/client/routing/hooks.ts +21 -6
- package/src/client/routing/loader.ts +325 -225
- package/src/client/routing/match.ts +47 -47
- package/src/client/routing/mount.tsx +54 -52
- package/src/client/routing/params-context.ts +10 -10
- package/src/client/routing/slot-context.ts +7 -7
- package/src/client/search/search.ts +189 -189
- package/src/client/search/use-page-search.ts +73 -73
- package/src/client/types.ts +73 -73
- package/src/compiler/config.ts +47 -1
- package/src/compiler/docs.ts +228 -228
- package/src/compiler/generate.ts +394 -391
- package/src/compiler/index.ts +64 -54
- package/src/compiler/pages.ts +70 -70
- package/src/compiler/plugin.ts +170 -2
- package/src/compiler/prerender.ts +5 -1
- package/src/compiler/seo.ts +23 -7
- package/src/compiler/ssg.ts +162 -0
- package/src/io/BinaryReader.ts +340 -340
- package/src/io/BinaryWriter.ts +385 -385
- package/src/io/FastMap.ts +127 -127
- package/src/io/index.ts +11 -11
- package/src/io/lengths.ts +14 -14
- package/src/io/types.ts +18 -18
- package/src/logger/index.ts +22 -22
- package/src/server/index.ts +10 -10
- package/src/server/main.ts +13 -13
- package/src/server/tsconfig.json +4 -4
- package/src/shared/index.ts +10 -10
- package/std/client/index.d.ts +15 -15
- package/std/client/package.json +3 -3
- package/test/assembly/example.spec.ts +7 -7
- package/test/channel.test.ts +21 -21
- package/test/dom/Link.test.tsx +47 -47
- package/test/dom/NavLink.test.tsx +37 -37
- package/test/dom/error-overlay.test.tsx +44 -44
- package/test/dom/loader.test.tsx +121 -121
- package/test/dom/navigation.test.ts +59 -59
- package/test/dom/revalidate.test.tsx +38 -38
- package/test/dom/route-head.test.tsx +78 -78
- package/test/dom/router-loading.test.tsx +44 -44
- package/test/dom/scroll.test.ts +56 -56
- package/test/dom/use-metadata.test.tsx +58 -0
- package/test/io.test.ts +93 -93
- package/test/navlink.test.ts +28 -28
- package/test/placeholder.test.ts +9 -9
- package/test/routes.test.ts +76 -76
- package/test/seo.test.ts +175 -164
- package/test/slot-layouts.test.ts +69 -69
- package/test/ssg.test.ts +36 -0
- package/test/update.test.ts +44 -44
- package/test/validate.test.ts +42 -42
- package/toil-routes.d.ts +7 -0
- package/toilconfig.json +30 -30
- package/tsconfig.backend.json +13 -13
- package/tsconfig.base.json +35 -35
- package/tsconfig.cli.json +13 -13
- package/tsconfig.client.json +14 -14
- package/tsconfig.compiler.json +13 -13
- package/tsconfig.io.json +12 -12
- package/tsconfig.json +22 -22
- package/tsconfig.logger.json +12 -12
- package/tsconfig.server.json +10 -10
- package/tsconfig.shared.json +12 -12
- package/vitest.config.ts +26 -26
- package/.idea/codeStyles/Project.xml +0 -54
- package/.idea/codeStyles/codeStyleConfig.xml +0 -5
- package/.idea/inspectionProfiles/Project_Default.xml +0 -6
- package/.idea/modules.xml +0 -8
- package/.idea/prettier.xml +0 -7
- package/.idea/toiljs.iml +0 -8
- package/.idea/vcs.xml +0 -6
- package/.toil/entry.tsx +0 -9
- package/.toil/index.html +0 -12
- package/.toil/routes.ts +0 -9
- package/build/cli/configure.d.ts +0 -16
- package/build/cli/configure.js +0 -272
- package/build/cli/create.d.ts +0 -16
- package/build/cli/create.js +0 -420
- package/build/cli/diagnostics.d.ts +0 -55
- package/build/cli/diagnostics.js +0 -333
- package/build/cli/doctor.d.ts +0 -6
- package/build/cli/doctor.js +0 -249
- package/build/cli/features.d.ts +0 -25
- package/build/cli/features.js +0 -107
- package/build/cli/index.d.ts +0 -2
- package/build/cli/proc.d.ts +0 -6
- package/build/cli/proc.js +0 -31
- package/build/cli/ui.d.ts +0 -9
- package/build/cli/ui.js +0 -75
- package/build/cli/update.d.ts +0 -7
- package/build/cli/update.js +0 -117
- package/build/cli/updates.d.ts +0 -10
- package/build/cli/updates.js +0 -45
- package/build/cli/validate.d.ts +0 -4
- package/build/cli/validate.js +0 -19
- package/build/client/Link.d.ts +0 -8
- package/build/client/Link.js +0 -44
- package/build/client/NavLink.d.ts +0 -14
- package/build/client/NavLink.js +0 -37
- package/build/client/Router.d.ts +0 -7
- package/build/client/Router.js +0 -55
- package/build/client/channel.d.ts +0 -23
- package/build/client/channel.js +0 -94
- package/build/client/error-boundary.d.ts +0 -16
- package/build/client/error-boundary.js +0 -19
- package/build/client/head.d.ts +0 -26
- package/build/client/head.js +0 -87
- package/build/client/hooks.d.ts +0 -17
- package/build/client/hooks.js +0 -48
- package/build/client/lazy.d.ts +0 -16
- package/build/client/lazy.js +0 -53
- package/build/client/match.d.ts +0 -2
- package/build/client/match.js +0 -32
- package/build/client/mount.d.ts +0 -2
- package/build/client/mount.js +0 -13
- package/build/client/navigation.d.ts +0 -13
- package/build/client/navigation.js +0 -97
- package/build/client/params-context.d.ts +0 -2
- package/build/client/params-context.js +0 -2
- package/build/client/prefetch.d.ts +0 -11
- package/build/client/prefetch.js +0 -100
- package/build/client/runtime.d.ts +0 -31
- package/build/client/runtime.js +0 -112
- package/build/client/scroll.d.ts +0 -8
- package/build/client/scroll.js +0 -36
- package/toil-env.d.ts +0 -16
package/test/navlink.test.ts
CHANGED
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
import { describe, expect, it } from 'vitest';
|
|
2
|
-
|
|
3
|
-
import { matchActive } from '../src/client/navigation/NavLink';
|
|
4
|
-
|
|
5
|
-
describe('matchActive', () => {
|
|
6
|
-
it('matches exact paths', () => {
|
|
7
|
-
expect(matchActive('/about', '/about', false)).toBe(true);
|
|
8
|
-
expect(matchActive('/about', '/about/', false)).toBe(true);
|
|
9
|
-
expect(matchActive('/about', '/contact', false)).toBe(false);
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
it('matches sub-paths when not exact (end=false)', () => {
|
|
13
|
-
expect(matchActive('/blog', '/blog/42', false)).toBe(true);
|
|
14
|
-
expect(matchActive('/blog', '/blog', false)).toBe(true);
|
|
15
|
-
expect(matchActive('/blog', '/blogger', false)).toBe(false);
|
|
16
|
-
});
|
|
17
|
-
|
|
18
|
-
it('honors end for exact-only matching', () => {
|
|
19
|
-
expect(matchActive('/blog', '/blog/42', true)).toBe(false);
|
|
20
|
-
expect(matchActive('/blog', '/blog', true)).toBe(true);
|
|
21
|
-
});
|
|
22
|
-
|
|
23
|
-
it('treats "/" as active everywhere unless end', () => {
|
|
24
|
-
expect(matchActive('/', '/anything/deep', false)).toBe(true);
|
|
25
|
-
expect(matchActive('/', '/anything', true)).toBe(false);
|
|
26
|
-
expect(matchActive('/', '/', true)).toBe(true);
|
|
27
|
-
});
|
|
28
|
-
});
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
|
|
3
|
+
import { matchActive } from '../src/client/navigation/NavLink';
|
|
4
|
+
|
|
5
|
+
describe('matchActive', () => {
|
|
6
|
+
it('matches exact paths', () => {
|
|
7
|
+
expect(matchActive('/about', '/about', false)).toBe(true);
|
|
8
|
+
expect(matchActive('/about', '/about/', false)).toBe(true);
|
|
9
|
+
expect(matchActive('/about', '/contact', false)).toBe(false);
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
it('matches sub-paths when not exact (end=false)', () => {
|
|
13
|
+
expect(matchActive('/blog', '/blog/42', false)).toBe(true);
|
|
14
|
+
expect(matchActive('/blog', '/blog', false)).toBe(true);
|
|
15
|
+
expect(matchActive('/blog', '/blogger', false)).toBe(false);
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it('honors end for exact-only matching', () => {
|
|
19
|
+
expect(matchActive('/blog', '/blog/42', true)).toBe(false);
|
|
20
|
+
expect(matchActive('/blog', '/blog', true)).toBe(true);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('treats "/" as active everywhere unless end', () => {
|
|
24
|
+
expect(matchActive('/', '/anything/deep', false)).toBe(true);
|
|
25
|
+
expect(matchActive('/', '/anything', true)).toBe(false);
|
|
26
|
+
expect(matchActive('/', '/', true)).toBe(true);
|
|
27
|
+
});
|
|
28
|
+
});
|
package/test/placeholder.test.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { describe, expect, it } from 'vitest';
|
|
2
|
-
|
|
3
|
-
import { FRAMEWORK_NAME } from '../src/shared/index';
|
|
4
|
-
|
|
5
|
-
describe('toiljs scaffold', () => {
|
|
6
|
-
it('exposes the framework name', () => {
|
|
7
|
-
expect(FRAMEWORK_NAME).toBe('toiljs');
|
|
8
|
-
});
|
|
9
|
-
});
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
|
|
3
|
+
import { FRAMEWORK_NAME } from '../src/shared/index';
|
|
4
|
+
|
|
5
|
+
describe('toiljs scaffold', () => {
|
|
6
|
+
it('exposes the framework name', () => {
|
|
7
|
+
expect(FRAMEWORK_NAME).toBe('toiljs');
|
|
8
|
+
});
|
|
9
|
+
});
|
package/test/routes.test.ts
CHANGED
|
@@ -1,76 +1,76 @@
|
|
|
1
|
-
import { describe, expect, it } from 'vitest';
|
|
2
|
-
|
|
3
|
-
import { matchRoute } from '../src/client/routing/match';
|
|
4
|
-
import { filePathToRoute, interceptTarget } from '../src/compiler/routes';
|
|
5
|
-
|
|
6
|
-
describe('filePathToRoute', () => {
|
|
7
|
-
it('maps index, static, nested, and dynamic files to patterns', () => {
|
|
8
|
-
expect(filePathToRoute('index.tsx')).toBe('/');
|
|
9
|
-
expect(filePathToRoute('about.tsx')).toBe('/about');
|
|
10
|
-
expect(filePathToRoute('blog/index.tsx')).toBe('/blog');
|
|
11
|
-
expect(filePathToRoute('blog/[id].tsx')).toBe('/blog/:id');
|
|
12
|
-
expect(filePathToRoute('docs/guide/intro.jsx')).toBe('/docs/guide/intro');
|
|
13
|
-
expect(filePathToRoute('docs/[...slug].tsx')).toBe('/docs/*slug');
|
|
14
|
-
});
|
|
15
|
-
|
|
16
|
-
it('maps optional catch-all and strips route groups', () => {
|
|
17
|
-
expect(filePathToRoute('docs/[[...slug]].tsx')).toBe('/docs/**slug');
|
|
18
|
-
expect(filePathToRoute('[[...slug]].tsx')).toBe('/**slug');
|
|
19
|
-
expect(filePathToRoute('(marketing)/about.tsx')).toBe('/about');
|
|
20
|
-
expect(filePathToRoute('(shop)/index.tsx')).toBe('/');
|
|
21
|
-
expect(filePathToRoute('(a)/(b)/deep.tsx')).toBe('/deep');
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
it('strips parallel-slot (@slot) segments from the URL', () => {
|
|
25
|
-
expect(filePathToRoute('@modal/photo/[id].tsx')).toBe('/photo/:id');
|
|
26
|
-
expect(filePathToRoute('@sidebar/index.tsx')).toBe('/');
|
|
27
|
-
expect(filePathToRoute('dashboard/@chart/views.tsx')).toBe('/dashboard/views');
|
|
28
|
-
});
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
describe('interceptTarget', () => {
|
|
32
|
-
it('resolves (.)/(..)/(...) marker targets', () => {
|
|
33
|
-
expect(interceptTarget('@modal/(.)photo/[id].tsx')).toBe('/photo/:id');
|
|
34
|
-
expect(interceptTarget('feed/@modal/(..)photo/[id].tsx')).toBe('/photo/:id');
|
|
35
|
-
expect(interceptTarget('a/b/@m/(...)login.tsx')).toBe('/login');
|
|
36
|
-
});
|
|
37
|
-
|
|
38
|
-
it('returns null for routes with no interception marker', () => {
|
|
39
|
-
expect(interceptTarget('photo/[id].tsx')).toBeNull();
|
|
40
|
-
expect(interceptTarget('@modal/settings.tsx')).toBeNull();
|
|
41
|
-
});
|
|
42
|
-
});
|
|
43
|
-
|
|
44
|
-
describe('matchRoute', () => {
|
|
45
|
-
it('matches static routes', () => {
|
|
46
|
-
expect(matchRoute('/', '/')).toEqual({});
|
|
47
|
-
expect(matchRoute('/about', '/about')).toEqual({});
|
|
48
|
-
});
|
|
49
|
-
|
|
50
|
-
it('rejects non-matches', () => {
|
|
51
|
-
expect(matchRoute('/about', '/x')).toBeNull();
|
|
52
|
-
expect(matchRoute('/blog/:id', '/blog')).toBeNull();
|
|
53
|
-
expect(matchRoute('/', '/about')).toBeNull();
|
|
54
|
-
});
|
|
55
|
-
|
|
56
|
-
it('extracts dynamic params', () => {
|
|
57
|
-
expect(matchRoute('/blog/:id', '/blog/42')).toEqual({ id: '42' });
|
|
58
|
-
expect(matchRoute('/u/:user/p/:post', '/u/ann/p/7')).toEqual({ user: 'ann', post: '7' });
|
|
59
|
-
expect(matchRoute('/blog/:id', '/blog/a%20b')).toEqual({ id: 'a b' });
|
|
60
|
-
});
|
|
61
|
-
|
|
62
|
-
it('captures the tail with catch-all routes', () => {
|
|
63
|
-
expect(matchRoute('/docs/*slug', '/docs/a/b/c')).toEqual({ slug: 'a/b/c' });
|
|
64
|
-
expect(matchRoute('/docs/*slug', '/docs/intro')).toEqual({ slug: 'intro' });
|
|
65
|
-
expect(matchRoute('/files/*path', '/files/a%20b/c')).toEqual({ path: 'a b/c' });
|
|
66
|
-
// catch-all needs at least one trailing segment
|
|
67
|
-
expect(matchRoute('/docs/*slug', '/docs')).toBeNull();
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
it('matches optional catch-all with zero or more segments', () => {
|
|
71
|
-
expect(matchRoute('/docs/**slug', '/docs')).toEqual({ slug: '' });
|
|
72
|
-
expect(matchRoute('/docs/**slug', '/docs/a/b')).toEqual({ slug: 'a/b' });
|
|
73
|
-
expect(matchRoute('/**slug', '/')).toEqual({ slug: '' });
|
|
74
|
-
expect(matchRoute('/**slug', '/x/y')).toEqual({ slug: 'x/y' });
|
|
75
|
-
});
|
|
76
|
-
});
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
|
|
3
|
+
import { matchRoute } from '../src/client/routing/match';
|
|
4
|
+
import { filePathToRoute, interceptTarget } from '../src/compiler/routes';
|
|
5
|
+
|
|
6
|
+
describe('filePathToRoute', () => {
|
|
7
|
+
it('maps index, static, nested, and dynamic files to patterns', () => {
|
|
8
|
+
expect(filePathToRoute('index.tsx')).toBe('/');
|
|
9
|
+
expect(filePathToRoute('about.tsx')).toBe('/about');
|
|
10
|
+
expect(filePathToRoute('blog/index.tsx')).toBe('/blog');
|
|
11
|
+
expect(filePathToRoute('blog/[id].tsx')).toBe('/blog/:id');
|
|
12
|
+
expect(filePathToRoute('docs/guide/intro.jsx')).toBe('/docs/guide/intro');
|
|
13
|
+
expect(filePathToRoute('docs/[...slug].tsx')).toBe('/docs/*slug');
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
it('maps optional catch-all and strips route groups', () => {
|
|
17
|
+
expect(filePathToRoute('docs/[[...slug]].tsx')).toBe('/docs/**slug');
|
|
18
|
+
expect(filePathToRoute('[[...slug]].tsx')).toBe('/**slug');
|
|
19
|
+
expect(filePathToRoute('(marketing)/about.tsx')).toBe('/about');
|
|
20
|
+
expect(filePathToRoute('(shop)/index.tsx')).toBe('/');
|
|
21
|
+
expect(filePathToRoute('(a)/(b)/deep.tsx')).toBe('/deep');
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it('strips parallel-slot (@slot) segments from the URL', () => {
|
|
25
|
+
expect(filePathToRoute('@modal/photo/[id].tsx')).toBe('/photo/:id');
|
|
26
|
+
expect(filePathToRoute('@sidebar/index.tsx')).toBe('/');
|
|
27
|
+
expect(filePathToRoute('dashboard/@chart/views.tsx')).toBe('/dashboard/views');
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
describe('interceptTarget', () => {
|
|
32
|
+
it('resolves (.)/(..)/(...) marker targets', () => {
|
|
33
|
+
expect(interceptTarget('@modal/(.)photo/[id].tsx')).toBe('/photo/:id');
|
|
34
|
+
expect(interceptTarget('feed/@modal/(..)photo/[id].tsx')).toBe('/photo/:id');
|
|
35
|
+
expect(interceptTarget('a/b/@m/(...)login.tsx')).toBe('/login');
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
it('returns null for routes with no interception marker', () => {
|
|
39
|
+
expect(interceptTarget('photo/[id].tsx')).toBeNull();
|
|
40
|
+
expect(interceptTarget('@modal/settings.tsx')).toBeNull();
|
|
41
|
+
});
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
describe('matchRoute', () => {
|
|
45
|
+
it('matches static routes', () => {
|
|
46
|
+
expect(matchRoute('/', '/')).toEqual({});
|
|
47
|
+
expect(matchRoute('/about', '/about')).toEqual({});
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it('rejects non-matches', () => {
|
|
51
|
+
expect(matchRoute('/about', '/x')).toBeNull();
|
|
52
|
+
expect(matchRoute('/blog/:id', '/blog')).toBeNull();
|
|
53
|
+
expect(matchRoute('/', '/about')).toBeNull();
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
it('extracts dynamic params', () => {
|
|
57
|
+
expect(matchRoute('/blog/:id', '/blog/42')).toEqual({ id: '42' });
|
|
58
|
+
expect(matchRoute('/u/:user/p/:post', '/u/ann/p/7')).toEqual({ user: 'ann', post: '7' });
|
|
59
|
+
expect(matchRoute('/blog/:id', '/blog/a%20b')).toEqual({ id: 'a b' });
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
it('captures the tail with catch-all routes', () => {
|
|
63
|
+
expect(matchRoute('/docs/*slug', '/docs/a/b/c')).toEqual({ slug: 'a/b/c' });
|
|
64
|
+
expect(matchRoute('/docs/*slug', '/docs/intro')).toEqual({ slug: 'intro' });
|
|
65
|
+
expect(matchRoute('/files/*path', '/files/a%20b/c')).toEqual({ path: 'a b/c' });
|
|
66
|
+
// catch-all needs at least one trailing segment
|
|
67
|
+
expect(matchRoute('/docs/*slug', '/docs')).toBeNull();
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
it('matches optional catch-all with zero or more segments', () => {
|
|
71
|
+
expect(matchRoute('/docs/**slug', '/docs')).toEqual({ slug: '' });
|
|
72
|
+
expect(matchRoute('/docs/**slug', '/docs/a/b')).toEqual({ slug: 'a/b' });
|
|
73
|
+
expect(matchRoute('/**slug', '/')).toEqual({ slug: '' });
|
|
74
|
+
expect(matchRoute('/**slug', '/x/y')).toEqual({ slug: 'x/y' });
|
|
75
|
+
});
|
|
76
|
+
});
|
package/test/seo.test.ts
CHANGED
|
@@ -1,164 +1,175 @@
|
|
|
1
|
-
import { describe, expect, it } from 'vitest';
|
|
2
|
-
|
|
3
|
-
import type { ScannedRoute } from '../src/compiler/routes';
|
|
4
|
-
import {
|
|
5
|
-
injectSeoHtml,
|
|
6
|
-
llmsTxt,
|
|
7
|
-
robotsTxt,
|
|
8
|
-
routeSeo,
|
|
9
|
-
seoHeadTags,
|
|
10
|
-
sitemapXml,
|
|
11
|
-
} from '../src/compiler/seo';
|
|
12
|
-
|
|
13
|
-
const routes: ScannedRoute[] = [
|
|
14
|
-
{ file: 'a', pattern: '/' },
|
|
15
|
-
{ file: 'b', pattern: '/about' },
|
|
16
|
-
{ file: 'c', pattern: '/blog/:id' }, // dynamic, excluded from sitemap
|
|
17
|
-
{ file: 'd', pattern: '/photo/:id', slot: 'modal', intercept: true }, // slot/intercept, excluded
|
|
18
|
-
];
|
|
19
|
-
|
|
20
|
-
describe('seoHeadTags', () => {
|
|
21
|
-
it('bakes description, OG, canonical, preconnect, and JSON-LD', () => {
|
|
22
|
-
const html = seoHeadTags({
|
|
23
|
-
url: 'https://x.test',
|
|
24
|
-
title: 'Home',
|
|
25
|
-
description: 'desc',
|
|
26
|
-
openGraph: { type: 'website', image: 'https://x.test/og.png' },
|
|
27
|
-
preconnect: ['https://cdn.test'],
|
|
28
|
-
jsonLd: { '@context': 'https://schema.org', '@type': 'WebSite' },
|
|
29
|
-
});
|
|
30
|
-
expect(html).toContain('<meta name="description" content="desc" />');
|
|
31
|
-
expect(html).toContain('<meta property="og:title" content="Home" />');
|
|
32
|
-
expect(html).toContain('<meta property="og:image" content="https://x.test/og.png" />');
|
|
33
|
-
expect(html).toContain('<link rel="canonical" href="https://x.test" />');
|
|
34
|
-
expect(html).toContain('<link rel="preconnect" href="https://cdn.test" />');
|
|
35
|
-
expect(html).toContain('application/ld+json');
|
|
36
|
-
expect(html).toContain('"@type":"WebSite"');
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
it('escapes attribute values', () => {
|
|
40
|
-
expect(seoHeadTags({ description: 'a "b" <c>' })).toContain(
|
|
41
|
-
'content="a "b" <c>"',
|
|
42
|
-
);
|
|
43
|
-
});
|
|
44
|
-
|
|
45
|
-
it('renders a full Twitter card + OG image dimensions + fb:app_id', () => {
|
|
46
|
-
const html = seoHeadTags({
|
|
47
|
-
title: 'Home',
|
|
48
|
-
description: 'd',
|
|
49
|
-
openGraph: {
|
|
50
|
-
image: 'https://x.test/og.png',
|
|
51
|
-
imageAlt: 'alt',
|
|
52
|
-
imageWidth: 1200,
|
|
53
|
-
imageHeight: 630,
|
|
54
|
-
},
|
|
55
|
-
twitter: { site: '@x' },
|
|
56
|
-
facebook: { appId: '123' },
|
|
57
|
-
});
|
|
58
|
-
expect(html).toContain('<meta name="twitter:card" content="summary_large_image" />');
|
|
59
|
-
expect(html).toContain('<meta name="twitter:site" content="@x" />');
|
|
60
|
-
expect(html).toContain('<meta name="twitter:title" content="Home" />');
|
|
61
|
-
expect(html).toContain('<meta name="twitter:image" content="https://x.test/og.png" />');
|
|
62
|
-
expect(html).toContain('<meta property="og:image:width" content="1200" />');
|
|
63
|
-
expect(html).toContain('<meta property="og:image:alt" content="alt" />');
|
|
64
|
-
expect(html).toContain('<meta property="fb:app_id" content="123" />');
|
|
65
|
-
});
|
|
66
|
-
|
|
67
|
-
it('neutralizes </script> in JSON-LD (no script breakout)', () => {
|
|
68
|
-
const html = seoHeadTags({ jsonLd: { x: '</script><img src=x onerror=alert(1)>' } });
|
|
69
|
-
expect(html).not.toContain('</script><img');
|
|
70
|
-
expect(html).toContain('\\u003c/script');
|
|
71
|
-
});
|
|
72
|
-
});
|
|
73
|
-
|
|
74
|
-
describe('routeSeo', () => {
|
|
75
|
-
it("overlays a route's metadata over the site defaults and points URLs at the route", () => {
|
|
76
|
-
const site = { url: 'https://x.test', title: 'Site', description: 'site desc' };
|
|
77
|
-
const out = routeSeo(site, { title: 'About', description: 'about desc' }, '/about');
|
|
78
|
-
expect(out.title).toBe('About');
|
|
79
|
-
expect(out.description).toBe('about desc');
|
|
80
|
-
expect(out.url).toBe('https://x.test/about');
|
|
81
|
-
});
|
|
82
|
-
|
|
83
|
-
it('falls back to the site defaults when a route has no metadata', () => {
|
|
84
|
-
const site = { url: 'https://x.test', title: 'Site' };
|
|
85
|
-
expect(routeSeo(site, null, '/x')).toMatchObject({
|
|
86
|
-
title: 'Site',
|
|
87
|
-
url: 'https://x.test/x',
|
|
88
|
-
});
|
|
89
|
-
});
|
|
90
|
-
});
|
|
91
|
-
|
|
92
|
-
describe('injectSeoHtml', () => {
|
|
93
|
-
it('replaces the title + description and inserts the rest before </head>', () => {
|
|
94
|
-
const shell =
|
|
95
|
-
'<!doctype html><html><head><title>old</title><meta name="description" content="" /></head><body></body></html>';
|
|
96
|
-
const out = injectSeoHtml(shell, {
|
|
97
|
-
title: 'New',
|
|
98
|
-
description: 'fresh',
|
|
99
|
-
url: 'https://x.test',
|
|
100
|
-
});
|
|
101
|
-
expect(out).toContain('<title>New</title>');
|
|
102
|
-
expect(out).not.toContain('<title>old</title>');
|
|
103
|
-
expect(out.match(/name="description"/g)).toHaveLength(1);
|
|
104
|
-
expect(out).toContain('content="fresh"');
|
|
105
|
-
expect(out).toContain('<link rel="canonical" href="https://x.test" />');
|
|
106
|
-
});
|
|
107
|
-
});
|
|
108
|
-
|
|
109
|
-
describe('robotsTxt', () => {
|
|
110
|
-
it('allows all + lists AI crawlers + links the sitemap by default', () => {
|
|
111
|
-
const txt = robotsTxt({ url: 'https://x.test' });
|
|
112
|
-
expect(txt).toContain('User-agent: *');
|
|
113
|
-
expect(txt).toContain('Allow: /');
|
|
114
|
-
expect(txt).toContain('User-agent: GPTBot');
|
|
115
|
-
expect(txt).toContain('User-agent: ClaudeBot');
|
|
116
|
-
expect(txt).toContain('Sitemap: https://x.test/sitemap.xml');
|
|
117
|
-
});
|
|
118
|
-
|
|
119
|
-
it('disallows AI crawlers when ai: "disallow"', () => {
|
|
120
|
-
const txt = robotsTxt({ url: 'https://x.test', robots: { ai: 'disallow' } });
|
|
121
|
-
expect(txt).toMatch(/User-agent: GPTBot\nDisallow: \//);
|
|
122
|
-
});
|
|
123
|
-
|
|
124
|
-
it('is empty when robots: false', () => {
|
|
125
|
-
expect(robotsTxt({ robots: false })).toBe('');
|
|
126
|
-
});
|
|
127
|
-
});
|
|
128
|
-
|
|
129
|
-
describe('sitemapXml', () => {
|
|
130
|
-
it('lists only static routes, absolute', () => {
|
|
131
|
-
const xml = sitemapXml({ url: 'https://x.test' }, routes);
|
|
132
|
-
expect(xml).toContain('<loc>https://x.test</loc>');
|
|
133
|
-
expect(xml).toContain('<loc>https://x.test/about</loc>');
|
|
134
|
-
expect(xml).not.toContain(':id');
|
|
135
|
-
expect(xml).not.toContain('/photo');
|
|
136
|
-
});
|
|
137
|
-
|
|
138
|
-
it('is empty without a base url', () => {
|
|
139
|
-
expect(sitemapXml({}, routes)).toBe('');
|
|
140
|
-
});
|
|
141
|
-
});
|
|
142
|
-
|
|
143
|
-
describe('llmsTxt', () => {
|
|
144
|
-
it('renders title, summary, instructions, and pages', () => {
|
|
145
|
-
const txt = llmsTxt(
|
|
146
|
-
{
|
|
147
|
-
url: 'https://x.test',
|
|
148
|
-
title: 'My Site',
|
|
149
|
-
description: 'a site',
|
|
150
|
-
llms: { instructions: 'Be nice.' },
|
|
151
|
-
},
|
|
152
|
-
routes,
|
|
153
|
-
);
|
|
154
|
-
expect(txt).toContain('# My Site');
|
|
155
|
-
expect(txt).toContain('> a site');
|
|
156
|
-
expect(txt).toContain('Be nice.');
|
|
157
|
-
expect(txt).toContain('[Home](https://x.test)');
|
|
158
|
-
expect(txt).toContain('[/about](https://x.test/about)');
|
|
159
|
-
});
|
|
160
|
-
|
|
161
|
-
it('is empty when llms: false', () => {
|
|
162
|
-
expect(llmsTxt({ llms: false }, routes)).toBe('');
|
|
163
|
-
});
|
|
164
|
-
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
|
|
3
|
+
import type { ScannedRoute } from '../src/compiler/routes';
|
|
4
|
+
import {
|
|
5
|
+
injectSeoHtml,
|
|
6
|
+
llmsTxt,
|
|
7
|
+
robotsTxt,
|
|
8
|
+
routeSeo,
|
|
9
|
+
seoHeadTags,
|
|
10
|
+
sitemapXml,
|
|
11
|
+
} from '../src/compiler/seo';
|
|
12
|
+
|
|
13
|
+
const routes: ScannedRoute[] = [
|
|
14
|
+
{ file: 'a', pattern: '/' },
|
|
15
|
+
{ file: 'b', pattern: '/about' },
|
|
16
|
+
{ file: 'c', pattern: '/blog/:id' }, // dynamic, excluded from sitemap
|
|
17
|
+
{ file: 'd', pattern: '/photo/:id', slot: 'modal', intercept: true }, // slot/intercept, excluded
|
|
18
|
+
];
|
|
19
|
+
|
|
20
|
+
describe('seoHeadTags', () => {
|
|
21
|
+
it('bakes description, OG, canonical, preconnect, and JSON-LD', () => {
|
|
22
|
+
const html = seoHeadTags({
|
|
23
|
+
url: 'https://x.test',
|
|
24
|
+
title: 'Home',
|
|
25
|
+
description: 'desc',
|
|
26
|
+
openGraph: { type: 'website', image: 'https://x.test/og.png' },
|
|
27
|
+
preconnect: ['https://cdn.test'],
|
|
28
|
+
jsonLd: { '@context': 'https://schema.org', '@type': 'WebSite' },
|
|
29
|
+
});
|
|
30
|
+
expect(html).toContain('<meta name="description" content="desc" />');
|
|
31
|
+
expect(html).toContain('<meta property="og:title" content="Home" />');
|
|
32
|
+
expect(html).toContain('<meta property="og:image" content="https://x.test/og.png" />');
|
|
33
|
+
expect(html).toContain('<link rel="canonical" href="https://x.test" />');
|
|
34
|
+
expect(html).toContain('<link rel="preconnect" href="https://cdn.test" />');
|
|
35
|
+
expect(html).toContain('application/ld+json');
|
|
36
|
+
expect(html).toContain('"@type":"WebSite"');
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('escapes attribute values', () => {
|
|
40
|
+
expect(seoHeadTags({ description: 'a "b" <c>' })).toContain(
|
|
41
|
+
'content="a "b" <c>"',
|
|
42
|
+
);
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it('renders a full Twitter card + OG image dimensions + fb:app_id', () => {
|
|
46
|
+
const html = seoHeadTags({
|
|
47
|
+
title: 'Home',
|
|
48
|
+
description: 'd',
|
|
49
|
+
openGraph: {
|
|
50
|
+
image: 'https://x.test/og.png',
|
|
51
|
+
imageAlt: 'alt',
|
|
52
|
+
imageWidth: 1200,
|
|
53
|
+
imageHeight: 630,
|
|
54
|
+
},
|
|
55
|
+
twitter: { site: '@x' },
|
|
56
|
+
facebook: { appId: '123' },
|
|
57
|
+
});
|
|
58
|
+
expect(html).toContain('<meta name="twitter:card" content="summary_large_image" />');
|
|
59
|
+
expect(html).toContain('<meta name="twitter:site" content="@x" />');
|
|
60
|
+
expect(html).toContain('<meta name="twitter:title" content="Home" />');
|
|
61
|
+
expect(html).toContain('<meta name="twitter:image" content="https://x.test/og.png" />');
|
|
62
|
+
expect(html).toContain('<meta property="og:image:width" content="1200" />');
|
|
63
|
+
expect(html).toContain('<meta property="og:image:alt" content="alt" />');
|
|
64
|
+
expect(html).toContain('<meta property="fb:app_id" content="123" />');
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
it('neutralizes </script> in JSON-LD (no script breakout)', () => {
|
|
68
|
+
const html = seoHeadTags({ jsonLd: { x: '</script><img src=x onerror=alert(1)>' } });
|
|
69
|
+
expect(html).not.toContain('</script><img');
|
|
70
|
+
expect(html).toContain('\\u003c/script');
|
|
71
|
+
});
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
describe('routeSeo', () => {
|
|
75
|
+
it("overlays a route's metadata over the site defaults and points URLs at the route", () => {
|
|
76
|
+
const site = { url: 'https://x.test', title: 'Site', description: 'site desc' };
|
|
77
|
+
const out = routeSeo(site, { title: 'About', description: 'about desc' }, '/about');
|
|
78
|
+
expect(out.title).toBe('About');
|
|
79
|
+
expect(out.description).toBe('about desc');
|
|
80
|
+
expect(out.url).toBe('https://x.test/about');
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
it('falls back to the site defaults when a route has no metadata', () => {
|
|
84
|
+
const site = { url: 'https://x.test', title: 'Site' };
|
|
85
|
+
expect(routeSeo(site, null, '/x')).toMatchObject({
|
|
86
|
+
title: 'Site',
|
|
87
|
+
url: 'https://x.test/x',
|
|
88
|
+
});
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
describe('injectSeoHtml', () => {
|
|
93
|
+
it('replaces the title + description and inserts the rest before </head>', () => {
|
|
94
|
+
const shell =
|
|
95
|
+
'<!doctype html><html><head><title>old</title><meta name="description" content="" /></head><body></body></html>';
|
|
96
|
+
const out = injectSeoHtml(shell, {
|
|
97
|
+
title: 'New',
|
|
98
|
+
description: 'fresh',
|
|
99
|
+
url: 'https://x.test',
|
|
100
|
+
});
|
|
101
|
+
expect(out).toContain('<title>New</title>');
|
|
102
|
+
expect(out).not.toContain('<title>old</title>');
|
|
103
|
+
expect(out.match(/name="description"/g)).toHaveLength(1);
|
|
104
|
+
expect(out).toContain('content="fresh"');
|
|
105
|
+
expect(out).toContain('<link rel="canonical" href="https://x.test" />');
|
|
106
|
+
});
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
describe('robotsTxt', () => {
|
|
110
|
+
it('allows all + lists AI crawlers + links the sitemap by default', () => {
|
|
111
|
+
const txt = robotsTxt({ url: 'https://x.test' });
|
|
112
|
+
expect(txt).toContain('User-agent: *');
|
|
113
|
+
expect(txt).toContain('Allow: /');
|
|
114
|
+
expect(txt).toContain('User-agent: GPTBot');
|
|
115
|
+
expect(txt).toContain('User-agent: ClaudeBot');
|
|
116
|
+
expect(txt).toContain('Sitemap: https://x.test/sitemap.xml');
|
|
117
|
+
});
|
|
118
|
+
|
|
119
|
+
it('disallows AI crawlers when ai: "disallow"', () => {
|
|
120
|
+
const txt = robotsTxt({ url: 'https://x.test', robots: { ai: 'disallow' } });
|
|
121
|
+
expect(txt).toMatch(/User-agent: GPTBot\nDisallow: \//);
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
it('is empty when robots: false', () => {
|
|
125
|
+
expect(robotsTxt({ robots: false })).toBe('');
|
|
126
|
+
});
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
describe('sitemapXml', () => {
|
|
130
|
+
it('lists only static routes, absolute', () => {
|
|
131
|
+
const xml = sitemapXml({ url: 'https://x.test' }, routes);
|
|
132
|
+
expect(xml).toContain('<loc>https://x.test</loc>');
|
|
133
|
+
expect(xml).toContain('<loc>https://x.test/about</loc>');
|
|
134
|
+
expect(xml).not.toContain(':id');
|
|
135
|
+
expect(xml).not.toContain('/photo');
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
it('is empty without a base url', () => {
|
|
139
|
+
expect(sitemapXml({}, routes)).toBe('');
|
|
140
|
+
});
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
describe('llmsTxt', () => {
|
|
144
|
+
it('renders title, summary, instructions, and pages', () => {
|
|
145
|
+
const txt = llmsTxt(
|
|
146
|
+
{
|
|
147
|
+
url: 'https://x.test',
|
|
148
|
+
title: 'My Site',
|
|
149
|
+
description: 'a site',
|
|
150
|
+
llms: { instructions: 'Be nice.' },
|
|
151
|
+
},
|
|
152
|
+
routes,
|
|
153
|
+
);
|
|
154
|
+
expect(txt).toContain('# My Site');
|
|
155
|
+
expect(txt).toContain('> a site');
|
|
156
|
+
expect(txt).toContain('Be nice.');
|
|
157
|
+
expect(txt).toContain('[Home](https://x.test)');
|
|
158
|
+
expect(txt).toContain('[/about](https://x.test/about)');
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
it('is empty when llms: false', () => {
|
|
162
|
+
expect(llmsTxt({ llms: false }, routes)).toBe('');
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it('renders a supplied page list (titles + descriptions, e.g. SSG pages) over the static paths', () => {
|
|
166
|
+
const txt = llmsTxt({ url: 'https://x.test', title: 'Docs' }, routes, [
|
|
167
|
+
{ title: 'useReducer | React Hooks', url: 'https://x.test/hooks/usereducer', description: 'A reducer.' },
|
|
168
|
+
{ title: 'About', url: 'https://x.test/about' },
|
|
169
|
+
]);
|
|
170
|
+
expect(txt).toContain('[useReducer | React Hooks](https://x.test/hooks/usereducer): A reducer.');
|
|
171
|
+
expect(txt).toContain('[About](https://x.test/about)');
|
|
172
|
+
// the supplied list replaces the bare static-path fallback
|
|
173
|
+
expect(txt).not.toContain('[Home](https://x.test)');
|
|
174
|
+
});
|
|
175
|
+
});
|