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.
Files changed (225) hide show
  1. package/.babelrc +13 -13
  2. package/.gitattributes +2 -2
  3. package/.github/ISSUE_TEMPLATE/bug_report.md +38 -38
  4. package/.github/ISSUE_TEMPLATE/bug_report.yml +90 -90
  5. package/.github/ISSUE_TEMPLATE/config.yml +8 -8
  6. package/.github/ISSUE_TEMPLATE/feature_request.md +20 -20
  7. package/.github/PULL_REQUEST_TEMPLATE.md +43 -43
  8. package/.github/changelog-config.json +45 -45
  9. package/.github/dependabot.yml +27 -27
  10. package/.github/workflows/ci.yml +191 -191
  11. package/.prettierrc.json +11 -11
  12. package/.vscode/settings.json +9 -9
  13. package/CHANGELOG.md +5 -5
  14. package/LICENSE +187 -187
  15. package/README.md +339 -315
  16. package/as-pect.asconfig.json +34 -34
  17. package/as-pect.config.js +65 -65
  18. package/assets/logo.svg +36 -36
  19. package/build/backend/.tsbuildinfo +1 -1
  20. package/build/cli/.tsbuildinfo +1 -1
  21. package/build/cli/index.js +2926 -191
  22. package/build/client/.tsbuildinfo +1 -1
  23. package/build/client/dev/devtools.d.ts +6 -0
  24. package/build/client/dev/devtools.js +442 -0
  25. package/build/client/dev/error-overlay.d.ts +9 -0
  26. package/build/client/dev/error-overlay.js +19 -4
  27. package/build/client/head/metadata.d.ts +3 -1
  28. package/build/client/head/metadata.js +8 -0
  29. package/build/client/index.d.ts +4 -4
  30. package/build/client/index.js +2 -2
  31. package/build/client/navigation/navigation.d.ts +2 -0
  32. package/build/client/navigation/navigation.js +9 -1
  33. package/build/client/navigation/prefetch.d.ts +1 -0
  34. package/build/client/navigation/prefetch.js +35 -0
  35. package/build/client/routing/Router.js +1 -1
  36. package/build/client/routing/hooks.js +6 -2
  37. package/build/client/routing/loader.d.ts +25 -0
  38. package/build/client/routing/loader.js +53 -7
  39. package/build/client/routing/mount.js +4 -3
  40. package/build/compiler/.tsbuildinfo +1 -1
  41. package/build/compiler/config.d.ts +18 -0
  42. package/build/compiler/config.js +8 -0
  43. package/build/compiler/docs.js +16 -16
  44. package/build/compiler/generate.js +3 -0
  45. package/build/compiler/index.d.ts +2 -2
  46. package/build/compiler/index.js +3 -1
  47. package/build/compiler/plugin.js +156 -0
  48. package/build/compiler/prerender.d.ts +1 -0
  49. package/build/compiler/prerender.js +2 -1
  50. package/build/compiler/seo.d.ts +2 -2
  51. package/build/compiler/seo.js +8 -6
  52. package/build/compiler/ssg.d.ts +5 -0
  53. package/build/compiler/ssg.js +121 -0
  54. package/build/io/.tsbuildinfo +1 -1
  55. package/build/logger/.tsbuildinfo +1 -1
  56. package/build/shared/.tsbuildinfo +1 -1
  57. package/eslint.config.js +48 -48
  58. package/examples/basic/client/404.tsx +11 -11
  59. package/examples/basic/client/components/.gitkeep +1 -1
  60. package/examples/basic/client/global-error.tsx +13 -13
  61. package/examples/basic/client/layout.tsx +25 -25
  62. package/examples/basic/client/public/images/.gitkeep +1 -1
  63. package/examples/basic/client/public/images/logo.svg +36 -36
  64. package/examples/basic/client/public/robots.txt +2 -2
  65. package/examples/basic/client/routes/docs/[...slug].tsx +12 -12
  66. package/examples/basic/client/routes/features/error/error.tsx +16 -16
  67. package/examples/basic/client/routes/features/template/b.tsx +14 -14
  68. package/examples/basic/client/routes/files/[[...slug]].tsx +21 -21
  69. package/examples/basic/client/routes/gallery/layout.tsx +13 -13
  70. package/examples/basic/client/routes/io.tsx +24 -24
  71. package/examples/basic/client/routes/loader-demo/loading.tsx +13 -13
  72. package/examples/basic/client/routes/search.tsx +61 -61
  73. package/examples/basic/client/toil.tsx +5 -5
  74. package/package.json +155 -147
  75. package/presets/eslint.js +88 -88
  76. package/presets/no-uint8array-tostring.js +200 -200
  77. package/presets/prettier.json +18 -18
  78. package/presets/tsconfig.json +37 -37
  79. package/src/backend/index.ts +160 -160
  80. package/src/cli/proc.ts +50 -50
  81. package/src/cli/updates.ts +69 -69
  82. package/src/cli/validate.ts +31 -31
  83. package/src/client/channel/channel.ts +146 -146
  84. package/src/client/components/Form.tsx +65 -65
  85. package/src/client/components/Script.tsx +113 -113
  86. package/src/client/components/Slot.tsx +21 -21
  87. package/src/client/dev/devtools.tsx +973 -0
  88. package/src/client/dev/error-overlay.tsx +30 -4
  89. package/src/client/head/head.ts +167 -167
  90. package/src/client/head/metadata.ts +19 -1
  91. package/src/client/index.ts +19 -9
  92. package/src/client/navigation/NavLink.tsx +86 -86
  93. package/src/client/navigation/navigation.ts +25 -5
  94. package/src/client/navigation/prefetch.ts +169 -130
  95. package/src/client/navigation/scroll.ts +53 -53
  96. package/src/client/routing/Router.tsx +8 -2
  97. package/src/client/routing/action.ts +122 -122
  98. package/src/client/routing/error-boundary.tsx +43 -43
  99. package/src/client/routing/hooks.ts +21 -6
  100. package/src/client/routing/loader.ts +325 -225
  101. package/src/client/routing/match.ts +47 -47
  102. package/src/client/routing/mount.tsx +54 -52
  103. package/src/client/routing/params-context.ts +10 -10
  104. package/src/client/routing/slot-context.ts +7 -7
  105. package/src/client/search/search.ts +189 -189
  106. package/src/client/search/use-page-search.ts +73 -73
  107. package/src/client/types.ts +73 -73
  108. package/src/compiler/config.ts +47 -1
  109. package/src/compiler/docs.ts +228 -228
  110. package/src/compiler/generate.ts +394 -391
  111. package/src/compiler/index.ts +64 -54
  112. package/src/compiler/pages.ts +70 -70
  113. package/src/compiler/plugin.ts +170 -2
  114. package/src/compiler/prerender.ts +5 -1
  115. package/src/compiler/seo.ts +23 -7
  116. package/src/compiler/ssg.ts +162 -0
  117. package/src/io/BinaryReader.ts +340 -340
  118. package/src/io/BinaryWriter.ts +385 -385
  119. package/src/io/FastMap.ts +127 -127
  120. package/src/io/index.ts +11 -11
  121. package/src/io/lengths.ts +14 -14
  122. package/src/io/types.ts +18 -18
  123. package/src/logger/index.ts +22 -22
  124. package/src/server/index.ts +10 -10
  125. package/src/server/main.ts +13 -13
  126. package/src/server/tsconfig.json +4 -4
  127. package/src/shared/index.ts +10 -10
  128. package/std/client/index.d.ts +15 -15
  129. package/std/client/package.json +3 -3
  130. package/test/assembly/example.spec.ts +7 -7
  131. package/test/channel.test.ts +21 -21
  132. package/test/dom/Link.test.tsx +47 -47
  133. package/test/dom/NavLink.test.tsx +37 -37
  134. package/test/dom/error-overlay.test.tsx +44 -44
  135. package/test/dom/loader.test.tsx +121 -121
  136. package/test/dom/navigation.test.ts +59 -59
  137. package/test/dom/revalidate.test.tsx +38 -38
  138. package/test/dom/route-head.test.tsx +78 -78
  139. package/test/dom/router-loading.test.tsx +44 -44
  140. package/test/dom/scroll.test.ts +56 -56
  141. package/test/dom/use-metadata.test.tsx +58 -0
  142. package/test/io.test.ts +93 -93
  143. package/test/navlink.test.ts +28 -28
  144. package/test/placeholder.test.ts +9 -9
  145. package/test/routes.test.ts +76 -76
  146. package/test/seo.test.ts +175 -164
  147. package/test/slot-layouts.test.ts +69 -69
  148. package/test/ssg.test.ts +36 -0
  149. package/test/update.test.ts +44 -44
  150. package/test/validate.test.ts +42 -42
  151. package/toil-routes.d.ts +7 -0
  152. package/toilconfig.json +30 -30
  153. package/tsconfig.backend.json +13 -13
  154. package/tsconfig.base.json +35 -35
  155. package/tsconfig.cli.json +13 -13
  156. package/tsconfig.client.json +14 -14
  157. package/tsconfig.compiler.json +13 -13
  158. package/tsconfig.io.json +12 -12
  159. package/tsconfig.json +22 -22
  160. package/tsconfig.logger.json +12 -12
  161. package/tsconfig.server.json +10 -10
  162. package/tsconfig.shared.json +12 -12
  163. package/vitest.config.ts +26 -26
  164. package/.idea/codeStyles/Project.xml +0 -54
  165. package/.idea/codeStyles/codeStyleConfig.xml +0 -5
  166. package/.idea/inspectionProfiles/Project_Default.xml +0 -6
  167. package/.idea/modules.xml +0 -8
  168. package/.idea/prettier.xml +0 -7
  169. package/.idea/toiljs.iml +0 -8
  170. package/.idea/vcs.xml +0 -6
  171. package/.toil/entry.tsx +0 -9
  172. package/.toil/index.html +0 -12
  173. package/.toil/routes.ts +0 -9
  174. package/build/cli/configure.d.ts +0 -16
  175. package/build/cli/configure.js +0 -272
  176. package/build/cli/create.d.ts +0 -16
  177. package/build/cli/create.js +0 -420
  178. package/build/cli/diagnostics.d.ts +0 -55
  179. package/build/cli/diagnostics.js +0 -333
  180. package/build/cli/doctor.d.ts +0 -6
  181. package/build/cli/doctor.js +0 -249
  182. package/build/cli/features.d.ts +0 -25
  183. package/build/cli/features.js +0 -107
  184. package/build/cli/index.d.ts +0 -2
  185. package/build/cli/proc.d.ts +0 -6
  186. package/build/cli/proc.js +0 -31
  187. package/build/cli/ui.d.ts +0 -9
  188. package/build/cli/ui.js +0 -75
  189. package/build/cli/update.d.ts +0 -7
  190. package/build/cli/update.js +0 -117
  191. package/build/cli/updates.d.ts +0 -10
  192. package/build/cli/updates.js +0 -45
  193. package/build/cli/validate.d.ts +0 -4
  194. package/build/cli/validate.js +0 -19
  195. package/build/client/Link.d.ts +0 -8
  196. package/build/client/Link.js +0 -44
  197. package/build/client/NavLink.d.ts +0 -14
  198. package/build/client/NavLink.js +0 -37
  199. package/build/client/Router.d.ts +0 -7
  200. package/build/client/Router.js +0 -55
  201. package/build/client/channel.d.ts +0 -23
  202. package/build/client/channel.js +0 -94
  203. package/build/client/error-boundary.d.ts +0 -16
  204. package/build/client/error-boundary.js +0 -19
  205. package/build/client/head.d.ts +0 -26
  206. package/build/client/head.js +0 -87
  207. package/build/client/hooks.d.ts +0 -17
  208. package/build/client/hooks.js +0 -48
  209. package/build/client/lazy.d.ts +0 -16
  210. package/build/client/lazy.js +0 -53
  211. package/build/client/match.d.ts +0 -2
  212. package/build/client/match.js +0 -32
  213. package/build/client/mount.d.ts +0 -2
  214. package/build/client/mount.js +0 -13
  215. package/build/client/navigation.d.ts +0 -13
  216. package/build/client/navigation.js +0 -97
  217. package/build/client/params-context.d.ts +0 -2
  218. package/build/client/params-context.js +0 -2
  219. package/build/client/prefetch.d.ts +0 -11
  220. package/build/client/prefetch.js +0 -100
  221. package/build/client/runtime.d.ts +0 -31
  222. package/build/client/runtime.js +0 -112
  223. package/build/client/scroll.d.ts +0 -8
  224. package/build/client/scroll.js +0 -36
  225. package/toil-env.d.ts +0 -16
@@ -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
+ });
@@ -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
+ });
@@ -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 &quot;b&quot; &lt;c&gt;"',
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 &quot;b&quot; &lt;c&gt;"',
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
+ });