Compare commits

...

166 Commits

Author SHA1 Message Date
Rich Harris
6765e534e4 fix splitting 2018-09-03 18:07:11 -04:00
Rich Harris
160a2e2ede typo 2018-09-03 18:07:03 -04:00
Rich Harris
3ecc21c0d9 update CLI 2018-09-03 17:17:45 -04:00
Rich Harris
3ffb396d87 allow vertical or horizonal split 2018-09-03 17:15:46 -04:00
Rich Harris
59fccc9e9a various fixes 2018-09-03 16:50:18 -04:00
Rich Harris
da9a37e125 use blessed for dev mode terminal output 2018-09-03 14:05:33 -04:00
Rich Harris
499b377bfd -> v0.19.3 2018-09-03 07:55:30 -04:00
Rich Harris
1baeb79d4b Merge branch 'master' of github.com:sveltejs/sapper 2018-09-03 07:54:42 -04:00
Rich Harris
0cc5ff95d6 minor tidy up 2018-09-03 07:54:39 -04:00
Rich Harris
e90525c1e8 Merge pull request #413 from sveltejs/gh-347
better unicode handling - fixes #347, i think
2018-09-03 07:47:41 -04:00
Rich Harris
6ccae0cd33 better unicode handling - fixes #347, i think 2018-09-02 23:00:39 -04:00
Rich Harris
8b60d568dc -> v0.19.2 2018-09-02 21:56:45 -04:00
Rich Harris
64c2394c9d Merge branch 'master' of github.com:sveltejs/sapper 2018-09-02 21:54:13 -04:00
Rich Harris
b28037291a Merge pull request #412 from sveltejs/gh-315
allow reserved words as route names
2018-09-02 21:54:09 -04:00
Rich Harris
bf9cbe2f3b print details of webpack errors - fixes #403 2018-09-02 21:53:46 -04:00
Rich Harris
2c507b5a2e allow reserved words as route names - fixes #315 2018-09-02 21:46:25 -04:00
Rich Harris
4a92fbbbfa Merge pull request #410 from sveltejs/gh-220
ignore things that look like temp files when generating manifest data
2018-09-02 21:13:33 -04:00
Rich Harris
b16440ff0f Merge pull request #411 from sveltejs/gh-235
ignore clicks on <a> elements without hrefs
2018-09-02 21:13:18 -04:00
Rich Harris
64223b572b ignore clicks on <a> elements without hrefs - fixes #235 2018-09-02 20:56:50 -04:00
Rich Harris
1b6dfd3580 ignore things that look like temp files when generating manifest data - fixes #220 2018-09-02 20:33:00 -04:00
Rich Harris
c0b833862a -> v0.19.1 2018-09-02 18:41:32 -04:00
Rich Harris
45f4c47a3e oops that wasnt quite right 2018-09-02 18:41:17 -04:00
Rich Harris
48b87edb5b Merge branch 'master' of github.com:sveltejs/sapper 2018-09-02 18:27:20 -04:00
Rich Harris
f9f283603e Merge pull request #409 from sveltejs/fix-redirects
don't include origin in export redirects
2018-09-02 18:26:56 -04:00
Rich Harris
a56ee6bdb7 regenerate lockfile 2018-09-02 17:01:43 -04:00
Rich Harris
a18af2a473 dont include origin in export redirects 2018-09-02 17:01:29 -04:00
Rich Harris
fe5a8fb1e7 dont include .map files in package 2018-09-02 14:53:12 -04:00
Rich Harris
57a26e3511 -> v0.19.0 2018-09-02 14:50:01 -04:00
Rich Harris
bebb0dd595 CSS extraction and code-splitting
closes #388
2018-09-02 14:46:27 -04:00
Rich Harris
afba0491ed -> v0.18.7 2018-08-31 16:40:50 -04:00
Rich Harris
350d37e210 Merge pull request #397 from sveltejs/gh-280
Implement differential bundling
2018-08-31 16:39:20 -04:00
Rich Harris
96fc19e939 update shimport 2018-08-31 16:32:56 -04:00
Rich Harris
5be3809d9e -> v0.18.6 2018-08-31 11:13:24 -04:00
Rich Harris
15cc4bf296 bundle webpack-format-messages 2018-08-31 11:13:03 -04:00
Rich Harris
c7cce985e3 serve legacy assets if such there be 2018-08-30 23:13:34 -04:00
Rich Harris
e00b315dec emit legacy build 2018-08-30 22:58:07 -04:00
Rich Harris
afcd643035 -> v0.18.5 2018-08-30 20:41:03 -04:00
Rich Harris
7cc2a03aae oops 2018-08-30 20:38:40 -04:00
Rich Harris
002718b609 -> v0.18.4 2018-08-30 20:00:58 -04:00
Rich Harris
45d216c64d Merge pull request #396 from sveltejs/gh-381
implement --dev-port flag
2018-08-30 19:59:09 -04:00
Rich Harris
3d69d483d7 merge master -> gh-381 2018-08-30 19:49:28 -04:00
Rich Harris
54da524467 implement --dev-port flag - fixes #381 2018-08-30 19:46:14 -04:00
Rich Harris
ee95240ca6 Merge pull request #394 from sveltejs/gh-390
omit trailing slash from server route matchers
2018-08-30 19:37:23 -04:00
Rich Harris
74d5d1f9c0 Merge pull request #395 from sveltejs/gh-391
Remove webpack annotations when building with Rollup
2018-08-30 19:37:01 -04:00
Rich Harris
8c2688b1be remove url-parse 2018-08-30 19:34:59 -04:00
Rich Harris
e170e4af9b use builtin url module 2018-08-30 19:29:36 -04:00
Rich Harris
bc31c73c33 omit trailing slash from server route matchers - fixes #390 2018-08-30 18:48:10 -04:00
Rich Harris
7798f8f684 minor tidy up 2018-08-30 18:41:37 -04:00
Rich Harris
70fd7038b0 skip webpack annotations when using Rollup 2018-08-30 18:38:46 -04:00
Rich Harris
c6af2ddfa3 Merge pull request #393 from sveltejs/gh-392
handle non-Sapper responses when exporting
2018-08-30 18:29:17 -04:00
Rich Harris
65d0172abe handle non-Sapper responses when exporting - fixes #392 2018-08-30 18:22:40 -04:00
Rich Harris
1e22031765 -> v0.18.3 2018-08-29 22:52:01 -04:00
Rich Harris
46bf8f2b78 -> v0.18.2 2018-08-29 22:43:21 -04:00
Rich Harris
553db81b7b -> v0.18.1 2018-08-29 22:29:46 -04:00
Rich Harris
67cc29ed38 Merge pull request #386 from sveltejs/gh-385
implement --live
2018-08-29 22:28:42 -04:00
Rich Harris
36f930f489 use --live by default, if using Rollup or --no-hot 2018-08-29 22:19:53 -04:00
Rich Harris
3b098caa6e implement --live and --hot - fixes #385 2018-08-29 21:51:08 -04:00
Rich Harris
d63b9437b5 -> v0.18.0 2018-08-29 21:08:15 -04:00
Rich Harris
e51c733e3f Merge pull request #379 from sveltejs/gh-130
Rollup support
2018-08-29 21:02:48 -04:00
Rich Harris
708fe4c74b rebuild lockfile 2018-08-29 20:53:48 -04:00
Rich Harris
4259fc8e58 update shimport, minor tidy up 2018-08-29 20:20:02 -04:00
Rich Harris
f05a8e52a0 deprecate, dont break 2018-08-29 18:01:27 -04:00
Rich Harris
76cb6d97f3 oops 2018-08-29 18:01:17 -04:00
Rich Harris
5d0b7af47b i feel good about this 2018-08-29 17:40:13 -04:00
Rich Harris
bb737eeb32 success i think? 2018-08-29 17:37:20 -04:00
Rich Harris
86dee17040 come ON 2018-08-29 17:29:17 -04:00
Rich Harris
01a709e017 ffffuuuuuuuuuuu 2018-08-29 17:27:34 -04:00
Rich Harris
f87f0e3b80 stab in the dark 2018-08-29 17:24:48 -04:00
Rich Harris
8226e9bc1f starting to lose my sense of humour 2018-08-29 17:17:36 -04:00
Rich Harris
d6d0a15015 WHAT IS HAPPENING 2018-08-29 17:10:00 -04:00
Rich Harris
ddec58ebd4 ffs 2018-08-29 17:05:56 -04:00
Rich Harris
9d904b3911 argh 2018-08-29 17:02:21 -04:00
Rich Harris
c36df0d650 try to diagnose latest windows idiocy 2018-08-29 16:58:50 -04:00
Rich Harris
ae19288797 update rollup 2018-08-29 16:45:29 -04:00
Rich Harris
de308d5bb0 rebuild lockfile 2018-08-29 16:29:37 -04:00
Rich Harris
99b096a5c4 rimraf before mkdirp 2018-08-29 16:05:41 -04:00
Rich Harris
36fc8a947b use shimport 2018-08-29 15:58:27 -04:00
Rich Harris
6393a30b13 print nice build summaries 2018-08-29 15:03:10 -04:00
Rich Harris
458be49b35 emit errors and warnings, albeit clumsily 2018-08-29 13:26:31 -04:00
Rich Harris
f8d742bdd0 hashing 2018-08-29 10:55:52 -04:00
Rich Harris
7e698f1613 use watchChange plugin hook to detect invalidations 2018-08-28 18:06:31 -04:00
Rich Harris
70b5cc86dc replace client_assets.json with build.json, include bundler name 2018-08-28 17:56:46 -04:00
Rich Harris
19a5dcad1d update CLI 2018-08-28 17:29:27 -04:00
Rich Harris
85e25d6380 add a --bundler option, for forcing rollup or webpack 2018-08-28 17:29:14 -04:00
Rich Harris
6e2383b66b add shimport 2018-08-28 17:28:40 -04:00
Rich Harris
200c5fcbd2 get tests passing again 2018-08-25 14:01:07 -04:00
Rich Harris
9cbb8bdc33 first stab at supporting Rollup (#130) 2018-08-25 12:42:27 -04:00
Rich Harris
3d39836cfb prevent deprecation warnings 2018-08-25 09:12:06 -04:00
Rich Harris
24f2855f89 create a facade over webpack, to support alternative compilers 2018-08-25 09:11:45 -04:00
Rich Harris
d5bf206d2a Merge pull request #378 from sveltejs/export-timeout
export should fail on timeouts
2018-08-25 08:14:18 -04:00
Rich Harris
8abc01551e export should fail on timeouts 2018-08-24 14:25:48 -04:00
Rich Harris
62b8a79e9f -> v0.17.1 2018-08-23 11:23:40 -04:00
Rich Harris
7f255563a4 Merge pull request #371 from sveltejs/show-files-on-error
show which file is causing an error/warning
2018-08-23 11:21:04 -04:00
Rich Harris
32f4a50f25 show which file is causing an error/warning 2018-08-23 11:09:02 -04:00
Rich Harris
b1a9be2dc3 -> v0.17.0 2018-08-19 22:07:04 -04:00
Rich Harris
c5456d3033 Merge pull request #365 from sveltejs/cheap-watch
Use cheap-watch
2018-08-19 22:05:33 -04:00
Rich Harris
9b33dad589 merge master -> cheap-watch 2018-08-19 19:03:12 -04:00
Rich Harris
4315a46ff2 -> v0.16.1 2018-08-19 18:55:41 -04:00
Rich Harris
0fb5827968 fix file watching 2018-08-19 18:55:09 -04:00
Rich Harris
f9bf23dc43 use cheap-watch instead of chokidar (#364) 2018-08-19 18:52:01 -04:00
Rich Harris
611017fd28 -> v0.16.0 2018-08-19 17:39:02 -04:00
Rich Harris
72b265a35f Merge pull request #363 from sveltejs/bundle-deps
[WIP] Slim down the bundle
2018-08-19 17:36:18 -04:00
Rich Harris
e0d533f2ea bundle more stuff 2018-08-19 16:15:04 -04:00
Rich Harris
dba83641e4 remove glob and cheerio from dependencies 2018-08-19 15:20:14 -04:00
Rich Harris
14e5c8e761 update lockfile 2018-08-16 12:48:50 -04:00
Rich Harris
cbbf4a95db -> v0.15.8 2018-08-16 12:46:13 -04:00
Rich Harris
55b7ffd2ed Merge pull request #361 from sveltejs/handle-unknown-preload-errors
handle unknown preload errors
2018-08-16 12:44:27 -04:00
Rich Harris
9f4d4e70de can remove this, preloading is set false on render 2018-08-16 12:39:54 -04:00
Rich Harris
deef1bbfcf handle unknown preload errors 2018-08-16 12:25:23 -04:00
Seth Thompson
17b0fc0d0c nit 2018-08-11 17:52:53 -04:00
Seth Thompson
3c44c511e4 make sure page has expected preloading value 2018-08-11 17:51:44 -04:00
Seth Thompson
7cf1b9613a prefetching should not set root preloading value, closes #352 2018-08-11 12:26:27 -04:00
Rich Harris
99e5a9601c -> v0.15.7 2018-08-09 20:14:37 -04:00
Rich Harris
4c9c1dccf5 Merge pull request #350 from sveltejs/gh-344
pass response object to store getter
2018-08-09 20:13:17 -04:00
Rich Harris
2cddd5afa0 Merge pull request #345 from sveltejs/fix/redirect
Fix Preload's Redirect
2018-08-09 20:08:51 -04:00
Rich Harris
8c6a0c4773 Merge branch 'master' into gh-344 2018-08-09 20:03:37 -04:00
Rich Harris
af5063552d Merge pull request #351 from sveltejs/argh-windows
doh
2018-08-09 20:02:51 -04:00
Rich Harris
419d154794 fffffuuuuu 2018-08-09 19:53:26 -04:00
Rich Harris
abda059be5 doh 2018-08-09 19:46:09 -04:00
Rich Harris
444908cac5 pass response object to store getter - fixes #344 2018-08-08 10:57:10 -04:00
Luke Edwards
c6da26e1a0 add redirect test to root (“/“) 2018-08-06 20:29:28 -07:00
Luke Edwards
aad87857ce fix: replace leading slash in preload’s redirect 2018-08-06 20:28:28 -07:00
Rich Harris
666c113297 -> v0.15.6 2018-08-06 22:36:17 -04:00
Rich Harris
84a58f34a0 add test for exporting with custom basepath 2018-08-06 22:35:02 -04:00
Rich Harris
75f5b5c721 Merge pull request #342 from aubergene/gh-338
Remove basepath from deferred urls and add trailing slash to root
2018-08-06 22:06:09 -04:00
Julian Burgess
a176a3b79b Remove basepath from deferred urls and add trailing slash to root request 2018-08-06 16:43:02 +01:00
Rich Harris
1627a5767a -> v0.15.5 2018-08-03 01:18:12 -04:00
Rich Harris
6ff3a9e9ab Merge branch 'master' of github.com:sveltejs/sapper 2018-08-03 01:16:43 -04:00
Rich Harris
3ce2bd30f9 Use npm ci instead of npm install (#336)
* dont write server_info.json either - second half of #318

* use npm ci

* update lockfile

* try this
2018-08-03 01:16:26 -04:00
Rich Harris
de4f99807f Merge branch 'master' of github.com:sveltejs/sapper 2018-08-03 00:11:09 -04:00
Rich Harris
eae8351f77 Better/faster exporting
* add --build and --build-dir options to sapper export (#325)

* tweak export logging, update port-authority to prevent timeout bug

* better logging of export progress

* handle case where linked resource is already fetched

* default to .sapper/dev instead of .sapper

* handle query params and redirects

* dont write server_info.json either - second half of #318

* update changelog

* update lockfile

* try to track down ci test failures

* err wut

* curiouser and curiouser

* ok, seems to work now
2018-08-03 00:10:58 -04:00
Rich Harris
d386308301 update changelog 2018-08-02 13:23:12 -04:00
Rich Harris
13afbc84d7 dont write server_info.json either - second half of #318 2018-08-02 10:59:23 -04:00
Rich Harris
31327b3780 Merge pull request #333 from sveltejs/gh-332
only blur activeElement if there is one
2018-08-02 10:43:27 -04:00
Rich Harris
81f483d7b8 Merge pull request #334 from sveltejs/gh-318
dont emit client_info.json
2018-08-02 08:40:30 -04:00
Rich Harris
1bcf20511b dont emit client_info.json - fixes #318 2018-08-01 21:46:26 -04:00
Rich Harris
003fa8ab2c only blur activeElement if there is one - fixes #332 2018-08-01 21:34:30 -04:00
Rich Harris
d1fcd07c92 -> v0.15.4 2018-08-01 08:47:41 -04:00
Rich Harris
47a6d6f662 Merge pull request #326 from lukeed/feat/ignore
Add `ignore` option
2018-08-01 08:46:49 -04:00
Luke Edwards
4b2b6440d0 fix: use more specific ignore pattern;
~> leaked into another test’s route
2018-07-31 16:54:29 -07:00
Rich Harris
fc855f30f8 -> v0.15.3 2018-07-31 15:06:47 -04:00
Rich Harris
4a75fff4ec Merge pull request #329 from sveltejs/parallel-exports
parallelize exports
2018-07-31 15:05:38 -04:00
Rich Harris
7b7b695938 Merge pull request #320 from sveltejs/gh-319
Some dev documentation
2018-07-31 14:59:57 -04:00
Rich Harris
2fca2e295f Merge pull request #328 from sveltejs/export-no-minify-js
don't minify JS when minifying HTML
2018-07-31 14:59:27 -04:00
Rich Harris
eae991d369 parallelize exports 2018-07-31 14:56:29 -04:00
Rich Harris
c2b393d3fd dont minify JS when minifying HTML 2018-07-31 14:43:58 -04:00
Luke Edwards
566addd406 add tests for opts.ignore 2018-07-29 14:17:13 -07:00
Luke Edwards
3d77dacbd6 attach ignore options to test app, w/ matching routes 2018-07-29 14:17:04 -07:00
Luke Edwards
51b4f9cbbf add opts.ignore support 2018-07-29 14:01:44 -07:00
Robert Hall
1d611be83e Using npm 2018-07-25 15:50:56 -06:00
Robert Hall
1782904994 Some dev documentation 2018-07-25 10:10:22 -06:00
Rich Harris
e3ddbfc181 Merge pull request #314 from sveltejs/fix-child-segment
fix child.segment bug
2018-07-23 17:08:25 -04:00
Rich Harris
8e3830b646 fix child.segment bug 2018-07-23 17:02:35 -04:00
Rich Harris
b28cdff233 -> v0.15.2 2018-07-23 16:38:49 -04:00
Rich Harris
7f586ff1a3 Merge pull request #313 from sveltejs/gh-312
Skip layout components where none is provided
2018-07-23 16:37:30 -04:00
Rich Harris
731d4f535c skip layout components where none is provided - fixes #312 2018-07-23 16:31:00 -04:00
Rich Harris
f8c731ca21 failing tests for #312 2018-07-23 14:31:11 -04:00
Rich Harris
39eb3be01e -> v0.15.1 2018-07-22 21:25:33 -04:00
Rich Harris
d0bb728e25 -> v0.15.0 2018-07-22 21:04:03 -04:00
Rich Harris
58de0f9c99 Nested routes
Fixes #262
2018-07-22 21:00:37 -04:00
Rich Harris
b75ae7ba96 -> v0.14.2 2018-07-14 21:05:39 -04:00
Rich Harris
091e38082e Merge pull request #307 from sveltejs/unsafe-replacements
prevent unsafe replacements of preloaded data etc
2018-07-15 02:05:20 +01:00
Rich Harris
74acf93c7a prevent unsafe replacements of preloaded data etc 2018-07-14 20:56:05 -04:00
Rich Harris
0e3775397f Merge pull request #306 from sveltejs/refactor-route-generation
Refactor route generation
2018-07-05 08:25:59 -04:00
Rich Harris
8dc52a04e4 split pages and server routes into separate arrays 2018-07-05 08:14:07 -04:00
Rich Harris
008b607c01 generate pages and server routes separately 2018-07-04 10:53:41 -04:00
127 changed files with 11299 additions and 1398 deletions

View File

@@ -18,4 +18,4 @@ addons:
install: install:
- export DISPLAY=':99.0' - export DISPLAY=':99.0'
- Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 & - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
- npm install - npm ci || npm i

View File

@@ -1,5 +1,120 @@
# sapper changelog # sapper changelog
## 0.19.3
* Better unicode route handling ([#347](https://github.com/sveltejs/sapper/issues/347))
## 0.19.2
* Ignore editor tmp files ([#220](https://github.com/sveltejs/sapper/issues/220))
* Ignore clicks an `<a>` element without `href` ([#235](https://github.com/sveltejs/sapper/issues/235))
* Allow routes that are reserved JavaScript words ([#315](https://github.com/sveltejs/sapper/issues/315))
* Print out webpack errors ([#403](https://github.com/sveltejs/sapper/issues/403))
## 0.19.1
* Don't include local origin in export redirects ([#409](https://github.com/sveltejs/sapper/pull/409))
## 0.19.0
* Extract styles out of JS into .css files, for Rollup apps ([#388](https://github.com/sveltejs/sapper/issues/388))
* Fix `prefetchRoutes` ([#380](https://github.com/sveltejs/sapper/issues/380))
## 0.18.7
* Support differential bundling for Rollup apps via a `--legacy` flag ([#280](https://github.com/sveltejs/sapper/issues/280))
## 0.18.6
* Bundle missing dependency
## 0.18.5
* Bugfix
## 0.18.4
* Handle non-Sapper responses when exporting ([#382](https://github.com/sveltejs/sapper/issues/392))
* Add `--dev-port` flag to `sapper dev` ([#381](https://github.com/sveltejs/sapper/issues/381))
## 0.18.3
* Fix service worker Rollup build config
## 0.18.2
* Update `pkg.files`
## 0.18.1
* Add live reloading ([#385](https://github.com/sveltejs/sapper/issues/385))
## 0.18.0
* Rollup support ([#379](https://github.com/sveltejs/sapper/pull/379))
* Fail `export` if a page times out (configurable with `--timeout`) ([#378](https://github.com/sveltejs/sapper/pull/378))
## 0.17.1
* Print which file is causing build errors/warnings ([#371](https://github.com/sveltejs/sapper/pull/371))
## 0.17.0
* Use `cheap-watch` instead of `chokidar` ([#364](https://github.com/sveltejs/sapper/issues/364))
## 0.16.1
* Fix file watching regression in previous version
## 0.16.0
* Slim down installed package ([#363](https://github.com/sveltejs/sapper/pull/363))
## 0.15.8
* Only set `preloading: true` on navigation, not prefetch ([#352](https://github.com/sveltejs/sapper/issues/352))
* Provide fallback for missing preload errors ([#361](https://github.com/sveltejs/sapper/pull/361))
## 0.15.7
* Strip leading slash from redirects ([#291](https://github.com/sveltejs/sapper/issues/291))
* Pass `(req, res)` to store getter ([#344](https://github.com/sveltejs/sapper/issues/344))
## 0.15.6
* Fix exporting with custom basepath ([#342](https://github.com/sveltejs/sapper/pull/342))
## 0.15.5
* Faster `export` with more explanatory output ([#335](https://github.com/sveltejs/sapper/pull/335))
* Only blur `activeElement` if it exists ([#332](https://github.com/sveltejs/sapper/issues/332))
* Don't emit `client_info.json` or `server_info.json` ([#318](https://github.com/sveltejs/sapper/issues/318))
## 0.15.4
* Add `ignore` option ([#326](https://github.com/sveltejs/sapper/pull/326))
## 0.15.3
* Crawl pages in parallel when exporting ([#329](https://github.com/sveltejs/sapper/pull/329))
* Don't minify inline JS when exporting ([#328](https://github.com/sveltejs/sapper/pull/328))
## 0.15.2
* Collapse component chains where no intermediate layout component is specified ([#312](https://github.com/sveltejs/sapper/issues/312))
## 0.15.1
* Prevent confusing error when no root layout is specified
## 0.15.0
* Nested routes (consult [migration guide](https://sapper.svelte.technology/guide#0-14-to-0-15) and docs on [layouts](https://sapper.svelte.technology/guide#layouts)) ([#262](https://github.com/sveltejs/sapper/issues/262))
## 0.14.2
* Prevent unsafe replacements ([#307](https://github.com/sveltejs/sapper/pull/307))
## 0.14.1 ## 0.14.1
* Route parameters can be qualified with regex characters ([#283](https://github.com/sveltejs/sapper/pull/283)) * Route parameters can be qualified with regex characters ([#283](https://github.com/sveltejs/sapper/pull/283))

View File

@@ -31,6 +31,44 @@ npm run build
npm start npm start
``` ```
## Development
Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/sveltejs/sapper/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and help us out!
To install and work on Sapper locally:
```bash
git clone git@github.com:sveltejs/sapper.git
cd sapper
npm install
npm run dev
```
### Linking to a Live Project
You can make changes locally to Sapper and test it against a local Sapper project. For a quick project that takes almost no setup, use the default [sapper-template](https://github.com/sveltejs/sapper-template) project. Instruction on setup are found in that project repository.
To link Sapper to your project, from the root of your local Sapper git checkout:
```bash
cd sapper
npm link
```
Then, to link from `sapper-template` (or any other given project):
```bash
cd sapper-template
npm link sapper
```
You should be good to test changes locally.
### Running Tests
```bash
npm run test
```
## License ## License

2
api.js
View File

@@ -1 +1 @@
module.exports = require('./dist/api.ts.js'); module.exports = require('./dist/api.js');

View File

@@ -10,11 +10,11 @@ build: off
environment: environment:
matrix: matrix:
# node.js # node.js
- nodejs_version: stable - nodejs_version: 10.5
install: install:
- ps: Install-Product node $env:nodejs_version - ps: Install-Product node $env:nodejs_version
- npm install - npm ci
test_script: test_script:
- node --version && npm --version - node --version && npm --version

View File

@@ -0,0 +1 @@
<svelte:component this={child.component} {...child.props}/>

1
config/rollup.js Normal file
View File

@@ -0,0 +1 @@
module.exports = require('../dist/rollup.js');

1
config/webpack.js Normal file
View File

@@ -0,0 +1 @@
module.exports = require('../dist/webpack.js');

View File

@@ -1,4 +1,5 @@
--require source-map-support/register --require source-map-support/register
--require ts-node/register
--recursive --recursive
test/unit/**/*.js test/unit/*/*.ts
test/common/test.js test/common/test.js

7838
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -1,73 +1,81 @@
{ {
"name": "sapper", "name": "sapper",
"version": "0.14.1", "version": "0.19.3",
"description": "Military-grade apps, engineered by Svelte", "description": "Military-grade apps, engineered by Svelte",
"main": "dist/middleware.ts.js", "main": "dist/middleware.js",
"bin": { "bin": {
"sapper": "./sapper" "sapper": "./sapper"
}, },
"files": [ "files": [
"*.js", "*.js",
"*.ts.js",
"runtime", "runtime",
"webpack", "webpack",
"config",
"sapper", "sapper",
"dist" "components",
"dist/*.js"
], ],
"directories": { "directories": {
"test": "test" "test": "test"
}, },
"dependencies": { "dependencies": {
"ansi-colors": "^2.0.1", "@types/blessed": "^0.1.10",
"cheerio": "^1.0.0-rc.2", "blessed": "^0.1.81",
"chokidar": "^2.0.3",
"cookie": "^0.3.1",
"devalue": "^1.0.1",
"glob": "^7.1.2",
"html-minifier": "^3.5.16", "html-minifier": "^3.5.16",
"mkdirp": "^0.5.1", "shimport": "^0.0.10",
"node-fetch": "^2.1.1",
"port-authority": "^1.0.2",
"pretty-bytes": "^5.0.0",
"pretty-ms": "^3.1.0",
"require-relative": "^0.8.7",
"rimraf": "^2.6.2",
"sade": "^1.4.1",
"sander": "^0.6.0",
"source-map-support": "^0.5.6", "source-map-support": "^0.5.6",
"tslib": "^1.9.1", "sourcemap-codec": "^1.4.1",
"url-parse": "^1.2.0", "string-hash": "^1.1.3",
"webpack-format-messages": "^2.0.1" "tslib": "^1.9.1"
}, },
"devDependencies": { "devDependencies": {
"@types/glob": "^5.0.34", "@types/glob": "^5.0.34",
"@types/mkdirp": "^0.5.2", "@types/mkdirp": "^0.5.2",
"@types/mocha": "^5.2.5",
"@types/node": "^10.7.1",
"@types/rimraf": "^2.0.2", "@types/rimraf": "^2.0.2",
"cheap-watch": "^0.3.0",
"compression": "^1.7.1", "compression": "^1.7.1",
"cookie": "^0.3.1",
"devalue": "^1.0.4",
"eslint": "^4.13.1", "eslint": "^4.13.1",
"eslint-plugin-import": "^2.12.0", "eslint-plugin-import": "^2.12.0",
"express": "^4.16.3", "express": "^4.16.3",
"kleur": "^2.0.1",
"mkdirp": "^0.5.1",
"mocha": "^5.2.0", "mocha": "^5.2.0",
"nightmare": "^3.0.0", "nightmare": "^3.0.0",
"node-fetch": "^2.1.1",
"npm-run-all": "^4.1.3", "npm-run-all": "^4.1.3",
"polka": "^0.4.0", "polka": "^0.4.0",
"rollup": "^0.59.2", "port-authority": "^1.0.5",
"pretty-bytes": "^5.0.0",
"pretty-ms": "^3.1.0",
"require-relative": "^0.8.7",
"rimraf": "^2.6.2",
"rollup": "^0.65.0",
"rollup-plugin-commonjs": "^9.1.3", "rollup-plugin-commonjs": "^9.1.3",
"rollup-plugin-json": "^3.0.0", "rollup-plugin-json": "^3.0.0",
"rollup-plugin-node-resolve": "^3.3.0",
"rollup-plugin-string": "^2.0.2", "rollup-plugin-string": "^2.0.2",
"rollup-plugin-typescript": "^0.8.1", "rollup-plugin-typescript": "^0.8.1",
"sade": "^1.4.1",
"sander": "^0.6.0",
"serve-static": "^1.13.2", "serve-static": "^1.13.2",
"svelte": "^2.6.3", "svelte": "^2.6.3",
"svelte-loader": "^2.9.0", "svelte-loader": "^2.9.0",
"tiny-glob": "^0.2.2",
"ts-node": "^7.0.1",
"typescript": "^2.8.3", "typescript": "^2.8.3",
"walk-sync": "^0.3.2", "walk-sync": "^0.3.2",
"webpack": "^4.8.3" "webpack": "^4.8.3",
"webpack-format-messages": "^2.0.1"
}, },
"scripts": { "scripts": {
"cy:open": "cypress open", "cy:open": "cypress open",
"test": "mocha --opts mocha.opts", "test": "mocha --opts mocha.opts",
"pretest": "npm run build", "pretest": "npm run build",
"build": "rollup -c", "build": "rm -rf dist && rollup -c",
"dev": "rollup -cw", "dev": "rollup -cw",
"prepublishOnly": "npm test", "prepublishOnly": "npm test",
"update_mime_types": "curl http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types | grep -e \"^[^#]\" > src/middleware/mime-types.md" "update_mime_types": "curl http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types | grep -e \"^[^#]\" > src/middleware/mime-types.md"

View File

@@ -1,6 +1,7 @@
import typescript from 'rollup-plugin-typescript'; import typescript from 'rollup-plugin-typescript';
import string from 'rollup-plugin-string'; import string from 'rollup-plugin-string';
import json from 'rollup-plugin-json'; import json from 'rollup-plugin-json';
import resolve from 'rollup-plugin-node-resolve';
import commonjs from 'rollup-plugin-commonjs'; import commonjs from 'rollup-plugin-commonjs';
import pkg from './package.json'; import pkg from './package.json';
@@ -19,7 +20,8 @@ export default [
}, },
plugins: [ plugins: [
typescript({ typescript({
typescript: require('typescript') typescript: require('typescript'),
target: "ES2017"
}) })
] ]
}, },
@@ -30,6 +32,7 @@ export default [
`src/cli.ts`, `src/cli.ts`,
`src/core.ts`, `src/core.ts`,
`src/middleware.ts`, `src/middleware.ts`,
`src/rollup.ts`,
`src/webpack.ts` `src/webpack.ts`
], ],
output: { output: {
@@ -43,12 +46,12 @@ export default [
include: '**/*.md' include: '**/*.md'
}), }),
json(), json(),
resolve(),
commonjs(), commonjs(),
typescript({ typescript({
typescript: require('typescript') typescript: require('typescript')
}) })
], ],
experimentalCodeSplitting: true, experimentalCodeSplitting: true
experimentalDynamicImport: true
} }
]; ];

2
sapper
View File

@@ -1,2 +1,2 @@
#!/usr/bin/env node #!/usr/bin/env node
require('./dist/cli.ts.js'); require('./dist/cli.js');

View File

@@ -1,6 +1,8 @@
let source; let source;
function check() { function check() {
if (typeof module === 'undefined') return;
if (module.hot.status() === 'idle') { if (module.hot.status() === 'idle') {
module.hot.check(true).then(modules => { module.hot.check(true).then(modules => {
console.log(`[SAPPER] applied HMR update`); console.log(`[SAPPER] applied HMR update`);

View File

@@ -3,15 +3,24 @@ import * as path from 'path';
import mkdirp from 'mkdirp'; import mkdirp from 'mkdirp';
import rimraf from 'rimraf'; import rimraf from 'rimraf';
import { EventEmitter } from 'events'; import { EventEmitter } from 'events';
import { minify_html } from './utils/minify_html'; import * as codec from 'sourcemap-codec';
import { create_compilers, create_main_manifests, create_routes, create_serviceworker_manifest } from '../core' import hash from 'string-hash';
import { locations } from '../config'; import minify_html from './utils/minify_html';
import { create_compilers, create_main_manifests, create_manifest_data, create_serviceworker_manifest } from '../core';
import * as events from './interfaces'; import * as events from './interfaces';
import { copy_shimport } from './utils/copy_shimport';
import { Dirs, PageComponent } from '../interfaces';
import { CompileResult } from '../core/create_compilers/interfaces';
export function build(opts: {}) { type Opts = {
legacy: boolean;
bundler: string;
};
export function build(opts: Opts, dirs: Dirs) {
const emitter = new EventEmitter(); const emitter = new EventEmitter();
execute(emitter, opts).then( execute(emitter, opts, dirs).then(
() => { () => {
emitter.emit('done', <events.DoneEvent>{}); // TODO do we need to pass back any info? emitter.emit('done', <events.DoneEvent>{}); // TODO do we need to pass back any info?
}, },
@@ -25,18 +34,14 @@ export function build(opts: {}) {
return emitter; return emitter;
} }
async function execute(emitter: EventEmitter, { async function execute(emitter: EventEmitter, opts: Opts, dirs: Dirs) {
dest = 'build', rimraf.sync(path.join(dirs.dest, '**/*'));
app = 'app', mkdirp.sync(`${dirs.dest}/client`);
webpack = 'webpack', copy_shimport(dirs.dest);
routes = 'routes'
} = {}) {
mkdirp.sync(dest);
rimraf.sync(path.join(dest, '**/*'));
// minify app/template.html // minify app/template.html
// TODO compile this to a function? could be quicker than str.replace(...).replace(...).replace(...) // TODO compile this to a function? could be quicker than str.replace(...).replace(...).replace(...)
const template = fs.readFileSync(`${app}/template.html`, 'utf-8'); const template = fs.readFileSync(`${dirs.app}/template.html`, 'utf-8');
// remove this in a future version // remove this in a future version
if (template.indexOf('%sapper.base%') === -1) { if (template.indexOf('%sapper.base%') === -1) {
@@ -45,67 +50,63 @@ async function execute(emitter: EventEmitter, {
throw error; throw error;
} }
fs.writeFileSync(`${dest}/template.html`, minify_html(template)); fs.writeFileSync(`${dirs.dest}/template.html`, minify_html(template));
const route_objects = create_routes(); const manifest_data = create_manifest_data();
// create app/manifest/client.js and app/manifest/server.js // create app/manifest/client.js and app/manifest/server.js
create_main_manifests({ routes: route_objects }); create_main_manifests({ bundler: opts.bundler, manifest_data });
const { client, server, serviceworker } = create_compilers({ webpack }); const { client, server, serviceworker } = create_compilers(opts.bundler, dirs);
const client_stats = await compile(client); const client_result = await client.compile();
emitter.emit('build', <events.BuildEvent>{ emitter.emit('build', <events.BuildEvent>{
type: 'client', type: 'client',
// TODO duration/warnings // TODO duration/warnings
webpack_stats: client_stats result: client_result
}); });
const client_info = client_stats.toJson(); const build_info = client_result.to_json(manifest_data, dirs);
fs.writeFileSync(path.join(dest, 'client_info.json'), JSON.stringify(client_info));
fs.writeFileSync(path.join(dest, 'client_assets.json'), JSON.stringify(client_info.assetsByChunkName));
const server_stats = await compile(server); if (opts.legacy) {
process.env.SAPPER_LEGACY_BUILD = 'true';
const { client } = create_compilers(opts.bundler, dirs);
const client_result = await client.compile();
emitter.emit('build', <events.BuildEvent>{
type: 'client (legacy)',
// TODO duration/warnings
result: client_result
});
build_info.legacy_assets = client_result.assets;
delete process.env.SAPPER_LEGACY_BUILD;
}
fs.writeFileSync(path.join(dirs.dest, 'build.json'), JSON.stringify(build_info));
const server_stats = await server.compile();
emitter.emit('build', <events.BuildEvent>{ emitter.emit('build', <events.BuildEvent>{
type: 'server', type: 'server',
// TODO duration/warnings // TODO duration/warnings
webpack_stats: server_stats result: server_stats
}); });
let serviceworker_stats; let serviceworker_stats;
if (serviceworker) { if (serviceworker) {
create_serviceworker_manifest({ create_serviceworker_manifest({
routes: route_objects, manifest_data,
client_files: client_stats.toJson().assets.map((chunk: { name: string }) => `client/${chunk.name}`) client_files: client_result.chunks.map(chunk => `client/${chunk.file}`)
}); });
serviceworker_stats = await compile(serviceworker); serviceworker_stats = await serviceworker.compile();
emitter.emit('build', <events.BuildEvent>{ emitter.emit('build', <events.BuildEvent>{
type: 'serviceworker', type: 'serviceworker',
// TODO duration/warnings // TODO duration/warnings
webpack_stats: serviceworker_stats result: serviceworker_stats
}); });
} }
} }
function compile(compiler: any) {
return new Promise((fulfil, reject) => {
compiler.run((err: Error, stats: any) => {
if (err) {
reject(err);
process.exit(1);
}
if (stats.hasErrors()) {
console.error(stats.toString({ colors: true }));
reject(new Error(`Encountered errors while building app`));
}
else {
fulfil(stats);
}
});
});
}

View File

@@ -5,33 +5,41 @@ import * as child_process from 'child_process';
import * as ports from 'port-authority'; import * as ports from 'port-authority';
import mkdirp from 'mkdirp'; import mkdirp from 'mkdirp';
import rimraf from 'rimraf'; import rimraf from 'rimraf';
import format_messages from 'webpack-format-messages';
import { locations } from '../config'; import { locations } from '../config';
import { EventEmitter } from 'events'; import { EventEmitter } from 'events';
import { create_routes, create_main_manifests, create_compilers, create_serviceworker_manifest } from '../core'; import { create_manifest_data, create_main_manifests, create_compilers, create_serviceworker_manifest } from '../core';
import { Compiler, Compilers } from '../core/create_compilers';
import { CompileResult, CompileError } from '../core/create_compilers/interfaces';
import Deferred from './utils/Deferred';
import * as events from './interfaces'; import * as events from './interfaces';
import validate_bundler from '../cli/utils/validate_bundler';
import { copy_shimport } from './utils/copy_shimport';
import { ManifestData } from '../interfaces';
export function dev(opts) { export function dev(opts) {
return new Watcher(opts); return new Watcher(opts);
} }
class Watcher extends EventEmitter { class Watcher extends EventEmitter {
bundler: string;
dirs: { dirs: {
app: string; app: string;
dest: string; dest: string;
routes: string; routes: string;
rollup: string;
webpack: string; webpack: string;
} }
port: number; port: number;
closed: boolean; closed: boolean;
dev_port: number;
live: boolean;
hot: boolean;
dev_server: DevServer; dev_server: DevServer;
proc: child_process.ChildProcess; proc: child_process.ChildProcess;
filewatchers: Array<{ close: () => void }>; filewatchers: Array<{ close: () => void }>;
deferreds: { deferred: Deferred;
client: Deferred;
server: Deferred;
};
crashed: boolean; crashed: boolean;
restarting: boolean; restarting: boolean;
@@ -46,21 +54,36 @@ class Watcher extends EventEmitter {
app = locations.app(), app = locations.app(),
dest = locations.dest(), dest = locations.dest(),
routes = locations.routes(), routes = locations.routes(),
'dev-port': dev_port,
live,
hot,
bundler,
webpack = 'webpack', webpack = 'webpack',
rollup = 'rollup',
port = +process.env.PORT port = +process.env.PORT
}: { }: {
app: string, app: string,
dest: string, dest: string,
routes: string, routes: string,
'dev-port': number,
live: boolean,
hot: boolean,
bundler?: string,
webpack: string, webpack: string,
rollup: string,
port: number port: number
}) { }) {
super(); super();
this.dirs = { app, dest, routes, webpack }; this.bundler = validate_bundler(bundler);
this.dirs = { app, dest, routes, webpack, rollup };
this.port = port; this.port = port;
this.closed = false; this.closed = false;
this.dev_port = dev_port;
this.live = live;
this.hot = hot;
this.filewatchers = []; this.filewatchers = [];
this.current_build = { this.current_build = {
@@ -101,35 +124,59 @@ class Watcher extends EventEmitter {
const { dest } = this.dirs; const { dest } = this.dirs;
rimraf.sync(dest); rimraf.sync(dest);
mkdirp.sync(dest); mkdirp.sync(`${dest}/client`);
if (this.bundler === 'rollup') copy_shimport(dest);
const dev_port = await ports.find(10000); if (!this.dev_port) this.dev_port = await ports.find(10000);
const routes = create_routes(); let manifest_data: ManifestData;
create_main_manifests({ routes, dev_port });
this.dev_server = new DevServer(dev_port); try {
manifest_data = create_manifest_data();
create_main_manifests({ bundler: this.bundler, manifest_data, dev_port: this.dev_port });
} catch (err) {
this.emit('fatal', <events.FatalEvent>{
message: err.message
});
return;
}
this.dev_server = new DevServer(this.dev_port);
this.filewatchers.push( this.filewatchers.push(
watch_files(locations.routes(), ['add', 'unlink'], () => { watch_dir(
const routes = create_routes(); locations.routes(),
create_main_manifests({ routes, dev_port }); ({ path: file, stats }) => {
}), if (stats.isDirectory()) {
return path.basename(file)[0] !== '_';
}
return true;
},
() => {
try {
const new_manifest_data = create_manifest_data();
create_main_manifests({ bundler: this.bundler, manifest_data, dev_port: this.dev_port });
watch_files(`${locations.app()}/template.html`, ['change'], () => { manifest_data = new_manifest_data;
} catch (err) {
this.emit('error', <events.ErrorEvent>{
message: err.message
});
}
}
),
fs.watch(`${locations.app()}/template.html`, () => {
this.dev_server.send({ this.dev_server.send({
action: 'reload' action: 'reload'
}); });
}) })
); );
this.deferreds = { let deferred = new Deferred();
server: new Deferred(),
client: new Deferred()
};
// TODO watch the configs themselves? // TODO watch the configs themselves?
const compilers = create_compilers({ webpack: this.dirs.webpack }); const compilers: Compilers = create_compilers(this.bundler, this.dirs);
let log = ''; let log = '';
@@ -148,14 +195,13 @@ class Watcher extends EventEmitter {
invalid: filename => { invalid: filename => {
this.restart(filename, 'server'); this.restart(filename, 'server');
this.deferreds.server = new Deferred();
}, },
result: info => { handle_result: (result: CompileResult) => {
fs.writeFileSync(path.join(dest, 'server_info.json'), JSON.stringify(info, null, ' ')); deferred.promise.then(() => {
this.deferreds.client.promise.then(() => {
const restart = () => { const restart = () => {
this.emit('restart');
log = ''; log = '';
this.crashed = false; this.crashed = false;
@@ -166,11 +212,15 @@ class Watcher extends EventEmitter {
process: this.proc process: this.proc
}); });
this.deferreds.server.fulfil(); if (this.hot && this.bundler === 'webpack') {
this.dev_server.send({
this.dev_server.send({ status: 'completed'
status: 'completed' });
}); } else {
this.dev_server.send({
action: 'reload'
});
}
})) }))
.catch(err => { .catch(err => {
if (this.crashed) return; if (this.crashed) return;
@@ -221,32 +271,35 @@ class Watcher extends EventEmitter {
} }
}); });
let first = true;
this.watch(compilers.client, { this.watch(compilers.client, {
name: 'client', name: 'client',
invalid: filename => { invalid: filename => {
this.restart(filename, 'client'); this.restart(filename, 'client');
this.deferreds.client = new Deferred(); deferred = new Deferred();
// TODO we should delete old assets. due to a webpack bug // TODO we should delete old assets. due to a webpack bug
// i don't even begin to comprehend, this is apparently // i don't even begin to comprehend, this is apparently
// quite difficult // quite difficult
}, },
result: info => { handle_result: (result: CompileResult) => {
fs.writeFileSync(path.join(dest, 'client_info.json'), JSON.stringify(info)); fs.writeFileSync(
fs.writeFileSync(path.join(dest, 'client_assets.json'), JSON.stringify(info.assetsByChunkName, null, ' ')); path.join(dest, 'build.json'),
this.deferreds.client.fulfil();
const client_files = info.assets.map((chunk: { name: string }) => `client/${chunk.name}`); // TODO should be more explicit that to_json has effects
JSON.stringify(result.to_json(manifest_data, this.dirs), null, ' ')
);
const client_files = result.chunks.map(chunk => `client/${chunk.file}`);
create_serviceworker_manifest({ create_serviceworker_manifest({
routes: create_routes(), manifest_data,
client_files client_files
}); });
deferred.fulfil();
// we need to wait a beat before watching the service // we need to wait a beat before watching the service
// worker, because of some webpack nonsense // worker, because of some webpack nonsense
setTimeout(watch_serviceworker, 100); setTimeout(watch_serviceworker, 100);
@@ -258,11 +311,7 @@ class Watcher extends EventEmitter {
watch_serviceworker = noop; watch_serviceworker = noop;
this.watch(compilers.serviceworker, { this.watch(compilers.serviceworker, {
name: 'service worker', name: 'service worker'
result: info => {
fs.writeFileSync(path.join(dest, 'serviceworker_info.json'), JSON.stringify(info, null, ' '));
}
}); });
} }
: noop; : noop;
@@ -272,7 +321,7 @@ class Watcher extends EventEmitter {
if (this.closed) return; if (this.closed) return;
this.closed = true; this.closed = true;
this.dev_server.close(); if (this.dev_server) this.dev_server.close();
if (this.proc) this.proc.kill(); if (this.proc) this.proc.kill();
this.filewatchers.forEach(watcher => { this.filewatchers.forEach(watcher => {
@@ -309,95 +358,34 @@ class Watcher extends EventEmitter {
} }
} }
watch(compiler: any, { name, invalid = noop, result }: { watch(compiler: Compiler, { name, invalid = noop, handle_result = noop }: {
name: string, name: string,
invalid?: (filename: string) => void; invalid?: (filename: string) => void;
result: (stats: any) => void; handle_result?: (result: CompileResult) => void;
}) { }) {
compiler.hooks.invalid.tap('sapper', (filename: string) => { compiler.oninvalid(invalid);
invalid(filename);
});
compiler.watch({}, (err: Error, stats: any) => { compiler.watch((err?: Error, result?: CompileResult) => {
if (err) { if (err) {
this.emit('error', <events.ErrorEvent>{ this.emit('error', <events.ErrorEvent>{
type: name, type: name,
message: err.message message: err.message
}); });
} else { } else {
const messages = format_messages(stats);
const info = stats.toJson();
this.emit('build', { this.emit('build', {
type: name, type: name,
duration: info.time, duration: result.duration,
errors: result.errors,
errors: messages.errors.map((message: string) => { warnings: result.warnings
const duplicate = this.current_build.unique_errors.has(message);
this.current_build.unique_errors.add(message);
return mungeWebpackError(message, duplicate);
}),
warnings: messages.warnings.map((message: string) => {
const duplicate = this.current_build.unique_warnings.has(message);
this.current_build.unique_warnings.add(message);
return mungeWebpackError(message, duplicate);
}),
}); });
result(info); handle_result(result);
} }
}); });
} }
} }
const locPattern = /\((\d+):(\d+)\)$/;
function mungeWebpackError(message: string, duplicate: boolean) {
// TODO this is all a bit rube goldberg...
const lines = message.split('\n');
const file = lines.shift()
.replace('', '') // careful — there is a special character at the beginning of this string
.replace('', '')
.replace('./', '');
let line = null;
let column = null;
const match = locPattern.exec(lines[0]);
if (match) {
lines[0] = lines[0].replace(locPattern, '');
line = +match[1];
column = +match[2];
}
return {
file,
line,
column,
message: lines.join('\n'),
originalMessage: message,
duplicate
};
}
class Deferred {
promise: Promise<any>;
fulfil: (value?: any) => void;
reject: (error: Error) => void;
constructor() {
this.promise = new Promise((fulfil, reject) => {
this.fulfil = fulfil;
this.reject = reject;
});
}
}
const INTERVAL = 10000; const INTERVAL = 10000;
class DevServer { class DevServer {
@@ -452,20 +440,32 @@ class DevServer {
function noop() {} function noop() {}
function watch_files(pattern: string, events: string[], callback: () => void) { function watch_dir(
const chokidar = require('chokidar'); dir: string,
filter: ({ path, stats }: { path: string, stats: fs.Stats }) => boolean,
callback: () => void
) {
let watch;
let closed = false;
const watcher = chokidar.watch(pattern, { import('cheap-watch').then(CheapWatch => {
persistent: true, if (closed) return;
ignoreInitial: true,
disableGlobbing: true
});
events.forEach(event => { watch = new CheapWatch({ dir, filter, debounce: 50 });
watcher.on(event, callback);
watch.on('+', ({ isNew }) => {
if (isNew) callback();
});
watch.on('-', callback);
watch.init();
}); });
return { return {
close: () => watcher.close() close: () => {
if (watch) watch.close();
closed = true;
}
}; };
} }

View File

@@ -1,16 +1,23 @@
import * as child_process from 'child_process'; import * as child_process from 'child_process';
import * as path from 'path'; import * as path from 'path';
import * as sander from 'sander'; import * as sander from 'sander';
import cheerio from 'cheerio'; import * as url from 'url';
import URL from 'url-parse';
import fetch from 'node-fetch'; import fetch from 'node-fetch';
import * as ports from 'port-authority'; import * as ports from 'port-authority';
import { EventEmitter } from 'events'; import { EventEmitter } from 'events';
import { minify_html } from './utils/minify_html'; import clean_html from './utils/clean_html';
import { locations } from '../config'; import minify_html from './utils/minify_html';
import Deferred from './utils/Deferred';
import * as events from './interfaces'; import * as events from './interfaces';
export function exporter(opts: {}) { type Opts = {
build: string,
dest: string,
basepath?: string,
timeout: number | false
};
export function exporter(opts: Opts) {
const emitter = new EventEmitter(); const emitter = new EventEmitter();
execute(emitter, opts).then( execute(emitter, opts).then(
@@ -27,37 +34,48 @@ export function exporter(opts: {}) {
return emitter; return emitter;
} }
async function execute(emitter: EventEmitter, { function resolve(from: string, to: string) {
build = 'build', return url.parse(url.resolve(from, to));
dest = 'export', }
basepath = ''
} = {}) { type URL = url.UrlWithStringQuery;
const export_dir = path.join(dest, basepath);
async function execute(emitter: EventEmitter, opts: Opts) {
const export_dir = path.join(opts.dest, opts.basepath);
// Prep output directory // Prep output directory
sander.rimrafSync(export_dir); sander.rimrafSync(export_dir);
sander.copydirSync('assets').to(export_dir); sander.copydirSync('assets').to(export_dir);
sander.copydirSync(build, 'client').to(export_dir, 'client'); sander.copydirSync(opts.build, 'client').to(export_dir, 'client');
if (sander.existsSync(build, 'service-worker.js')) { if (sander.existsSync(opts.build, 'service-worker.js')) {
sander.copyFileSync(build, 'service-worker.js').to(export_dir, 'service-worker.js'); sander.copyFileSync(opts.build, 'service-worker.js').to(export_dir, 'service-worker.js');
} }
if (sander.existsSync(build, 'service-worker.js.map')) { if (sander.existsSync(opts.build, 'service-worker.js.map')) {
sander.copyFileSync(build, 'service-worker.js.map').to(export_dir, 'service-worker.js.map'); sander.copyFileSync(opts.build, 'service-worker.js.map').to(export_dir, 'service-worker.js.map');
} }
const port = await ports.find(3000); const port = await ports.find(3000);
const origin = `http://localhost:${port}`; const protocol = 'http:';
const host = `localhost:${port}`;
const origin = `${protocol}//${host}`;
const proc = child_process.fork(path.resolve(`${build}/server.js`), [], { const root = resolve(origin, opts.basepath || '');
if (!root.href.endsWith('/')) root.href += '/';
emitter.emit('info', {
message: `Crawling ${root.href}`
});
const proc = child_process.fork(path.resolve(`${opts.build}/server.js`), [], {
cwd: process.cwd(), cwd: process.cwd(),
env: Object.assign({ env: Object.assign({
PORT: port, PORT: port,
NODE_ENV: 'production', NODE_ENV: 'production',
SAPPER_DEST: build, SAPPER_DEST: opts.build,
SAPPER_EXPORT: 'true' SAPPER_EXPORT: 'true'
}, process.env) }, process.env)
}); });
@@ -65,16 +83,14 @@ async function execute(emitter: EventEmitter, {
const seen = new Set(); const seen = new Set();
const saved = new Set(); const saved = new Set();
proc.on('message', message => { function save(path: string, status: number, type: string, body: string) {
if (!message.__sapper__ || message.event !== 'file') return; const { pathname } = resolve(origin, path);
let file = pathname.slice(1);
let file = new URL(message.url, origin).pathname.slice(1);
let { body } = message;
if (saved.has(file)) return; if (saved.has(file)) return;
saved.add(file); saved.add(file);
const is_html = message.type === 'text/html'; const is_html = type === 'text/html';
if (is_html) { if (is_html) {
file = file === '' ? 'index.html' : `${file}/index.html`; file = file === '' ? 'index.html' : `${file}/index.html`;
@@ -83,49 +99,95 @@ async function execute(emitter: EventEmitter, {
emitter.emit('file', <events.FileEvent>{ emitter.emit('file', <events.FileEvent>{
file, file,
size: body.length size: body.length,
status
}); });
sander.writeFileSync(export_dir, file, body); sander.writeFileSync(export_dir, file, body);
}
proc.on('message', message => {
if (!message.__sapper__ || message.event !== 'file') return;
save(message.url, message.status, message.type, message.body);
}); });
async function handle(url: URL) { async function handle(url: URL) {
const r = await fetch(url.href); const pathname = (url.pathname.replace(root.pathname, '') || '/');
if (seen.has(pathname)) return;
seen.add(pathname);
const timeout_deferred = new Deferred();
const timeout = setTimeout(() => {
timeout_deferred.reject(new Error(`Timed out waiting for ${url.href}`));
}, opts.timeout);
const r = await Promise.race([
fetch(url.href, {
redirect: 'manual'
}),
timeout_deferred.promise
]);
clearTimeout(timeout); // prevent it hanging at the end
let type = r.headers.get('Content-Type');
let body = await r.text();
const range = ~~(r.status / 100); const range = ~~(r.status / 100);
if (range >= 4) {
emitter.emit('failure', <events.FailureEvent>{
status: r.status,
pathname: url.pathname
});
return;
}
if (range === 2) { if (range === 2) {
if (r.headers.get('Content-Type') === 'text/html') { if (type === 'text/html') {
const body = await r.text();
const $ = cheerio.load(body);
const urls: URL[] = []; const urls: URL[] = [];
const base = new URL($('base').attr('href') || '/', url.href); const cleaned = clean_html(body);
$('a[href]').each((i: number, $a) => { const base_match = /<base ([\s\S]+?)>/m.exec(cleaned);
const url = new URL($a.attribs.href, base.href); const base_href = base_match && get_href(base_match[1]);
const base = resolve(url.href, base_href);
if (url.origin === origin && !seen.has(url.pathname)) { let match;
seen.add(url.pathname); let pattern = /<a ([\s\S]+?)>/gm;
urls.push(url);
while (match = pattern.exec(cleaned)) {
const attrs = match[1];
const href = get_href(attrs);
if (href) {
const url = resolve(base.href, href);
if (url.protocol === protocol && url.host === host) {
urls.push(url);
}
} }
});
for (const url of urls) {
await handle(url);
} }
await Promise.all(urls.map(handle));
} }
} }
if (range === 3) {
const location = r.headers.get('Location');
type = 'text/html';
body = `<script>window.location.href = "${location.replace(origin, '')}"</script>`;
await handle(resolve(root.href, location));
}
save(pathname, r.status, type, body);
} }
return ports.wait(port) return ports.wait(port)
.then(() => handle(new URL(`/${basepath}`, origin))) // TODO all static routes .then(() => handle(root))
.then(() => proc.kill()); .then(() => proc.kill())
.catch(err => {
proc.kill();
throw err;
});
} }
function get_href(attrs: string) {
const match = /href\s*=\s*(?:"(.+?)"|'(.+?)'|([^\s>]+))/.exec(attrs);
return match[1] || match[2] || match[3];
}

View File

@@ -1,16 +1,14 @@
import * as glob from 'glob';
import { locations } from '../config'; import { locations } from '../config';
import { create_routes } from '../core'; import { create_manifest_data } from '../core';
export function find_page(pathname: string, files: string[] = glob.sync('**/*.*', { cwd: locations.routes(), dot: true, nodir: true })) { export function find_page(pathname: string, cwd = locations.routes()) {
const routes = create_routes({ files }); const { pages } = create_manifest_data(cwd);
for (let i = 0; i < routes.length; i += 1) { for (let i = 0; i < pages.length; i += 1) {
const route = routes[i]; const page = pages[i];
if (route.pattern.test(pathname)) { if (page.pattern.test(pathname)) {
const page = route.handlers.find(handler => handler.type === 'page'); return page.parts[page.parts.length - 1].component.file;
if (page) return page.file;
} }
} }
} }

View File

@@ -1,4 +1,5 @@
import * as child_process from 'child_process'; import * as child_process from 'child_process';
import { CompileResult } from '../core/create_compilers';
export type ReadyEvent = { export type ReadyEvent = {
port: number; port: number;
@@ -26,10 +27,10 @@ export type InvalidEvent = {
export type BuildEvent = { export type BuildEvent = {
type: string; type: string;
errors: Array<{ message: string, duplicate: boolean }>; errors: Array<{ file: string, message: string, duplicate: boolean }>;
warnings: Array<{ message: string, duplicate: boolean }>; warnings: Array<{ file: string, message: string, duplicate: boolean }>;
duration: number; duration: number;
webpack_stats: any; result: CompileResult;
} }
export type FileEvent = { export type FileEvent = {
@@ -41,4 +42,4 @@ export type FailureEvent = {
} }
export type DoneEvent = {} export type DoneEvent = {};

12
src/api/utils/Deferred.ts Normal file
View File

@@ -0,0 +1,12 @@
export default class Deferred {
promise: Promise<any>;
fulfil: (value?: any) => void;
reject: (error: Error) => void;
constructor() {
this.promise = new Promise((fulfil, reject) => {
this.fulfil = fulfil;
this.reject = reject;
});
}
}

View File

@@ -0,0 +1,7 @@
export default function clean_html(html: string) {
return html
.replace(/<!\[CDATA\[[\s\S]*?\]\]>/gm, '')
.replace(/(<script[\s\S]*?>)[\s\S]*?<\/script>/gm, '$1</' + 'script>')
.replace(/(<style[\s\S]*?>)[\s\S]*?<\/style>/gm, '$1</' + 'style>')
.replace(/<!--[\s\S]*?-->/gm, '');
}

View File

@@ -0,0 +1,9 @@
import * as fs from 'fs';
export function copy_shimport(dest: string) {
const shimport_version = require('shimport/package.json').version;
fs.writeFileSync(
`${dest}/client/shimport@${shimport_version}.js`,
fs.readFileSync(require.resolve('shimport/index.js'))
);
}

View File

@@ -1,6 +1,6 @@
import { minify } from 'html-minifier'; import { minify } from 'html-minifier';
export function minify_html(html: string) { export default function minify_html(html: string) {
return minify(html, { return minify(html, {
collapseBooleanAttributes: true, collapseBooleanAttributes: true,
collapseWhitespace: true, collapseWhitespace: true,
@@ -8,7 +8,7 @@ export function minify_html(html: string) {
decodeEntities: true, decodeEntities: true,
html5: true, html5: true,
minifyCSS: true, minifyCSS: true,
minifyJS: true, minifyJS: false,
removeAttributeQuotes: true, removeAttributeQuotes: true,
removeComments: true, removeComments: true,
removeOptionalTags: true, removeOptionalTags: true,

View File

@@ -1,11 +1,8 @@
import * as fs from 'fs'; import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as child_process from 'child_process';
import sade from 'sade'; import sade from 'sade';
import * as colors from 'ansi-colors'; import colors from 'kleur';
import prettyMs from 'pretty-ms'; import prettyMs from 'pretty-ms';
// import upgrade from './cli/upgrade';
import * as ports from 'port-authority';
import * as pkg from '../package.json'; import * as pkg from '../package.json';
const prog = sade('sapper').version(pkg.version); const prog = sade('sapper').version(pkg.version);
@@ -14,7 +11,20 @@ prog.command('dev')
.describe('Start a development server') .describe('Start a development server')
.option('-p, --port', 'Specify a port') .option('-p, --port', 'Specify a port')
.option('-o, --open', 'Open a browser window') .option('-o, --open', 'Open a browser window')
.action(async (opts: { port: number, open: boolean }) => { .option('--dev-port', 'Specify a port for development server')
.option('--hot', 'Use hot module replacement (requires webpack)', true)
.option('--live', 'Reload on changes if not using --hot', true)
.option('--bundler', 'Specify a bundler (rollup or webpack)')
.option('--stream', 'Stream logs, instead of boxing them', false)
.action(async (opts: {
port: number,
open: boolean,
'dev-port': number,
live: boolean,
hot: boolean,
bundler?: string,
stream: boolean
}) => {
const { dev } = await import('./cli/dev'); const { dev } = await import('./cli/dev');
dev(opts); dev(opts);
}); });
@@ -22,8 +32,14 @@ prog.command('dev')
prog.command('build [dest]') prog.command('build [dest]')
.describe('Create a production-ready version of your app') .describe('Create a production-ready version of your app')
.option('-p, --port', 'Default of process.env.PORT', '3000') .option('-p, --port', 'Default of process.env.PORT', '3000')
.option('--bundler', 'Specify a bundler (rollup or webpack, blank for auto)')
.option('--legacy', 'Create separate legacy build')
.example(`build custom-dir -p 4567`) .example(`build custom-dir -p 4567`)
.action(async (dest = 'build', opts: { port: string }) => { .action(async (dest = 'build', opts: {
port: string,
legacy: boolean,
bundler?: string
}) => {
console.log(`> Building...`); console.log(`> Building...`);
process.env.NODE_ENV = process.env.NODE_ENV || 'production'; process.env.NODE_ENV = process.env.NODE_ENV || 'production';
@@ -33,7 +49,7 @@ prog.command('build [dest]')
try { try {
const { build } = await import('./cli/build'); const { build } = await import('./cli/build');
await build(); await build(opts);
const launcher = path.resolve(dest, 'index.js'); const launcher = path.resolve(dest, 'index.js');
@@ -49,7 +65,7 @@ prog.command('build [dest]')
console.error(`\n> Finished in ${elapsed(start)}. Type ${colors.bold.cyan(`node ${dest}`)} to run the app.`); console.error(`\n> Finished in ${elapsed(start)}. Type ${colors.bold.cyan(`node ${dest}`)} to run the app.`);
} catch (err) { } catch (err) {
console.error(err ? err.details || err.stack || err.message || err : 'Unknown error'); console.log(`${colors.bold.red(`> ${err.message}`)}`);
process.exit(1); process.exit(1);
} }
}); });
@@ -65,25 +81,38 @@ prog.command('start [dir]')
prog.command('export [dest]') prog.command('export [dest]')
.describe('Export your app as static files (if possible)') .describe('Export your app as static files (if possible)')
.option('--build', '(Re)build app before exporting', true)
.option('--build-dir', 'Specify a custom temporary build directory', '.sapper/prod')
.option('--basepath', 'Specify a base path') .option('--basepath', 'Specify a base path')
.action(async (dest = 'export', opts: { basepath?: string }) => { .option('--timeout', 'Milliseconds to wait for a page (--no-timeout to disable)', 5000)
console.log(`> Building...`); .option('--legacy', 'Create separate legacy build')
.option('--bundler', 'Specify a bundler (rollup or webpack, blank for auto)')
.action(async (dest = 'export', opts: {
build: boolean,
legacy: boolean,
bundler?: string,
'build-dir': string,
basepath?: string,
timeout: number | false
}) => {
process.env.NODE_ENV = 'production'; process.env.NODE_ENV = 'production';
process.env.SAPPER_DEST = '.sapper/.export'; process.env.SAPPER_DEST = opts['build-dir'];
const start = Date.now(); const start = Date.now();
try { try {
const { build } = await import('./cli/build'); if (opts.build) {
await build(); console.log(`> Building...`);
console.error(`\n> Built in ${elapsed(start)}. Crawling site...`); const { build } = await import('./cli/build');
await build(opts);
console.error(`\n> Built in ${elapsed(start)}`);
}
const { exporter } = await import('./cli/export'); const { exporter } = await import('./cli/export');
await exporter(dest, opts); await exporter(dest, opts);
console.error(`\n> Finished in ${elapsed(start)}. Type ${colors.bold.cyan(`npx serve ${dest}`)} to run the app.`); console.error(`\n> Finished in ${elapsed(start)}. Type ${colors.bold.cyan(`npx serve ${dest}`)} to run the app.`);
} catch (err) { } catch (err) {
console.error(err ? err.details || err.stack || err.message || err : 'Unknown error'); console.error(colors.bold.red(`> ${err.message}`));
process.exit(1); process.exit(1);
} }
}); });

View File

@@ -1,20 +1,45 @@
import { build as _build } from '../api/build'; import { build as _build } from '../api/build';
import * as colors from 'ansi-colors'; import colors from 'kleur';
import { locations } from '../config'; import { locations } from '../config';
import validate_bundler from './utils/validate_bundler';
import { repeat } from '../utils';
export function build(opts: { bundler?: string, legacy?: boolean }) {
const bundler = validate_bundler(opts.bundler);
if (opts.legacy && bundler === 'webpack') {
throw new Error(`Legacy builds are not supported for projects using webpack`);
}
export function build() {
return new Promise((fulfil, reject) => { return new Promise((fulfil, reject) => {
try { try {
const emitter = _build({ const emitter = _build({
legacy: opts.legacy,
bundler
}, {
dest: locations.dest(), dest: locations.dest(),
app: locations.app(), app: locations.app(),
routes: locations.routes(), routes: locations.routes(),
webpack: 'webpack' webpack: 'webpack',
rollup: 'rollup'
}); });
emitter.on('build', event => { emitter.on('build', event => {
console.log(colors.inverse(`\nbuilt ${event.type}`)); let banner = `built ${event.type}`;
console.log(event.webpack_stats.toString({ colors: true })); let c = colors.cyan;
const { warnings } = event.result;
if (warnings.length > 0) {
banner += ` with ${warnings.length} ${warnings.length === 1 ? 'warning' : 'warnings'}`;
c = colors.yellow;
}
console.log();
console.log(c(`┌─${repeat('─', banner.length)}─┐`));
console.log(c(`${colors.bold(banner) }`));
console.log(c(`└─${repeat('─', banner.length)}─┘`));
console.log(event.result.print());
}); });
emitter.on('error', event => { emitter.on('error', event => {
@@ -25,8 +50,7 @@ export function build() {
fulfil(); fulfil();
}); });
} catch (err) { } catch (err) {
console.log(`${colors.bold.red(`> ${err.message}`)}`); reject(err);
process.exit(1);
} }
}); });
} }

View File

@@ -1,78 +1,263 @@
import * as path from 'path'; import * as path from 'path';
import * as colors from 'ansi-colors'; import colors from 'kleur';
import * as child_process from 'child_process'; import * as child_process from 'child_process';
import * as blessed from 'blessed';
import prettyMs from 'pretty-ms'; import prettyMs from 'pretty-ms';
import { dev as _dev } from '../api/dev'; import { dev as _dev } from '../api/dev';
import * as events from '../api/interfaces'; import * as events from '../api/interfaces';
export function dev(opts: { port: number, open: boolean }) { function boxed_output() {
const screen = blessed.screen({
smartCSR: true
});
function box(opts) {
opts = Object.assign({
width: '100%',
height: '50%',
scrollable: true,
style: {
scrollbar: {
bg: 'black'
}
},
scrollbar: {},
input: true,
mouse: true,
keys: true,
scrollOnInput: false
}, opts);
return blessed.box(opts);
}
const status_box = box({});
const log_box = box({
bottom: '0'
});
let mouse_is_down = false;
let dragging = false;
let did_drag = false;
let divider_is_horizontal = true;
function update_split(x: number, y: number) {
if (divider_is_horizontal) {
horizontal_divider.top = y;
status_box.width = log_box.width = '100%';
status_box.height = y;
log_box.height = screen.height - (y + 1);
log_box.top = y + 1;
log_box.left = 0;
} else {
vertical_divider.left = x;
status_box.height = log_box.height = '100%';
status_box.width = x;
log_box.width = screen.width - (x + 1);
log_box.left = x + 1;
log_box.top = 0;
}
screen.render();
}
screen.on('mousedown', data => {
if (mouse_is_down) {
if (dragging) {
update_split(data.x, data.y);
did_drag = true;
}
} else {
if (data.y === horizontal_divider.top) {
dragging = true;
}
mouse_is_down = true;
}
});
screen.on('mouseup', data => {
mouse_is_down = false;
dragging = false;
did_drag = false;
});
const horizontal_divider = blessed.line({
top: '50%',
orientation: 'horizontal'
});
const vertical_divider = blessed.line({
left: '50%',
orientation: 'vertical'
});
horizontal_divider.on('click', event => {
if (!did_drag) {
horizontal_divider.hide();
vertical_divider.show();
divider_is_horizontal = false;
update_split(event.x, event.y);
}
});
vertical_divider.on('click', event => {
if (!did_drag) {
vertical_divider.hide();
horizontal_divider.show();
divider_is_horizontal = true;
update_split(event.x, event.y);
}
});
vertical_divider.hide();
screen.append(status_box);
screen.append(log_box);
screen.append(horizontal_divider);
screen.append(vertical_divider);
update_split(process.stdout.columns >> 1, process.stdout.rows >> 1);
screen.key(['escape', 'q', 'C-c'], function(ch, key) {
return process.exit(0);
});
const append_log = (data: Buffer | string) => {
log_box.setContent(log_box.content + data);
screen.render();
};
const append_status = (data: Buffer | string) => {
status_box.setContent(status_box.content + data);
screen.render();
};
let first = true;
return {
stdout: append_log,
stderr: append_log,
clear_logs: () => {
let content = `${colors.inverse(` server log • ${new Date().toISOString()}\n`)} \n`;
if (first) {
content += colors.gray(`> Click/drag the divider to adjust the split\n\n`);
first = false;
}
log_box.setContent(content);
screen.render();
},
log: (line: string) => {
append_status(line + '\n');
},
append: append_status,
clear: () => {
status_box.setContent(`${colors.inverse(` build log • ${new Date().toISOString()}\n`)} \n`);
screen.render();
}
};
}
function streamed_output() {
return {
stdout: process.stdout.write.bind(process.stdout),
stderr: process.stderr.write.bind(process.stderr),
clear_logs: () => {},
log: (line: string) => {
console.log(line);
},
append: (data: Buffer | string) => {
process.stdout.write(data);
},
clear: () => {}
};
}
export function dev(opts: { port: number, open: boolean, bundler?: string, stream: boolean }) {
const output = opts.stream
? streamed_output()
: boxed_output();
output.clear();
try { try {
const watcher = _dev(opts); const watcher = _dev(opts);
let first = true; let first = true;
watcher.on('ready', (event: events.ReadyEvent) => { watcher.on('ready', (event: events.ReadyEvent) => {
output.log(colors.bold.cyan(`> Listening on http://localhost:${event.port}`));
if (first) { if (first) {
console.log(`${colors.bold.cyan(`> Listening on http://localhost:${event.port}`)}`);
if (opts.open) child_process.exec(`open http://localhost:${event.port}`); if (opts.open) child_process.exec(`open http://localhost:${event.port}`);
first = false; first = false;
} }
// TODO clear screen?
event.process.stdout.on('data', data => {
process.stdout.write(data);
});
event.process.stderr.on('data', data => {
process.stderr.write(data);
});
}); });
watcher.on('restart', output.clear_logs);
watcher.on('stdout', output.stdout);
watcher.on('stderr', output.stderr);
watcher.on('invalid', (event: events.InvalidEvent) => { watcher.on('invalid', (event: events.InvalidEvent) => {
const changed = event.changed.map(filename => path.relative(process.cwd(), filename)).join(', '); const changed = event.changed.map(filename => path.relative(process.cwd(), filename)).join(', ');
console.log(`\n${colors.bold.cyan(changed)} changed. rebuilding...`);
output.clear();
output.log(`${colors.bold.cyan(changed)} changed. rebuilding...`);
}); });
watcher.on('error', (event: events.ErrorEvent) => { watcher.on('error', (event: events.ErrorEvent) => {
console.log(`${colors.red(`${event.type}`)}`); output.log(colors.red(`${event.type}`));
console.log(`${colors.red(event.message)}`); output.log(colors.red(event.message));
}); });
watcher.on('fatal', (event: events.FatalEvent) => { watcher.on('fatal', (event: events.FatalEvent) => {
console.log(`${colors.bold.red(`> ${event.message}`)}`); output.log(colors.bold.red(`> ${event.message}`));
if (event.log) console.log(event.log); if (event.log) output.log(event.log);
}); });
watcher.on('build', (event: events.BuildEvent) => { watcher.on('build', (event: events.BuildEvent) => {
if (event.errors.length) { if (event.errors.length) {
console.log(`${colors.bold.red(`${event.type}`)}`); output.log(colors.bold.red(`${event.type}`));
event.errors.filter(e => !e.duplicate).forEach(error => { event.errors.filter(e => !e.duplicate).forEach(error => {
console.log(error.message); if (error.file) output.log(colors.bold(error.file));
output.log(error.message);
}); });
const hidden = event.errors.filter(e => e.duplicate).length; const hidden = event.errors.filter(e => e.duplicate).length;
if (hidden > 0) { if (hidden > 0) {
console.log(`${hidden} duplicate ${hidden === 1 ? 'error' : 'errors'} hidden\n`); output.log(`${hidden} duplicate ${hidden === 1 ? 'error' : 'errors'} hidden\n`);
} }
} else if (event.warnings.length) { } else if (event.warnings.length) {
console.log(`${colors.bold.yellow(`${event.type}`)}`); output.log(colors.bold.yellow(`${event.type}`));
event.warnings.filter(e => !e.duplicate).forEach(warning => { event.warnings.filter(e => !e.duplicate).forEach(warning => {
console.log(warning.message); if (warning.file) output.log(colors.bold(warning.file));
output.log(warning.message);
}); });
const hidden = event.warnings.filter(e => e.duplicate).length; const hidden = event.warnings.filter(e => e.duplicate).length;
if (hidden > 0) { if (hidden > 0) {
console.log(`${hidden} duplicate ${hidden === 1 ? 'warning' : 'warnings'} hidden\n`); output.log(`${hidden} duplicate ${hidden === 1 ? 'warning' : 'warnings'} hidden\n`);
} }
} else { } else {
console.log(`${colors.bold.green(`${event.type}`)} ${colors.gray(`(${prettyMs(event.duration)})`)}`); output.log(`${colors.bold.green(`${event.type}`)} ${colors.gray(`(${prettyMs(event.duration)})`)}`);
} }
}); });
} catch (err) { } catch (err) {
console.log(`${colors.bold.red(`> ${err.message}`)}`); output.log(colors.bold.red(`> ${err.message}`));
process.exit(1); process.exit(1);
} }
} }

View File

@@ -1,23 +1,38 @@
import { exporter as _exporter } from '../api/export'; import { exporter as _exporter } from '../api/export';
import * as colors from 'ansi-colors'; import colors from 'kleur';
import prettyBytes from 'pretty-bytes'; import pb from 'pretty-bytes';
import { locations } from '../config'; import { locations } from '../config';
import { left_pad } from '../utils';
export function exporter(export_dir: string, { basepath = '' }) { export function exporter(export_dir: string, {
basepath = '',
timeout
}: {
basepath: string,
timeout: number | false
}) {
return new Promise((fulfil, reject) => { return new Promise((fulfil, reject) => {
try { try {
const emitter = _exporter({ const emitter = _exporter({
build: locations.dest(), build: locations.dest(),
dest: export_dir, dest: export_dir,
basepath basepath,
timeout
}); });
emitter.on('file', event => { emitter.on('file', event => {
console.log(`${colors.bold.cyan(event.file)} ${colors.gray(`(${prettyBytes(event.size)})`)}`); const size_color = event.size > 150000 ? colors.bold.red : event.size > 50000 ? colors.bold.yellow : colors.bold.gray;
const size_label = size_color(left_pad(pb(event.size), 10));
const file_label = event.status === 200
? event.file
: colors.bold[event.status >= 400 ? 'red' : 'yellow'](`(${event.status}) ${event.file}`);
console.log(`${size_label} ${file_label}`);
}); });
emitter.on('failure', event => { emitter.on('info', event => {
console.log(`${colors.red(`> Received ${event.status} response when fetching ${event.pathname}`)}`); console.log(colors.bold.cyan(`> ${event.message}`));
}); });
emitter.on('error', event => { emitter.on('error', event => {

View File

@@ -1,7 +1,7 @@
import * as fs from 'fs'; import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as child_process from 'child_process'; import * as child_process from 'child_process';
import * as colors from 'ansi-colors'; import colors from 'kleur';
import * as ports from 'port-authority'; import * as ports from 'port-authority';
export async function start(dir: string, opts: { port: number, open: boolean }) { export async function start(dir: string, opts: { port: number, open: boolean }) {

View File

@@ -1,5 +1,5 @@
import * as fs from 'fs'; import * as fs from 'fs';
import * as colors from 'ansi-colors'; import colors from 'kleur';
export default async function upgrade() { export default async function upgrade() {
const upgraded = [ const upgraded = [

View File

@@ -0,0 +1,21 @@
import * as fs from 'fs';
export default function validate_bundler(bundler?: string) {
if (!bundler) {
bundler = (
fs.existsSync('rollup') ? 'rollup' :
fs.existsSync('webpack') ? 'webpack' :
null
);
if (!bundler) {
throw new Error(`Could not find a 'rollup' or 'webpack' directory`);
}
}
if (bundler !== 'rollup' && bundler !== 'webpack') {
throw new Error(`'${bundler}' is not a valid option for --bundler — must be either 'rollup' or 'webpack'`);
}
return bundler;
}

View File

@@ -6,5 +6,5 @@ export const locations = {
base: () => path.resolve(process.env.SAPPER_BASE || ''), base: () => path.resolve(process.env.SAPPER_BASE || ''),
app: () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_APP || 'app'), app: () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_APP || 'app'),
routes: () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_ROUTES || 'routes'), routes: () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_ROUTES || 'routes'),
dest: () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_DEST || '.sapper') dest: () => path.resolve(process.env.SAPPER_BASE || '', process.env.SAPPER_DEST || `.sapper/${dev() ? 'dev' : 'prod'}`)
}; };

View File

@@ -1,3 +1,3 @@
export * from './core/create_manifests'; export * from './core/create_manifests';
export { default as create_compilers } from './core/create_compilers'; export { default as create_compilers } from './core/create_compilers/index';
export { default as create_routes } from './core/create_routes'; export { default as create_manifest_data } from './core/create_manifest_data';

View File

@@ -1,29 +0,0 @@
import * as path from 'path';
import relative from 'require-relative';
export default function create_compilers({ webpack }: { webpack: string }) {
const wp = relative('webpack', process.cwd());
const serviceworker_config = try_require(path.resolve(`${webpack}/service-worker.config.js`));
return {
client: wp(
require(path.resolve(`${webpack}/client.config.js`))
),
server: wp(
require(path.resolve(`${webpack}/server.config.js`))
),
serviceworker: serviceworker_config && wp(serviceworker_config)
};
}
function try_require(specifier: string) {
try {
return require(specifier);
} catch (err) {
if (err.code === 'MODULE_NOT_FOUND') return null;
throw err;
}
}

View File

@@ -0,0 +1,160 @@
import * as path from 'path';
import relative from 'require-relative';
import { CompileResult } from './interfaces';
import RollupResult from './RollupResult';
let rollup: any;
export default class RollupCompiler {
_: Promise<any>;
_oninvalid: (filename: string) => void;
_start: number;
input: string;
warnings: any[];
errors: any[];
chunks: any[];
css_files: Array<{ id: string, code: string }>;
constructor(config: string) {
this._ = this.get_config(path.resolve(config));
this.input = null;
this.warnings = [];
this.errors = [];
this.chunks = [];
this.css_files = [];
}
async get_config(input: string) {
if (!rollup) rollup = relative('rollup', process.cwd());
const bundle = await rollup.rollup({
input,
external: (id: string) => {
return (id[0] !== '.' && !path.isAbsolute(id)) || id.slice(-5, id.length) === '.json';
}
});
const { code } = await bundle.generate({ format: 'cjs' });
// temporarily override require
const defaultLoader = require.extensions['.js'];
require.extensions['.js'] = (module: any, filename: string) => {
if (filename === input) {
module._compile(code, filename);
} else {
defaultLoader(module, filename);
}
};
const mod: any = require(input);
delete require.cache[input];
(mod.plugins || (mod.plugins = [])).push({
name: 'sapper-internal',
options: (opts: any) => {
this.input = opts.input;
},
renderChunk: (code: string, chunk: any) => {
this.chunks.push(chunk);
},
transform: (code: string, id: string) => {
if (/\.css$/.test(id)) {
this.css_files.push({ id, code });
return ``;
}
}
});
const onwarn = mod.onwarn || ((warning: any, handler: (warning: any) => void) => {
handler(warning);
});
mod.onwarn = (warning: any) => {
onwarn(warning, (warning: any) => {
this.warnings.push(warning);
});
};
return mod;
}
oninvalid(cb: (filename: string) => void) {
this._oninvalid = cb;
}
async compile(): Promise<CompileResult> {
const config = await this._;
const start = Date.now();
try {
const bundle = await rollup.rollup(config);
await bundle.write(config.output);
return new RollupResult(Date.now() - start, this);
} catch (err) {
if (err.filename) {
// TODO this is a bit messy. Also, can
// Rollup emit other kinds of error?
err.message = [
`Failed to build — error in ${err.filename}: ${err.message}`,
err.frame
].filter(Boolean).join('\n');
}
throw err;
}
}
async watch(cb: (err?: Error, stats?: any) => void) {
const config = await this._;
const watcher = rollup.watch(config);
watcher.on('change', (id: string) => {
this.chunks = [];
this.warnings = [];
this.errors = [];
this._oninvalid(id);
});
watcher.on('event', (event: any) => {
switch (event.code) {
case 'FATAL':
// TODO kill the process?
if (event.error.filename) {
// TODO this is a bit messy. Also, can
// Rollup emit other kinds of error?
event.error.message = [
`Failed to build — error in ${event.error.filename}: ${event.error.message}`,
event.error.frame
].filter(Boolean).join('\n');
}
cb(event.error);
break;
case 'ERROR':
this.errors.push(event.error);
cb(null, new RollupResult(Date.now() - this._start, this));
break;
case 'START':
case 'END':
// TODO is there anything to do with this info?
break;
case 'BUNDLE_START':
this._start = Date.now();
break;
case 'BUNDLE_END':
cb(null, new RollupResult(Date.now() - this._start, this));
break;
default:
console.log(`Unexpected event ${event.code}`);
}
});
}
}

View File

@@ -0,0 +1,111 @@
import * as path from 'path';
import colors from 'kleur';
import pb from 'pretty-bytes';
import RollupCompiler from './RollupCompiler';
import extract_css from './extract_css';
import { left_pad } from '../../utils';
import { CompileResult, BuildInfo, CompileError, Chunk, CssFile } from './interfaces';
import { ManifestData, Dirs, PageComponent } from '../../interfaces';
export default class RollupResult implements CompileResult {
duration: number;
errors: CompileError[];
warnings: CompileError[];
chunks: Chunk[];
assets: Record<string, string>;
css_files: CssFile[];
css: {
main: string,
chunks: Record<string, string[]>
};
summary: string;
constructor(duration: number, compiler: RollupCompiler) {
this.duration = duration;
this.errors = compiler.errors.map(munge_warning_or_error);
this.warnings = compiler.warnings.map(munge_warning_or_error); // TODO emit this as they happen
this.chunks = compiler.chunks.map(chunk => ({
file: chunk.fileName,
imports: chunk.imports.filter(Boolean),
modules: Object.keys(chunk.modules)
}));
this.css_files = compiler.css_files;
// TODO populate this properly. We don't have named chunks, as in
// webpack, but we can have a route -> [chunk] map or something
this.assets = {};
compiler.chunks.forEach(chunk => {
if (compiler.input in chunk.modules) {
this.assets.main = chunk.fileName;
}
});
this.summary = compiler.chunks.map(chunk => {
const size_color = chunk.code.length > 150000 ? colors.bold.red : chunk.code.length > 50000 ? colors.bold.yellow : colors.bold.white;
const size_label = left_pad(pb(chunk.code.length), 10);
const lines = [size_color(`${size_label} ${chunk.fileName}`)];
const deps = Object.keys(chunk.modules)
.map(file => {
return {
file: path.relative(process.cwd(), file),
size: chunk.modules[file].renderedLength
};
})
.filter(dep => dep.size > 0)
.sort((a, b) => b.size - a.size);
const total_unminified = deps.reduce((t, d) => t + d.size, 0);
deps.forEach((dep, i) => {
const c = i === deps.length - 1 ? '└' : '│';
let line = ` ${c} ${dep.file}`;
if (deps.length > 1) {
const p = (100 * dep.size / total_unminified).toFixed(1);
line += ` (${p}%)`;
}
lines.push(colors.gray(line));
});
return lines.join('\n');
}).join('\n');
}
to_json(manifest_data: ManifestData, dirs: Dirs): BuildInfo {
// TODO extract_css has side-effects that don't belong
// in a method called to_json
return {
bundler: 'rollup',
shimport: require('shimport/package.json').version,
assets: this.assets,
css: extract_css(this, manifest_data.components, dirs)
};
}
print() {
const blocks: string[] = this.warnings.map(warning => {
return warning.file
? `> ${colors.bold(warning.file)}\n${warning.message}`
: `> ${warning.message}`;
});
blocks.push(this.summary);
return blocks.join('\n\n');
}
}
function munge_warning_or_error(warning_or_error: any) {
return {
file: warning_or_error.filename,
message: [warning_or_error.message, warning_or_error.frame].filter(Boolean).join('\n')
};
}

View File

@@ -0,0 +1,47 @@
import * as path from 'path';
import relative from 'require-relative';
import { CompileResult } from './interfaces';
import WebpackResult from './WebpackResult';
let webpack: any;
export class WebpackCompiler {
_: any;
constructor(config: string) {
if (!webpack) webpack = relative('webpack', process.cwd());
this._ = webpack(require(path.resolve(config)));
}
oninvalid(cb: (filename: string) => void) {
this._.hooks.invalid.tap('sapper', cb);
}
compile(): Promise<CompileResult> {
return new Promise((fulfil, reject) => {
this._.run((err: Error, stats: any) => {
if (err) {
reject(err);
process.exit(1);
}
const result = new WebpackResult(stats);
if (result.errors.length) {
console.error(stats.toString({ colors: true }));
reject(new Error(`Encountered errors while building app`));
}
else {
fulfil(result);
}
});
});
}
watch(cb: (err?: Error, stats?: any) => void) {
this._.watch({}, (err?: Error, stats?: any) => {
cb(err, stats && new WebpackResult(stats));
});
}
}

View File

@@ -0,0 +1,73 @@
import format_messages from 'webpack-format-messages';
import { CompileResult, BuildInfo, CompileError, Chunk, CssFile } from './interfaces';
import { ManifestData, Dirs } from '../../interfaces';
const locPattern = /\((\d+):(\d+)\)$/;
function munge_warning_or_error(message: string) {
// TODO this is all a bit rube goldberg...
const lines = message.split('\n');
const file = lines.shift()
.replace('', '') // careful — there is a special character at the beginning of this string
.replace('', '')
.replace('./', '');
let line = null;
let column = null;
const match = locPattern.exec(lines[0]);
if (match) {
lines[0] = lines[0].replace(locPattern, '');
line = +match[1];
column = +match[2];
}
return {
file,
message: lines.join('\n')
};
}
export default class WebpackResult implements CompileResult {
duration: number;
errors: CompileError[];
warnings: CompileError[];
chunks: Chunk[];
assets: Record<string, string>;
css_files: CssFile[];
stats: any;
constructor(stats: any) {
this.stats = stats;
const info = stats.toJson();
const messages = format_messages(stats);
this.errors = messages.errors.map(munge_warning_or_error);
this.warnings = messages.warnings.map(munge_warning_or_error);
this.duration = info.time;
this.chunks = info.assets.map((chunk: { name: string }) => ({ file: chunk.name }));
this.assets = info.assetsByChunkName;
}
to_json(manifest_data: ManifestData, dirs: Dirs): BuildInfo {
return {
bundler: 'webpack',
shimport: null, // webpack has its own loader
assets: this.assets,
css: {
// TODO
main: null,
chunks: {}
}
};
}
print() {
return this.stats.toString({ colors: true });
}
}

View File

@@ -0,0 +1,230 @@
import * as fs from 'fs';
import * as path from 'path';
import hash from 'string-hash';
import * as codec from 'sourcemap-codec';
import { PageComponent, Dirs } from '../../interfaces';
import { CompileResult } from './interfaces';
const inline_sourcemap_header = 'data:application/json;charset=utf-8;base64,';
function extract_sourcemap(raw: string, id: string) {
let raw_map: string;
let map = null;
const code = raw.replace(/\/\*#\s+sourceMappingURL=(.+)\s+\*\//g, (m, url) => {
if (raw_map) {
// TODO should not happen!
throw new Error(`Found multiple sourcemaps in single CSS file (${id})`);
}
raw_map = url;
return '';
}).trim();
if (raw_map) {
if (raw_map.startsWith(inline_sourcemap_header)) {
const json = Buffer.from(raw_map.slice(inline_sourcemap_header.length), 'base64').toString();
map = JSON.parse(json);
} else {
// TODO do we want to handle non-inline sourcemaps? could be a rabbit hole
}
}
return {
code,
map
};
}
type SourceMap = {
version: 3;
file: string;
sources: string[];
sourcesContent: string[];
names: string[];
mappings: string;
};
export default function extract_css(client_result: CompileResult, components: PageComponent[], dirs: Dirs) {
const result: {
main: string | null;
chunks: Record<string, string[]>
} = {
main: null,
chunks: {}
};
if (!client_result.css_files) return; // Rollup-only for now
const unaccounted_for = new Set();
const css_map = new Map();
client_result.css_files.forEach(css => {
unaccounted_for.add(css.id);
css_map.set(css.id, css.code);
});
const chunk_map = new Map();
client_result.chunks.forEach(chunk => {
chunk_map.set(chunk.file, chunk);
});
const chunks_with_css = new Set();
// figure out which chunks belong to which components...
const component_owners = new Map();
client_result.chunks.forEach(chunk => {
chunk.modules.forEach(module => {
const component = path.relative(dirs.routes, module);
component_owners.set(component, chunk);
});
});
const chunks_depended_upon_by_component = new Map();
// ...so we can figure out which chunks don't belong
components.forEach(component => {
const chunk = component_owners.get(component.file);
if (!chunk) {
// this should never happen!
throw new Error(`Could not find chunk that owns ${component.file}`);
}
const chunks = new Set([chunk]);
chunks.forEach(chunk => {
chunk.imports.forEach((file: string) => {
const chunk = chunk_map.get(file);
if (chunk) chunks.add(chunk);
});
});
chunks.forEach(chunk => {
chunk.modules.forEach((module: string) => {
unaccounted_for.delete(module);
});
});
chunks_depended_upon_by_component.set(
component,
chunks
);
});
function get_css_from_modules(modules: string[]) {
const parts: string[] = [];
const mappings: number[][][] = [];
const combined_map: SourceMap = {
version: 3,
file: null,
sources: [],
sourcesContent: [],
names: [],
mappings: null
};
modules.forEach(module => {
if (!/\.css$/.test(module)) return;
const css = css_map.get(module);
const { code, map } = extract_sourcemap(css, module);
parts.push(code);
if (map) {
const lines = codec.decode(map.mappings);
if (combined_map.sources.length > 0 || combined_map.names.length > 0) {
lines.forEach(line => {
line.forEach(segment => {
// adjust source index
segment[1] += combined_map.sources.length;
// adjust name index
if (segment[4]) segment[4] += combined_map.names.length;
});
});
}
combined_map.sources.push(...map.sources);
combined_map.sourcesContent.push(...map.sourcesContent);
combined_map.names.push(...map.names);
mappings.push(...lines);
}
});
if (parts.length > 0) {
combined_map.mappings = codec.encode(mappings);
combined_map.sources = combined_map.sources.map(source => path.relative(`${dirs.dest}/client`, source));
return {
code: parts.join('\n'),
map: combined_map
};
}
return null;
}
const main = client_result.assets.main;
const entry = fs.readFileSync(`${dirs.dest}/client/${main}`, 'utf-8');
const replacements = new Map();
chunks_depended_upon_by_component.forEach((chunks, component) => {
const chunks_with_css = Array.from(chunks).filter(chunk => {
const css = get_css_from_modules(chunk.modules);
if (css) {
const { code, map } = css;
const output_file_name = chunk.file.replace(/\.js$/, '.css');
map.file = output_file_name;
map.sources = map.sources.map(source => path.relative(`${dirs.dest}/client`, source));
fs.writeFileSync(`${dirs.dest}/client/${output_file_name}`, `${code}\n/* sourceMappingURL=client/${output_file_name}.map */`);
fs.writeFileSync(`${dirs.dest}/client/${output_file_name}.map`, JSON.stringify(map, null, ' '));
return true;
}
});
const files = chunks_with_css.map(chunk => chunk.file.replace(/\.js$/, '.css'));
replacements.set(
component.file,
files
);
result.chunks[component.file] = files;
});
const replaced = entry.replace(/["']__SAPPER_CSS_PLACEHOLDER:(.+?)__["']/g, (m, route) => {
return JSON.stringify(replacements.get(route));
});
fs.writeFileSync(`${dirs.dest}/client/${main}`, replaced);
const leftover = get_css_from_modules(Array.from(unaccounted_for));
if (leftover) {
const { code, map } = leftover;
const main_hash = hash(code);
const output_file_name = `main.${main_hash}.css`;
map.file = output_file_name;
map.sources = map.sources.map(source => path.relative(`${dirs.dest}/client`, source));
fs.writeFileSync(`${dirs.dest}/client/${output_file_name}`, `${code}\n/* sourceMappingURL=client/${output_file_name}.map */`);
fs.writeFileSync(`${dirs.dest}/client/${output_file_name}.map`, JSON.stringify(map, null, ' '));
result.main = output_file_name;
}
return result;
}

View File

@@ -0,0 +1,37 @@
import * as fs from 'fs';
import { Dirs } from '../../interfaces';
import RollupCompiler from './RollupCompiler';
import { WebpackCompiler } from './WebpackCompiler';
export type Compiler = RollupCompiler | WebpackCompiler;
export type Compilers = {
client: Compiler;
server: Compiler;
serviceworker?: Compiler;
}
export default function create_compilers(bundler: string, dirs: Dirs): Compilers {
if (bundler === 'rollup') {
const sw = `${dirs.rollup}/service-worker.config.js`;
return {
client: new RollupCompiler(`${dirs.rollup}/client.config.js`),
server: new RollupCompiler(`${dirs.rollup}/server.config.js`),
serviceworker: fs.existsSync(sw) && new RollupCompiler(sw)
};
}
if (bundler === 'webpack') {
const sw = `${dirs.webpack}/service-worker.config.js`;
return {
client: new WebpackCompiler(`${dirs.webpack}/client.config.js`),
server: new WebpackCompiler(`${dirs.webpack}/server.config.js`),
serviceworker: fs.existsSync(sw) && new WebpackCompiler(sw)
};
}
// this shouldn't be possible...
throw new Error(`Invalid bundler option '${bundler}'`);
}

View File

@@ -0,0 +1,39 @@
import { ManifestData, Dirs } from '../../interfaces';
export type Chunk = {
file: string;
imports: string[];
modules: string[];
}
export type CssFile = {
id: string;
code: string;
};
export class CompileError {
file: string;
message: string;
}
export interface CompileResult {
duration: number;
errors: CompileError[];
warnings: CompileError[];
chunks: Chunk[];
assets: Record<string, string>;
css_files: CssFile[];
to_json: (manifest_data: ManifestData, dirs: Dirs) => BuildInfo
}
export type BuildInfo = {
bundler: string;
shimport: string;
assets: Record<string, string>;
legacy_assets?: Record<string, string>;
css: {
main: string | null,
chunks: Record<string, string[]>
}
}

View File

@@ -0,0 +1,302 @@
import * as fs from 'fs';
import * as path from 'path';
import { locations } from '../config';
import { Page, PageComponent, ServerRoute, ManifestData } from '../interfaces';
import { posixify, reserved_words } from './utils';
export default function create_manifest_data(cwd = locations.routes()): ManifestData {
const components: PageComponent[] = [];
const pages: Page[] = [];
const server_routes: ServerRoute[] = [];
const default_layout: PageComponent = {
default: true,
name: '_default_layout',
file: null
};
function walk(
dir: string,
parent_segments: Part[][],
parent_params: string[],
stack: Array<{
component: PageComponent,
params: string[]
}>
) {
const items = fs.readdirSync(dir)
.map(basename => {
const resolved = path.join(dir, basename);
const file = path.relative(cwd, resolved);
const is_dir = fs.statSync(resolved).isDirectory();
const ext = path.extname(basename);
if (!is_dir && !/^\.[a-z]+$/i.test(ext)) return null; // filter out tmp files etc
const segment = is_dir
? basename
: basename.slice(0, -path.extname(basename).length);
const parts = get_parts(segment);
const is_index = is_dir ? false : basename.startsWith('index.');
const is_page = ext === '.html';
parts.forEach(part => {
if (/\]\[/.test(part.content)) {
throw new Error(`Invalid route ${file} — parameters must be separated`);
}
if (part.qualifier && /[\(\)\?\:]/.test(part.qualifier.slice(1, -1))) {
throw new Error(`Invalid route ${file} — cannot use (, ), ? or : in route qualifiers`);
}
});
return {
basename,
parts,
file: posixify(file),
is_dir,
is_index,
is_page
};
})
.filter(Boolean)
.sort(comparator);
items.forEach(item => {
if (item.basename[0] === '_') return;
if (item.basename[0] === '.') {
if (item.file !== '.well-known') return;
}
const segments = parent_segments.slice();
if (item.is_index && segments.length > 0) {
const last_segment = segments[segments.length - 1].slice();
const suffix = item.basename
.slice(0, -path.extname(item.basename).length).
replace('index', '');
if (suffix) {
const last_part = last_segment[last_segment.length - 1];
if (last_part.dynamic) {
last_segment.push({ dynamic: false, content: suffix });
} else {
last_segment[last_segment.length - 1] = {
dynamic: false,
content: `${last_part.content}${suffix}`
};
}
segments[segments.length - 1] = last_segment;
}
} else {
segments.push(item.parts);
}
const params = parent_params.slice();
params.push(...item.parts.filter(p => p.dynamic).map(p => p.content));
if (item.is_dir) {
const index = path.join(dir, item.basename, '_layout.html');
const component = fs.existsSync(index) && {
name: `${get_slug(item.file)}__layout`,
file: `${item.file}/_layout.html`
};
if (component) components.push(component);
walk(
path.join(dir, item.basename),
segments,
params,
component
? stack.concat({ component, params })
: stack.concat(null)
);
}
else if (item.is_page) {
const component = {
name: get_slug(item.file),
file: item.file
};
const parts = stack.concat({
component,
params
});
components.push(component);
if (item.basename === 'index.html') {
pages.push({
pattern: get_pattern(parent_segments, true),
parts
});
} else {
pages.push({
pattern: get_pattern(segments, true),
parts
});
}
}
else {
server_routes.push({
name: `route_${get_slug(item.file)}`,
pattern: get_pattern(segments, false),
file: item.file,
params: params
});
}
});
}
const root_file = path.join(cwd, '_layout.html');
const root = fs.existsSync(root_file)
? {
name: 'main',
file: '_layout.html'
}
: default_layout;
walk(cwd, [], [], []);
// check for clashes
const seen_pages: Map<string, Page> = new Map();
pages.forEach(page => {
const pattern = page.pattern.toString();
if (seen_pages.has(pattern)) {
const file = page.parts.pop().component.file;
const other_page = seen_pages.get(pattern);
const other_file = other_page.parts.pop().component.file;
throw new Error(`The ${other_file} and ${file} pages clash`);
}
seen_pages.set(pattern, page);
});
const seen_routes: Map<string, ServerRoute> = new Map();
server_routes.forEach(route => {
const pattern = route.pattern.toString();
if (seen_routes.has(pattern)) {
const other_route = seen_routes.get(pattern);
throw new Error(`The ${other_route.file} and ${route.file} routes clash`);
}
seen_routes.set(pattern, route);
});
return {
root,
components,
pages,
server_routes
};
}
type Part = {
content: string;
dynamic: boolean;
qualifier?: string;
};
function comparator(
a: { basename: string, parts: Part[], file: string, is_index: boolean },
b: { basename: string, parts: Part[], file: string, is_index: boolean }
) {
if (a.is_index !== b.is_index) return a.is_index ? -1 : 1;
const max = Math.max(a.parts.length, b.parts.length);
for (let i = 0; i < max; i += 1) {
const a_sub_part = a.parts[i];
const b_sub_part = b.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;
}
}
}
}
function get_parts(part: string): Part[] {
return part.split(/\[(.+)\]/)
.map((str, i) => {
if (!str) return null;
const dynamic = i % 2 === 1;
const [, content, qualifier] = dynamic
? /([^(]+)(\(.+\))?$/.exec(str)
: [, str, null];
return {
content,
dynamic,
qualifier
};
})
.filter(Boolean);
}
function get_slug(file: string) {
let name = file
.replace(/[\\\/]index/, '')
.replace(/_default([\/\\index])?\.html$/, 'index')
.replace(/[\/\\]/g, '_')
.replace(/\.\w+$/, '')
.replace(/\[([^(]+)(?:\([^(]+\))?\]/, '$$$1')
.replace(/[^a-zA-Z0-9_$]/g, c => {
return c === '.' ? '_' : `$${c.charCodeAt(0)}`
});
if (reserved_words.has(name)) name += '_';
return name;
}
function get_pattern(segments: Part[][], add_trailing_slash: boolean) {
return new RegExp(
`^` +
segments.map(segment => {
return '\\/' + segment.map(part => {
return part.dynamic
? part.qualifier || '([^\\/]+?)'
: encodeURI(part.content.normalize())
.replace(/\?/g, '%3F')
.replace(/#/g, '%23')
.replace(/%5B/g, '[')
.replace(/%5D/g, ']');
}).join('');
}).join('') +
(add_trailing_slash ? '\\\/?$' : '$')
);
}

View File

@@ -1,28 +1,36 @@
import * as fs from 'fs'; import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as glob from 'glob'; import glob from 'tiny-glob/sync.js';
import { posixify, write_if_changed } from './utils'; import { posixify, write_if_changed } from './utils';
import { dev, locations } from '../config'; import { dev, locations } from '../config';
import { Route } from '../interfaces'; import { Page, PageComponent, ServerRoute, ManifestData } from '../interfaces';
export function create_main_manifests({ routes, dev_port }: { export function create_main_manifests({ bundler, manifest_data, dev_port }: {
routes: Route[]; bundler: string,
manifest_data: ManifestData;
dev_port?: number; dev_port?: number;
}) { }) {
const path_to_routes = path.relative(`${locations.app()}/manifest`, locations.routes()); const manifest_dir = path.join(locations.app(), 'manifest');
if (!fs.existsSync(manifest_dir)) fs.mkdirSync(manifest_dir);
const client_manifest = generate_client(routes, path_to_routes, dev_port); const path_to_routes = path.relative(manifest_dir, locations.routes());
const server_manifest = generate_server(routes, path_to_routes);
write_if_changed(`${locations.app()}/manifest/client.js`, client_manifest); const client_manifest = generate_client(manifest_data, path_to_routes, bundler, dev_port);
write_if_changed(`${locations.app()}/manifest/server.js`, server_manifest); const server_manifest = generate_server(manifest_data, path_to_routes);
write_if_changed(
`${manifest_dir}/default-layout.html`,
`<svelte:component this={child.component} {...child.props}/>`
);
write_if_changed(`${manifest_dir}/client.js`, client_manifest);
write_if_changed(`${manifest_dir}/server.js`, server_manifest);
} }
export function create_serviceworker_manifest({ routes, client_files }: { export function create_serviceworker_manifest({ manifest_data, client_files }: {
routes: Route[]; manifest_data: ManifestData;
client_files: string[]; client_files: string[];
}) { }) {
const assets = glob.sync('**', { cwd: 'assets', nodir: true }); const assets = glob('**', { cwd: 'assets', filesOnly: true });
let code = ` let code = `
// This file is generated by Sapper — do not edit it! // This file is generated by Sapper — do not edit it!
@@ -32,38 +40,71 @@ export function create_serviceworker_manifest({ routes, client_files }: {
export const shell = [\n\t${client_files.map((x: string) => `"${x}"`).join(',\n\t')}\n]; export const shell = [\n\t${client_files.map((x: string) => `"${x}"`).join(',\n\t')}\n];
export const routes = [\n\t${routes.filter((r: Route) => r.type === 'page' && !/^_[45]xx$/.test(r.id)).map((r: Route) => `{ pattern: ${r.pattern} }`).join(',\n\t')}\n]; export const routes = [\n\t${manifest_data.pages.map((r: Page) => `{ pattern: ${r.pattern} }`).join(',\n\t')}\n];
`.replace(/^\t\t/gm, '').trim(); `.replace(/^\t\t/gm, '').trim();
write_if_changed(`${locations.app()}/manifest/service-worker.js`, code); write_if_changed(`${locations.app()}/manifest/service-worker.js`, code);
} }
function generate_client(routes: Route[], path_to_routes: string, dev_port?: number) { function generate_client(
manifest_data: ManifestData,
path_to_routes: string,
bundler: string,
dev_port?: number
) {
const page_ids = new Set(manifest_data.pages.map(page =>
page.pattern.toString()));
const server_routes_to_ignore = manifest_data.server_routes.filter(route =>
!page_ids.has(route.pattern.toString()));
let code = ` let code = `
// This file is generated by Sapper — do not edit it! // This file is generated by Sapper — do not edit it!
export const routes = [ import root from '${get_file(path_to_routes, manifest_data.root)}';
${routes import error from '${posixify(`${path_to_routes}/_error.html`)}';
.map(route => {
const page = route.handlers.find(({ type }) => type === 'page');
if (!page) { ${manifest_data.components.map(component => {
return `{ pattern: ${route.pattern}, ignore: true }`; const annotation = bundler === 'webpack'
} ? `/* webpackChunkName: "${component.name}" */ `
: '';
const file = posixify(`${path_to_routes}/${page.file}`); const source = get_file(path_to_routes, component);
if (route.id === '_error') { return `const ${component.name} = {
return `{ error: true, load: () => import(/* webpackChunkName: "${route.id}" */ '${file}') }`; js: () => import(${annotation}'${source}'),
} css: "__SAPPER_CSS_PLACEHOLDER:${component.file}__"
};`;
}).join('\n')}
const params = route.params.length === 0 export const manifest = {
? '{}' ignore: [${server_routes_to_ignore.map(route => route.pattern).join(', ')}],
: `{ ${route.params.map((part, i) => `${part}: match[${i + 1}]`).join(', ')} }`;
return `{ pattern: ${route.pattern}, params: ${route.params.length > 0 ? `match` : `()`} => (${params}), load: () => import(/* webpackChunkName: "${route.id}" */ '${file}') }`; pages: [
}) ${manifest_data.pages.map(page => `{
.join(',\n\t')} // ${page.parts[page.parts.length - 1].component.file}
];`.replace(/^\t\t/gm, '').trim(); pattern: ${page.pattern},
parts: [
${page.parts.map(part => {
if (part === null) return 'null';
if (part.params.length > 0) {
const props = part.params.map((param, i) => `${param}: match[${i + 1}]`);
return `{ component: ${part.component.name}, params: match => ({ ${props.join(', ')} }) }`;
}
return `{ component: ${part.component.name} }`;
}).join(',\n\t\t\t\t\t\t')}
]
}`).join(',\n\n\t\t\t\t')}
],
root,
error
};
// this is included for legacy reasons
export const routes = {};`.replace(/^\t\t/gm, '').trim();
if (dev()) { if (dev()) {
const sapper_dev_client = posixify( const sapper_dev_client = posixify(
@@ -72,54 +113,83 @@ function generate_client(routes: Route[], path_to_routes: string, dev_port?: num
code += ` code += `
if (module.hot) { import('${sapper_dev_client}').then(client => {
import('${sapper_dev_client}').then(client => { client.connect(${dev_port});
client.connect(${dev_port}); });`.replace(/^\t{3}/gm, '');
});
}`.replace(/^\t{3}/gm, '');
} }
return code; return code;
} }
function generate_server(routes: Route[], path_to_routes: string) { function generate_server(
manifest_data: ManifestData,
path_to_routes: string
) {
const imports = [].concat(
manifest_data.server_routes.map(route =>
`import * as ${route.name} from '${posixify(`${path_to_routes}/${route.file}`)}';`),
manifest_data.components.map(component =>
`import ${component.name} from '${get_file(path_to_routes, component)}';`),
`import root from '${get_file(path_to_routes, manifest_data.root)}';`,
`import error from '${posixify(`${path_to_routes}/_error.html`)}';`
);
let code = ` let code = `
// This file is generated by Sapper — do not edit it! // This file is generated by Sapper — do not edit it!
${routes ${imports.join('\n')}
.map(route =>
route.handlers
.map(({ type, file }, index) => {
const module = posixify(`${path_to_routes}/${file}`);
return type === 'page' export const manifest = {
? `import ${route.id}${index} from '${module}';` server_routes: [
: `import * as ${route.id}${index} from '${module}';`; ${manifest_data.server_routes.map(route => `{
}) // ${route.file}
.join('\n') pattern: ${route.pattern},
) handlers: ${route.name},
.join('\n')} params: ${route.params.length > 0
? `match => ({ ${route.params.map((param, i) => `${param}: match[${i + 1}]`).join(', ')} })`
: `() => ({})`}
}`).join(',\n\n\t\t\t\t')}
],
export const routes = [ pages: [
${routes ${manifest_data.pages.map(page => `{
.map(route => { // ${page.parts[page.parts.length - 1].component.file}
const handlers = route.handlers pattern: ${page.pattern},
.map(({ type }, index) => parts: [
`{ type: '${type}', module: ${route.id}${index} }`) ${page.parts.map(part => {
.join(', '); if (part === null) return 'null';
if (route.id === '_error') { const props = [
return `{ error: true, handlers: [${handlers}] }`; `name: "${part.component.name}"`,
} `file: "${part.component.file}"`,
`component: ${part.component.name}`
];
const params = route.params.length === 0 if (part.params.length > 0) {
? '{}' const params = part.params.map((param, i) => `${param}: match[${i + 1}]`);
: `{ ${route.params.map((part, i) => `${part}: match[${i + 1}]`).join(', ')} }`; props.push(`params: match => ({ ${params.join(', ')} })`);
}
return `{ id: '${route.id}', pattern: ${route.pattern}, params: ${route.params.length > 0 ? `match` : `()`} => (${params}), handlers: [${handlers}] }`; return `{ ${props.join(', ')} }`;
}) }).join(',\n\t\t\t\t\t\t')}
.join(',\n\t') ]
} }`).join(',\n\n\t\t\t\t')}
];`.replace(/^\t\t/gm, '').trim(); ],
root,
error
};
// this is included for legacy reasons
export const routes = {};`.replace(/^\t\t/gm, '').trim();
return code; return code;
}
function get_file(path_to_routes: string, component: PageComponent) {
if (component.default) {
return `./default-layout.html`;
}
return posixify(`${path_to_routes}/${component.file}`);
} }

View File

@@ -1,190 +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 routes: Route[] = 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);
}
return {
files: [file],
base,
parts
};
})
.filter(Boolean)
.filter((a, index, array) => {
const found = array.slice(index + 1).find(b => a.base === b.base);
if (found) found.files.push(...a.files);
return !found;
})
.sort((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`);
})
.map(({ files, base, parts }) => {
const id = (
parts.join('_').replace(/[[\]]/g, '$').replace(/^\d/, '_$&').replace(/[^a-zA-Z0-9_$]/g, '_')
) || '_';
const params: string[] = [];
const match_patterns: object = {};
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 ? `(?:\\/${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,
handlers: files.map(file => ({
type: path.extname(file) === '.html' ? 'page' : 'route',
file
})).sort((a, b) => {
if (a.type === 'page' && b.type === 'route') {
return 1;
}
if (a.type === 'route' && b.type === 'page') {
return -1;
}
return 0;
}),
pattern,
test,
exec,
parts,
params
};
});
return routes;
}
function get_sub_parts(part: string) {
return part.split(/\[(.+)\]/)
.map((content, i) => {
if (!content) return null;
return {
content,
dynamic: i % 2 === 1
};
})
.filter(Boolean);
}

View File

@@ -1,11 +1,11 @@
import * as sander from 'sander'; import * as fs from 'fs';
const previous_contents = new Map(); const previous_contents = new Map();
export function write_if_changed(file: string, code: string) { export function write_if_changed(file: string, code: string) {
if (code !== previous_contents.get(file)) { if (code !== previous_contents.get(file)) {
previous_contents.set(file, code); previous_contents.set(file, code);
sander.writeFileSync(file, code); fs.writeFileSync(file, code);
fudge_mtime(file); fudge_mtime(file);
} }
} }
@@ -16,10 +16,61 @@ export function posixify(file: string) {
export function fudge_mtime(file: string) { export function fudge_mtime(file: string) {
// need to fudge the mtime so that webpack doesn't go doolally // need to fudge the mtime so that webpack doesn't go doolally
const { atime, mtime } = sander.statSync(file); const { atime, mtime } = fs.statSync(file);
sander.utimesSync( fs.utimesSync(
file, file,
new Date(atime.getTime() - 999999), new Date(atime.getTime() - 999999),
new Date(mtime.getTime() - 999999) new Date(mtime.getTime() - 999999)
); );
} }
export const reserved_words = new Set([
'arguments',
'await',
'break',
'case',
'catch',
'class',
'const',
'continue',
'debugger',
'default',
'delete',
'do',
'else',
'enum',
'eval',
'export',
'extends',
'false',
'finally',
'for',
'function',
'if',
'implements',
'import',
'in',
'instanceof',
'interface',
'let',
'new',
'null',
'package',
'private',
'protected',
'public',
'return',
'static',
'super',
'switch',
'this',
'throw',
'true',
'try',
'typeof',
'var',
'void',
'while',
'with',
'yield',
]);

View File

@@ -18,4 +18,40 @@ export type Template = {
export type Store = { export type Store = {
get: () => any; get: () => any;
};
export type PageComponent = {
default?: boolean;
name: string;
file: string;
};
export type Page = {
pattern: RegExp;
parts: Array<{
component: PageComponent;
params: string[];
}>
};
export type ServerRoute = {
name: string;
pattern: RegExp;
file: string;
params: string[];
};
export type Dirs = {
dest: string,
app: string,
routes: string,
webpack: string,
rollup: string
};
export type ManifestData = {
root: PageComponent;
components: PageComponent[];
pages: Page[];
server_routes: ServerRoute[];
}; };

View File

@@ -11,13 +11,26 @@ import sourceMapSupport from 'source-map-support';
sourceMapSupport.install(); sourceMapSupport.install();
type RouteObject = { type ServerRoute = {
id: string;
type: 'page' | 'route';
pattern: RegExp; pattern: RegExp;
handlers: Record<string, Handler>;
params: (match: RegExpMatchArray) => Record<string, string>; params: (match: RegExpMatchArray) => Record<string, string>;
module: Component; };
error?: string;
type Page = {
pattern: RegExp;
parts: Array<{
name: string;
component: Component;
params?: (match: RegExpMatchArray) => Record<string, string>;
}>
};
type Manifest = {
server_routes: ServerRoute[];
pages: Page[];
root: Component;
error: Component;
} }
type Handler = (req: Req, res: ServerResponse, next: () => void) => void; type Handler = (req: Req, res: ServerResponse, next: () => void) => void;
@@ -26,6 +39,20 @@ type Store = {
get: () => any get: () => any
}; };
type Props = {
path: string;
query: Record<string, string>;
params: Record<string, string>;
error?: { message: string };
status?: number;
child: {
segment: string;
component: Component;
props: Props;
};
[key: string]: any;
};
interface Req extends ClientRequest { interface Req extends ClientRequest {
url: string; url: string;
baseUrl: string; baseUrl: string;
@@ -33,6 +60,7 @@ interface Req extends ClientRequest {
method: string; method: string;
path: string; path: string;
params: Record<string, string>; params: Record<string, string>;
query: Record<string, string>;
headers: Record<string, string>; headers: Record<string, string>;
} }
@@ -45,21 +73,39 @@ interface Component {
preload: (data: any) => any | Promise<any> preload: (data: any) => any | Promise<any>
} }
export default function middleware({ App, routes, store }: { const IGNORE = '__SAPPER__IGNORE__';
App: Component, function toIgnore(uri: string, val: any) {
routes: RouteObject[], if (Array.isArray(val)) return val.some(x => toIgnore(uri, x));
store: (req: Req) => Store if (val instanceof RegExp) return val.test(uri);
if (typeof val === 'function') return val(uri);
return uri.startsWith(val.charCodeAt(0) === 47 ? val : `/${val}`);
}
export default function middleware(opts: {
manifest: Manifest,
store: (req: Req, res: ServerResponse) => Store,
ignore?: any,
routes?: any // legacy
}) { }) {
if (!App) { if (opts.routes) {
throw new Error(`As of 0.12, you must supply an App component to Sapper — see https://sapper.svelte.technology/guide#0-11-to-0-12 for more information`); throw new Error(`As of Sapper 0.15, opts.routes should be opts.manifest`);
} }
const output = locations.dest(); const output = locations.dest();
const { manifest, store, ignore } = opts;
let emitted_basepath = false; let emitted_basepath = false;
const middleware = compose_handlers([ const middleware = compose_handlers([
ignore && ((req: Req, res: ServerResponse, next: () => void) => {
req[IGNORE] = toIgnore(req.path, ignore);
next();
}),
(req: Req, res: ServerResponse, next: () => void) => { (req: Req, res: ServerResponse, next: () => void) => {
if (req[IGNORE]) return next();
if (req.baseUrl === undefined) { if (req.baseUrl === undefined) {
let { originalUrl } = req; let { originalUrl } = req;
if (req.url === '/' && originalUrl[originalUrl.length - 1] !== '/') { if (req.url === '/' && originalUrl[originalUrl.length - 1] !== '/') {
@@ -105,10 +151,11 @@ export default function middleware({ App, routes, store }: {
serve({ serve({
prefix: '/client/', prefix: '/client/',
cache_control: 'max-age=31536000' cache_control: dev() ? 'no-cache' : 'max-age=31536000'
}), }),
get_route_handler(App, routes, store) get_server_route_handler(manifest.server_routes),
get_page_handler(manifest, store)
].filter(Boolean)); ].filter(Boolean));
return middleware; return middleware;
@@ -132,11 +179,14 @@ function serve({ prefix, pathname, cache_control }: {
: (file: string) => (cache.has(file) ? cache : cache.set(file, fs.readFileSync(path.resolve(output, file)))).get(file) : (file: string) => (cache.has(file) ? cache : cache.set(file, fs.readFileSync(path.resolve(output, file)))).get(file)
return (req: Req, res: ServerResponse, next: () => void) => { return (req: Req, res: ServerResponse, next: () => void) => {
if (req[IGNORE]) return next();
if (filter(req)) { if (filter(req)) {
const type = lookup(req.path); const type = lookup(req.path);
try { try {
const data = read(req.path.slice(1)); const file = decodeURIComponent(req.path.slice(1));
const data = read(file);
res.setHeader('Content-Type', type); res.setHeader('Content-Type', type);
res.setHeader('Cache-Control', cache_control); res.setHeader('Cache-Control', cache_control);
@@ -151,261 +201,362 @@ function serve({ prefix, pathname, cache_control }: {
}; };
} }
function get_route_handler(App: Component, routes: RouteObject[], store_getter: (req: Req) => Store) { function get_server_route_handler(routes: ServerRoute[]) {
function handle_route(route: ServerRoute, req: Req, res: ServerResponse, next: () => void) {
req.params = route.params(route.pattern.exec(req.path));
const method = req.method.toLowerCase();
// 'delete' cannot be exported from a module because it is a keyword,
// so check for 'del' instead
const method_export = method === 'delete' ? 'del' : method;
const handle_method = route.handlers[method_export];
if (handle_method) {
if (process.env.SAPPER_EXPORT) {
const { write, end, setHeader } = res;
const chunks: any[] = [];
const headers: Record<string, string> = {};
// intercept data so that it can be exported
res.write = function(chunk: any) {
chunks.push(Buffer.from(chunk));
write.apply(res, arguments);
};
res.setHeader = function(name: string, value: string) {
headers[name.toLowerCase()] = value;
setHeader.apply(res, arguments);
};
res.end = function(chunk?: any) {
if (chunk) chunks.push(Buffer.from(chunk));
end.apply(res, arguments);
process.send({
__sapper__: true,
event: 'file',
url: req.url,
method: req.method,
status: res.statusCode,
type: headers['content-type'],
body: Buffer.concat(chunks).toString()
});
};
}
const handle_next = (err?: Error) => {
if (err) {
res.statusCode = 500;
res.end(err.message);
} else {
process.nextTick(next);
}
};
try {
handle_method(req, res, handle_next);
} catch (err) {
handle_next(err);
}
} else {
// no matching handler for method
process.nextTick(next);
}
}
return function find_route(req: Req, res: ServerResponse, next: () => void) {
if (req[IGNORE]) return next();
for (const route of routes) {
if (route.pattern.test(req.path)) {
handle_route(route, req, res, next);
return;
}
}
next();
};
}
function get_page_handler(
manifest: Manifest,
store_getter: (req: Req, res: ServerResponse) => Store
) {
const output = locations.dest(); const output = locations.dest();
const get_chunks = dev() const get_build_info = dev()
? () => JSON.parse(fs.readFileSync(path.join(output, 'client_assets.json'), 'utf-8')) ? () => JSON.parse(fs.readFileSync(path.join(output, 'build.json'), 'utf-8'))
: (assets => () => assets)(JSON.parse(fs.readFileSync(path.join(output, 'client_assets.json'), 'utf-8'))); : (assets => () => assets)(JSON.parse(fs.readFileSync(path.join(output, 'build.json'), 'utf-8')));
const template = dev() const template = dev()
? () => fs.readFileSync(`${locations.app()}/template.html`, 'utf-8') ? () => fs.readFileSync(`${locations.app()}/template.html`, 'utf-8')
: (str => () => str)(fs.readFileSync(`${locations.dest()}/template.html`, 'utf-8')); : (str => () => str)(fs.readFileSync(`${locations.dest()}/template.html`, 'utf-8'));
const error_route = routes.find((route: RouteObject) => route.error); const { server_routes, pages } = manifest;
const error_route = manifest.error;
function handle_route(route: RouteObject, req: Req, res: ServerResponse, status = 200, error: Error | string = null) { function handle_error(req: Req, res: ServerResponse, statusCode: number, error: Error | string) {
req.params = error handle_page({
? {} pattern: null,
: route.params(route.pattern.exec(req.path)); parts: [
{ name: null, component: error_route }
]
}, req, res, statusCode, error || new Error('Unknown error in preload function'));
}
const handlers = route.handlers[Symbol.iterator](); function handle_page(page: Page, req: Req, res: ServerResponse, status = 200, error: Error | string = null) {
const build_info: {
bundler: 'rollup' | 'webpack',
shimport: string | null,
assets: Record<string, string | string[]>,
legacy_assets?: Record<string, string>
} = get_build_info();
function next() { res.setHeader('Content-Type', 'text/html');
const chunks: Record<string, string> = get_chunks();
try { // preload main.js and current route
const { value: handler, done } = handlers.next(); // TODO detect other stuff we can preload? images, CSS, fonts?
let preloaded_chunks = Array.isArray(build_info.assets.main) ? build_info.assets.main : [build_info.assets.main];
if (!error) {
page.parts.forEach(part => {
if (!part) return;
if (done) { // using concat because it could be a string or an array. thanks webpack!
if (route.error) { preloaded_chunks = preloaded_chunks.concat(build_info.assets[part.name]);
// there was an error rendering the error page! });
res.statusCode = status; }
res.end(error instanceof Error ? error.message : error);
} else {
handle_route(error_route, req, res, 404, 'Not found');
}
return; const link = preloaded_chunks
.filter(file => file && !file.match(/\.map$/))
.map(file => `<${req.baseUrl}/client/${file}>;rel="preload";as="script"`)
.join(', ');
res.setHeader('Link', link);
const store = store_getter ? store_getter(req, res) : null;
let redirect: { statusCode: number, location: string };
let preload_error: { statusCode: number, message: Error | string };
const preload_context = {
redirect: (statusCode: number, location: string) => {
if (redirect && (redirect.statusCode !== statusCode || redirect.location !== location)) {
throw new Error(`Conflicting redirects`);
} }
location = location.replace(/^\//g, ''); // leading slash (only)
redirect = { statusCode, location };
},
error: (statusCode: number, message: Error | string) => {
preload_error = { statusCode, message };
},
fetch: (url: string, opts?: any) => {
const parsed = new URL(url, `http://127.0.0.1:${process.env.PORT}${req.baseUrl ? req.baseUrl + '/' :''}`);
const mod = handler.module; if (opts) {
opts = Object.assign({}, opts);
if (handler.type === 'page') { const include_cookies = (
res.setHeader('Content-Type', 'text/html'); opts.credentials === 'include' ||
opts.credentials === 'same-origin' && parsed.origin === `http://127.0.0.1:${process.env.PORT}`
);
// preload main.js and current route if (include_cookies) {
// TODO detect other stuff we can preload? images, CSS, fonts? if (!opts.headers) opts.headers = {};
const link = []
.concat(chunks.main, chunks[route.id] || chunks._error) // TODO this is gross
.filter(file => !file.match(/\.map$/))
.map(file => `<${req.baseUrl}/client/${file}>;rel="preload";as="script"`)
.join(', ');
res.setHeader('Link', link); const str = []
.concat(
cookie.parse(req.headers.cookie || ''),
cookie.parse(opts.headers.cookie || ''),
cookie.parse(res.getHeader('Set-Cookie') || '')
)
.map(cookie => {
return Object.keys(cookie)
.map(name => `${name}=${encodeURIComponent(cookie[name])}`)
.join('; ');
})
.filter(Boolean)
.join(', ');
const store = store_getter ? store_getter(req) : null; opts.headers.cookie = str;
const props = { params: req.params, query: req.query, path: req.path };
if (route.error) {
props.error = error instanceof Error ? error : { message: error };
props.status = status;
}
let redirect: { statusCode: number, location: string };
let preload_error: { statusCode: number, message: Error | string };
Promise.resolve(
mod.preload ? mod.preload.call({
redirect: (statusCode: number, location: string) => {
redirect = { statusCode, location };
},
error: (statusCode: number, message: Error | string) => {
preload_error = { statusCode, message };
},
fetch: (url: string, opts?: any) => {
const parsed = new URL(url, `http://127.0.0.1:${process.env.PORT}${req.baseUrl ? req.baseUrl + '/' :''}`);
if (opts) {
opts = Object.assign({}, opts);
const include_cookies = (
opts.credentials === 'include' ||
opts.credentials === 'same-origin' && parsed.origin === `http://127.0.0.1:${process.env.PORT}`
);
if (include_cookies) {
const cookies: Record<string, string> = {};
if (!opts.headers) opts.headers = {};
const str = []
.concat(
cookie.parse(req.headers.cookie || ''),
cookie.parse(opts.headers.cookie || ''),
cookie.parse(res.getHeader('Set-Cookie') || '')
)
.map(cookie => {
return Object.keys(cookie)
.map(name => `${name}=${encodeURIComponent(cookie[name])}`)
.join('; ');
})
.filter(Boolean)
.join(', ');
opts.headers.cookie = str;
}
}
return fetch(parsed.href, opts);
},
store
}, req) : {}
).catch(err => {
preload_error = { statusCode: 500, message: err };
}).then(preloaded => {
if (redirect) {
res.statusCode = redirect.statusCode;
res.setHeader('Location', `${req.baseUrl}/${redirect.location}`);
res.end();
return;
}
if (preload_error) {
handle_route(error_route, req, res, preload_error.statusCode, preload_error.message);
return;
}
const serialized = {
preloaded: mod.preload && try_serialize(preloaded),
store: store && try_serialize(store.get())
};
Object.assign(props, preloaded);
const { html, head, css } = App.render({ Page: mod, props }, {
store
});
let scripts = []
.concat(chunks.main) // chunks main might be an array. it might not! thanks, webpack
.filter(file => !file.match(/\.map$/))
.map(file => `<script src='${req.baseUrl}/client/${file}'></script>`)
.join('');
let inline_script = `__SAPPER__={${[
`baseUrl: "${req.baseUrl}"`,
serialized.preloaded && `preloaded: ${serialized.preloaded}`,
serialized.store && `store: ${serialized.store}`
].filter(Boolean).join(',')}};`;
const has_service_worker = fs.existsSync(path.join(locations.dest(), 'service-worker.js'));
if (has_service_worker) {
inline_script += `if ('serviceWorker' in navigator) navigator.serviceWorker.register('${req.baseUrl}/service-worker.js');`;
}
const page = template()
.replace('%sapper.base%', `<base href="${req.baseUrl}/">`)
.replace('%sapper.scripts%', `<script>${inline_script}</script>${scripts}`)
.replace('%sapper.html%', html)
.replace('%sapper.head%', `<noscript id='sapper-head-start'></noscript>${head}<noscript id='sapper-head-end'></noscript>`)
.replace('%sapper.styles%', (css && css.code ? `<style>${css.code}</style>` : ''));
res.statusCode = status;
res.end(page);
if (process.send) {
process.send({
__sapper__: true,
event: 'file',
url: req.url,
method: req.method,
status: 200,
type: 'text/html',
body: page
});
}
});
}
else {
const method = req.method.toLowerCase();
// 'delete' cannot be exported from a module because it is a keyword,
// so check for 'del' instead
const method_export = method === 'delete' ? 'del' : method;
const handle_method = mod[method_export];
if (handle_method) {
if (process.env.SAPPER_EXPORT) {
const { write, end, setHeader } = res;
const chunks: any[] = [];
const headers: Record<string, string> = {};
// intercept data so that it can be exported
res.write = function(chunk: any) {
chunks.push(new Buffer(chunk));
write.apply(res, arguments);
};
res.setHeader = function(name: string, value: string) {
headers[name.toLowerCase()] = value;
setHeader.apply(res, arguments);
};
res.end = function(chunk?: any) {
if (chunk) chunks.push(new Buffer(chunk));
end.apply(res, arguments);
process.send({
__sapper__: true,
event: 'file',
url: req.url,
method: req.method,
status: res.statusCode,
type: headers['content-type'],
body: Buffer.concat(chunks).toString()
});
};
}
const handle_bad_result = (err?: Error) => {
if (err) {
console.error(err.stack);
res.statusCode = 500;
res.end(err.message);
} else {
process.nextTick(next);
}
};
try {
handle_method(req, res, handle_bad_result);
} catch (err) {
handle_bad_result(err);
}
} else {
// no matching handler for method
process.nextTick(next);
} }
} }
} catch (error) {
if (route.error) { return fetch(parsed.href, opts);
// there was an error rendering the error page! },
res.statusCode = status; store
res.end(error instanceof Error ? error.message : error); };
const root_preloaded = manifest.root.preload
? manifest.root.preload.call(preload_context, {
path: req.path,
query: req.query,
params: {}
})
: {};
const match = error ? null : page.pattern.exec(req.path);
Promise.all([root_preloaded].concat(page.parts.map(part => {
if (!part) return null;
return part.component.preload
? part.component.preload.call(preload_context, {
path: req.path,
query: req.query,
params: part.params ? part.params(match) : {}
})
: {};
}))).catch(err => {
preload_error = { statusCode: 500, message: err };
return []; // appease TypeScript
}).then(preloaded => {
if (redirect) {
const location = `${req.baseUrl}/${redirect.location}`;
res.statusCode = redirect.statusCode;
res.setHeader('Location', location);
res.end();
return;
}
if (preload_error) {
handle_error(req, res, preload_error.statusCode, preload_error.message);
return;
}
const serialized = {
preloaded: `[${preloaded.map(data => try_serialize(data)).join(',')}]`,
store: store && try_serialize(store.get())
};
const segments = req.path.split('/').filter(Boolean);
const props: Props = {
path: req.path,
query: req.query,
params: {},
child: null
};
if (error) {
props.error = error instanceof Error ? error : { message: error };
props.status = status;
}
const data = Object.assign({}, props, preloaded[0], {
params: {},
child: {
segment: segments[0]
}
});
let level = data.child;
for (let i = 0; i < page.parts.length; i += 1) {
const part = page.parts[i];
if (!part) continue;
const get_params = part.params || (() => ({}));
Object.assign(level, {
component: part.component,
props: Object.assign({}, props, {
params: get_params(match)
}, preloaded[i + 1])
});
level.props.child = <Props["child"]>{
segment: segments[i + 1]
};
level = level.props.child;
}
const { html, head, css } = manifest.root.render(data, {
store
});
let script = `__SAPPER__={${[
error && `error:1`,
`baseUrl:"${req.baseUrl}"`,
serialized.preloaded && `preloaded:${serialized.preloaded}`,
serialized.store && `store:${serialized.store}`
].filter(Boolean).join(',')}};`;
const has_service_worker = fs.existsSync(path.join(locations.dest(), 'service-worker.js'));
if (has_service_worker) {
script += `if('serviceWorker' in navigator)navigator.serviceWorker.register('${req.baseUrl}/service-worker.js');`;
}
const file = [].concat(build_info.assets.main).filter(file => file && /\.js$/.test(file))[0];
const main = `${req.baseUrl}/client/${file}`;
if (build_info.bundler === 'rollup') {
if (build_info.legacy_assets) {
const legacy_main = `${req.baseUrl}/client/legacy/${build_info.legacy_assets.main}`;
script += `(function(){try{eval("async function x(){}");var main="${main}"}catch(e){main="${legacy_main}"};try{new Function("import('"+main+"')")();}catch(e){var s=document.createElement("script");s.src="${req.baseUrl}/client/shimport@${build_info.shimport}.js";s.setAttribute("data-main",main);document.head.appendChild(s);}}());`;
} else { } else {
handle_route(error_route, req, res, 500, error || 'Internal server error'); script += `try{new Function("import('${main}')")();}catch(e){var s=document.createElement("script");s.src="${req.baseUrl}/client/shimport@${build_info.shimport}.js";s.setAttribute("data-main","${main}");document.head.appendChild(s);}`;
}
} else {
script += `</script><script src="${main}">`;
}
let styles: string;
// TODO make this consistent across apps
if (build_info.css && build_info.css.main) {
const css_chunks = new Set();
if (build_info.css.main) css_chunks.add(build_info.css.main);
page.parts.forEach(part => {
if (!part) return;
const css_chunks_for_part = build_info.css.chunks[part.file];
if (css_chunks_for_part) {
css_chunks_for_part.forEach(file => {
css_chunks.add(file);
});
}
});
styles = Array.from(css_chunks)
.map(href => `<link rel="stylesheet" href="client/${href}">`)
.join('')
} else {
styles = (css && css.code ? `<style>${css.code}</style>` : '');
}
const body = template()
.replace('%sapper.base%', () => `<base href="${req.baseUrl}/">`)
.replace('%sapper.scripts%', () => `<script>${script}</script>`)
.replace('%sapper.html%', () => html)
.replace('%sapper.head%', () => `<noscript id='sapper-head-start'></noscript>${head}<noscript id='sapper-head-end'></noscript>`)
.replace('%sapper.styles%', () => styles);
res.statusCode = status;
res.end(body);
}).catch(err => {
if (error) {
// we encountered an error while rendering the error page — oops
res.statusCode = 500;
res.end(`<pre>${escape_html(err.message)}</pre>`);
} else {
handle_error(req, res, 500, err);
}
});
}
return function find_route(req: Req, res: ServerResponse, next: () => void) {
if (req[IGNORE]) return next();
if (!server_routes.some(route => route.pattern.test(req.path))) {
for (const page of pages) {
if (page.pattern.test(req.path)) {
handle_page(page, req, res);
return;
} }
} }
} }
next(); handle_error(req, res, 404, 'Not found');
}
return function find_route(req: Req, res: ServerResponse) {
for (const route of routes) {
if (!route.error && route.pattern.test(req.path)) return handle_route(route, req, res);
}
handle_route(error_route, req, res, 404, 'Not found');
}; };
} }
@@ -436,3 +587,15 @@ function try_serialize(data: any) {
return null; return null;
} }
} }
function escape_html(html: string) {
const chars: Record<string, string> = {
'"' : 'quot',
"'": '#39',
'&': 'amp',
'<' : 'lt',
'>' : 'gt'
};
return html.replace(/["'&<>]/g, c => `&${chars[c]};`);
}

50
src/rollup.ts Normal file
View File

@@ -0,0 +1,50 @@
import { locations, dev } from './config';
export default {
dev: dev(),
client: {
input: () => {
return `${locations.app()}/client.js`
},
output: () => {
let dir = `${locations.dest()}/client`;
if (process.env.SAPPER_LEGACY_BUILD) dir += `/legacy`;
return {
dir,
entryFileNames: '[name].[hash].js',
chunkFileNames: '[name].[hash].js',
format: 'esm',
sourcemap: dev()
};
}
},
server: {
input: () => {
return `${locations.app()}/server.js`
},
output: () => {
return {
dir: locations.dest(),
format: 'cjs'
};
}
},
serviceworker: {
input: () => {
return `${locations.app()}/service-worker.js`;
},
output: () => {
return {
file: `${locations.dest()}/service-worker.js`,
format: 'iife'
}
}
}
};

View File

@@ -1,14 +1,39 @@
import { detach, findAnchor, scroll_state, which } from './utils'; import { detach, findAnchor, scroll_state, which } from './utils';
import { Component, ComponentConstructor, Params, Query, Route, RouteData, ScrollPosition, Store, Target } from './interfaces'; import { Component, ComponentConstructor, Params, Query, Redirect, Manifest, RouteData, ScrollPosition, Store, Target, ComponentLoader } from './interfaces';
const manifest = typeof window !== 'undefined' && window.__SAPPER__; const initial_data = typeof window !== 'undefined' && window.__SAPPER__;
export let App: ComponentConstructor; export let root: Component;
export let component: Component;
let target: Node; let target: Node;
let store: Store; let store: Store;
let routes: Route[]; let manifest: Manifest;
let error_route: Route; let segments: string[] = [];
type RootProps = {
path: string;
params: Record<string, string>;
query: Record<string, string>;
child: Child;
};
type Child = {
segment?: string;
props?: any;
component?: Component;
};
const root_props: RootProps = {
path: null,
params: null,
query: null,
child: {
segment: null,
component: null,
props: {}
}
};
export { root as component }; // legacy reasons — drop in a future version
const history = typeof window !== 'undefined' ? window.history : { const history = typeof window !== 'undefined' ? window.history : {
pushState: (state: any, title: string, href: string) => {}, pushState: (state: any, title: string, href: string) => {},
@@ -26,42 +51,50 @@ if ('scrollRestoration' in history) {
function select_route(url: URL): Target { function select_route(url: URL): Target {
if (url.origin !== window.location.origin) return null; if (url.origin !== window.location.origin) return null;
if (!url.pathname.startsWith(manifest.baseUrl)) return null; if (!url.pathname.startsWith(initial_data.baseUrl)) return null;
const path = url.pathname.slice(manifest.baseUrl.length); const path = url.pathname.slice(initial_data.baseUrl.length);
for (const route of routes) { // avoid accidental clashes between server routes and pages
const match = route.pattern.exec(path); if (manifest.ignore.some(pattern => pattern.test(path))) return;
for (let i = 0; i < manifest.pages.length; i += 1) {
const page = manifest.pages[i];
const match = page.pattern.exec(path);
if (match) { if (match) {
if (route.ignore) return null;
const params = route.params(match);
const query: Record<string, string | true> = {}; const query: Record<string, string | true> = {};
if (url.search.length > 0) { if (url.search.length > 0) {
url.search.slice(1).split('&').forEach(searchParam => { url.search.slice(1).split('&').forEach(searchParam => {
const [, key, value] = /([^=]+)=(.*)/.exec(searchParam); const [, key, value] = /([^=]+)=(.*)/.exec(searchParam);
query[key] = value || true; query[key] = value || true;
}) });
} }
return { url, route, props: { params, query, path } }; return { url, path, page, match, query };
} }
} }
} }
let current_token: {}; let current_token: {};
function render(Page: ComponentConstructor, props: any, scroll: ScrollPosition, token: {}) { function render(data: any, nullable_depth: number, scroll: ScrollPosition, token: {}) {
if (current_token !== token) return; if (current_token !== token) return;
const data = { if (root) {
Page, // first, clear out highest-level root component
props, let level = data.child;
preloading: false for (let i = 0; i < nullable_depth; i += 1) {
}; if (i === nullable_depth) break;
level = level.props.child;
}
if (component) { const { component } = level;
component.set(data); level.component = null;
root.set({ child: data.child });
// then render new stuff
level.component = component;
root.set(data);
} else { } else {
// first load — remove SSR'd <head> contents // first load — remove SSR'd <head> contents
const start = document.querySelector('#sapper-head-start'); const start = document.querySelector('#sapper-head-start');
@@ -73,7 +106,9 @@ function render(Page: ComponentConstructor, props: any, scroll: ScrollPosition,
detach(end); detach(end);
} }
component = new App({ Object.assign(data, root_data);
root = new manifest.root({
target, target,
data, data,
store, store,
@@ -84,52 +119,180 @@ function render(Page: ComponentConstructor, props: any, scroll: ScrollPosition,
if (scroll) { if (scroll) {
window.scrollTo(scroll.x, scroll.y); window.scrollTo(scroll.x, scroll.y);
} }
Object.assign(root_props, data);
ready = true;
} }
function prepare_route(Page: ComponentConstructor, props: RouteData) { function changed(a: Record<string, string | true>, b: Record<string, string | true>) {
let redirect: { statusCode: number, location: string } = null; return JSON.stringify(a) !== JSON.stringify(b);
}
let root_preload: Promise<any>;
let root_data: any;
function load_css(chunk: string) {
const href = `${initial_data.baseUrl}client/${chunk}`;
if (document.querySelector(`link[href="${href}"]`)) return;
return new Promise((fulfil, reject) => {
const link = document.createElement('link');
link.rel = 'stylesheet';
link.href = href;
link.onload = () => fulfil();
link.onerror = reject;
document.head.appendChild(link);
});
}
function load_component(component: ComponentLoader): Promise<ComponentConstructor> {
// TODO this is temporary — once placeholders are
// always rewritten, scratch the ternary
const promises: Array<Promise<any>> = (typeof component.css === 'string' ? [] : component.css.map(load_css));
promises.unshift(component.js());
return Promise.all(promises).then(values => values[0].default);
}
function prepare_page(target: Target): Promise<{
redirect?: Redirect;
data?: any;
nullable_depth?: number;
}> {
const { page, path, query } = target;
const new_segments = path.split('/').filter(Boolean);
let changed_from = 0;
while (
segments[changed_from] &&
new_segments[changed_from] &&
segments[changed_from] === new_segments[changed_from]
) changed_from += 1;
let redirect: Redirect = null;
let error: { statusCode: number, message: Error | string } = null; let error: { statusCode: number, message: Error | string } = null;
if (!Page.preload) { const preload_context = {
return { Page, props, redirect, error };
}
if (!component && manifest.preloaded) {
return { Page, props: Object.assign(props, manifest.preloaded), redirect, error };
}
if (component) {
component.set({
preloading: true
});
}
return Promise.resolve(Page.preload.call({
store, store,
fetch: (url: string, opts?: any) => window.fetch(url, opts), fetch: (url: string, opts?: any) => window.fetch(url, opts),
redirect: (statusCode: number, location: string) => { redirect: (statusCode: number, location: string) => {
if (redirect && (redirect.statusCode !== statusCode || redirect.location !== location)) {
throw new Error(`Conflicting redirects`);
}
redirect = { statusCode, location }; redirect = { statusCode, location };
}, },
error: (statusCode: number, message: Error | string) => { error: (statusCode: number, message: Error | string) => {
error = { statusCode, message }; error = { statusCode, message };
} }
}, props)).catch(err => { };
if (!root_preload) {
root_preload = manifest.root.preload
? initial_data.preloaded[0] || manifest.root.preload.call(preload_context, {
path,
query,
params: {}
})
: {};
}
return Promise.all(page.parts.map(async (part, i) => {
if (i < changed_from) return null;
if (!part) return null;
const Component = await load_component(part.component);
const req = {
path,
query,
params: part.params ? part.params(target.match) : {}
};
const preloaded = ready || !initial_data.preloaded[i + 1]
? Component.preload ? await Component.preload.call(preload_context, req) : {}
: initial_data.preloaded[i + 1];
return { Component, preloaded };
})).catch(err => {
error = { statusCode: 500, message: err }; error = { statusCode: 500, message: err };
}).then(preloaded => { return [];
if (error) { }).then(async results => {
return error_route.load().then(({ default: Page }: { default: ComponentConstructor }) => { if (!root_data) root_data = await root_preload;
const err = error.message instanceof Error ? error.message : new Error(error.message);
Object.assign(props, { status: error.statusCode, error: err }); if (redirect) {
return { Page, props, redirect: null }; return { redirect };
});
} }
Object.assign(props, preloaded) segments = new_segments;
return { Page, props, redirect };
const get_params = page.parts[page.parts.length - 1].params || (() => ({}));
const params = get_params(target.match);
if (error) {
const props = {
path,
query,
params,
error: typeof error.message === 'string' ? new Error(error.message) : error.message,
status: error.statusCode
};
return {
data: Object.assign({}, props, {
preloading: false,
child: {
component: manifest.error,
props
}
})
};
}
const props = { path, query };
const data = {
path,
preloading: false,
child: Object.assign({}, root_props.child, {
segment: segments[0]
})
};
if (changed(query, root_props.query)) data.query = query;
if (changed(params, root_props.params)) data.params = params;
let level = data.child;
let nullable_depth = 0;
for (let i = 0; i < page.parts.length; i += 1) {
const part = page.parts[i];
if (!part) continue;
const get_params = part.params || (() => ({}));
if (i < changed_from) {
level.props.path = path;
level.props.query = query;
level.props.child = Object.assign({}, level.props.child);
nullable_depth += 1;
} else {
level.component = results[i].Component;
level.props = Object.assign({}, level.props, props, {
params: get_params(target.match),
}, results[i].preloaded);
level.props.child = {};
}
level = level.props.child;
level.segment = segments[i + 1];
}
return { data, nullable_depth };
}); });
} }
function navigate(target: Target, id: number): Promise<any> { async function navigate(target: Target, id: number): Promise<any> {
if (id) { if (id) {
// popstate or initial navigation // popstate or initial navigation
cid = id; cid = id;
@@ -143,22 +306,24 @@ function navigate(target: Target, id: number): Promise<any> {
cid = id; cid = id;
if (root) {
root.set({ preloading: true });
}
const loaded = prefetching && prefetching.href === target.url.href ? const loaded = prefetching && prefetching.href === target.url.href ?
prefetching.promise : prefetching.promise :
target.route.load().then(mod => prepare_route(mod.default, target.props)); prepare_page(target);
prefetching = null; prefetching = null;
const token = current_token = {}; const token = current_token = {};
const { redirect, data, nullable_depth } = await loaded;
return loaded.then(({ Page, props, redirect }) => { if (redirect) {
if (redirect) { await goto(redirect.location, { replaceState: true });
return goto(redirect.location, { replaceState: true }); } else {
} render(data, nullable_depth, scroll_history[id], token);
if (document.activeElement) document.activeElement.blur();
render(Page, props, scroll_history[id], token); }
document.activeElement.blur();
});
} }
function handle_click(event: MouseEvent) { function handle_click(event: MouseEvent) {
@@ -171,6 +336,8 @@ function handle_click(event: MouseEvent) {
const a: HTMLAnchorElement | SVGAElement = <HTMLAnchorElement | SVGAElement>findAnchor(<Node>event.target); const a: HTMLAnchorElement | SVGAElement = <HTMLAnchorElement | SVGAElement>findAnchor(<Node>event.target);
if (!a) return; if (!a) return;
if (!a.href) return;
// check if link is inside an svg // check if link is inside an svg
// in this case, both href and target are always inside an object // in this case, both href and target are always inside an object
const svg = typeof a.href === 'object' && a.href.constructor.name === 'SVGAnimatedString'; const svg = typeof a.href === 'object' && a.href.constructor.name === 'SVGAnimatedString';
@@ -222,16 +389,16 @@ function handle_popstate(event: PopStateEvent) {
let prefetching: { let prefetching: {
href: string; href: string;
promise: Promise<{ Page: ComponentConstructor, props: any }>; promise: Promise<{ redirect?: Redirect, data?: any, nullable_depth?: number }>;
} = null; } = null;
export function prefetch(href: string) { export function prefetch(href: string) {
const selected = select_route(new URL(href, document.baseURI)); const target: Target = select_route(new URL(href, document.baseURI));
if (selected && (!prefetching || href !== prefetching.href)) { if (target && (!prefetching || href !== prefetching.href)) {
prefetching = { prefetching = {
href, href,
promise: selected.route.load().then(mod => prepare_route(mod.default, selected.props)) promise: prepare_page(target)
}; };
} }
} }
@@ -253,19 +420,28 @@ function trigger_prefetch(event: MouseEvent | TouchEvent) {
} }
let inited: boolean; let inited: boolean;
let ready = false;
export function init(opts: { App: ComponentConstructor, target: Node, routes: Route[], store?: (data: any) => Store }) { export function init(opts: {
App: ComponentConstructor,
target: Node,
manifest: Manifest,
store?: (data: any) => Store,
routes?: any // legacy
}) {
if (opts instanceof HTMLElement) { if (opts instanceof HTMLElement) {
throw new Error(`The signature of init(...) has changed — see https://sapper.svelte.technology/guide#0-11-to-0-12 for more information`); throw new Error(`The signature of init(...) has changed — see https://sapper.svelte.technology/guide#0-11-to-0-12 for more information`);
} }
App = opts.App; if (opts.routes) {
throw new Error(`As of Sapper 0.15, opts.routes should be opts.manifest`);
}
target = opts.target; target = opts.target;
routes = opts.routes.filter(r => !r.error); manifest = opts.manifest;
error_route = opts.routes.find(r => r.error);
if (opts && opts.store) { if (opts && opts.store) {
store = opts.store(manifest.store); store = opts.store(initial_data.store);
} }
if (!inited) { // this check makes HMR possible if (!inited) { // this check makes HMR possible
@@ -289,8 +465,10 @@ export function init(opts: { App: ComponentConstructor, target: Node, routes: Ro
history.replaceState({ id: uid }, '', href); history.replaceState({ id: uid }, '', href);
const target = select_route(new URL(window.location.href)); if (!initial_data.error) {
if (target) return navigate(target, uid); const target = select_route(new URL(window.location.href));
if (target) return navigate(target, uid);
}
}); });
} }
@@ -310,20 +488,16 @@ export function goto(href: string, opts = { replaceState: false }) {
} }
export function prefetchRoutes(pathnames: string[]) { export function prefetchRoutes(pathnames: string[]) {
if (!routes) throw new Error(`You must call init() first`); if (!manifest) throw new Error(`You must call init() first`);
return routes return manifest.pages
.filter(route => { .filter(route => {
if (!pathnames) return true; if (!pathnames) return true;
return pathnames.some(pathname => { return pathnames.some(pathname => route.pattern.test(pathname));
return route.error
? route.error === pathname
: route.pattern.test(pathname)
});
}) })
.reduce((promise: Promise<any>, route) => { .reduce((promise: Promise<any>, route) => promise.then(() => {
return promise.then(route.load); return Promise.all(route.parts.map(part => part && load_component(part.component)));
}, Promise.resolve()); }), Promise.resolve());
} }
// remove this in 0.9 // remove this in 0.9

View File

@@ -11,15 +11,28 @@ export interface ComponentConstructor {
}; };
export interface Component { export interface Component {
set: (data: any) => void;
destroy: () => void; destroy: () => void;
} }
export type Route = { export type ComponentLoader = {
js: () => Promise<{ default: ComponentConstructor }>,
css: string[]
};
export type Page = {
pattern: RegExp; pattern: RegExp;
load: () => Promise<{ default: ComponentConstructor }>; parts: Array<{
error?: boolean; component: ComponentLoader;
params?: (match: RegExpExecArray) => Record<string, string>; params?: (match: RegExpExecArray) => Record<string, string>;
ignore?: boolean; }>;
};
export type Manifest = {
ignore: RegExp[];
root: ComponentConstructor;
error: () => Promise<{ default: ComponentConstructor }>;
pages: Page[]
}; };
export type ScrollPosition = { export type ScrollPosition = {
@@ -29,6 +42,13 @@ export type ScrollPosition = {
export type Target = { export type Target = {
url: URL; url: URL;
route: Route; path: string;
props: RouteData; page: Page;
match: RegExpExecArray;
query: Record<string, string | true>;
};
export type Redirect = {
statusCode: number;
location: string;
}; };

10
src/utils.ts Normal file
View File

@@ -0,0 +1,10 @@
export function left_pad(str: string, len: number) {
while (str.length < len) str = ` ${str}`;
return str;
}
export function repeat(str: string, i: number) {
let result = '';
while (i--) result += str;
return result;
}

View File

@@ -1,6 +0,0 @@
{#if preloading}
<progress class='preloading-progress' value=0.5/>
{/if}
<svelte:component this={Page} {...props}/>

View File

@@ -1,13 +1,11 @@
import { init, prefetchRoutes } from '../../../runtime.js'; import { init, prefetchRoutes } from '../../../runtime.js';
import { Store } from 'svelte/store.js'; import { Store } from 'svelte/store.js';
import { routes } from './manifest/client.js'; import { manifest } from './manifest/client.js';
import App from './App.html';
window.init = () => { window.init = () => {
return init({ return init({
target: document.querySelector('#sapper'), target: document.querySelector('#sapper'),
App, manifest,
routes,
store: data => new Store(data) store: data => new Store(data)
}); });
}; };

View File

@@ -2,10 +2,9 @@ import fs from 'fs';
import { resolve } from 'url'; import { resolve } from 'url';
import express from 'express'; import express from 'express';
import serve from 'serve-static'; import serve from 'serve-static';
import sapper from '../../../dist/middleware.ts.js'; import sapper from '../../../dist/middleware.js';
import { Store } from 'svelte/store.js'; import { Store } from 'svelte/store.js';
import { routes } from './manifest/server.js'; import { manifest } from './manifest/server.js';
import App from './App.html'
let pending; let pending;
let ended; let ended;
@@ -86,21 +85,44 @@ const middlewares = [
next(); next();
}, },
// set up some values for the store
(req, res, next) => {
req.hello = 'hello';
res.locals = { name: 'world' };
next();
},
sapper({ sapper({
App, manifest,
routes, store: (req, res) => {
store: () => {
return new Store({ return new Store({
title: 'Stored title' title: `${req.hello} ${res.locals.name}`
}); });
} },
}) ignore: [
/foobar/i,
'/buzz',
'fizz',
x => x === '/hello'
]
}),
]; ];
app.get(`${BASEPATH}/non-sapper-redirect-from`, (req, res) => {
res.writeHead(301, {
Location: `${BASEPATH}/non-sapper-redirect-to`
});
res.end();
});
if (BASEPATH) { if (BASEPATH) {
app.use(BASEPATH, ...middlewares); app.use(BASEPATH, ...middlewares);
} else { } else {
app.use(...middlewares); app.use(...middlewares);
} }
app.listen(PORT); ['foobar', 'buzz', 'fizzer', 'hello'].forEach(uri => {
app.get('/'+uri, (req, res) => res.end(uri));
});
app.listen(PORT);

View File

@@ -0,0 +1,20 @@
<span>z: {segment} {count}</span>
<a href="foo/bar/qux"></a>
<script>
import counts from '../_counts.js';
export default {
preload() {
return {
count: counts.z += 1
};
},
oncreate() {
this.set({
segment: this.get().params.z
});
}
};
</script>

View File

@@ -0,0 +1,22 @@
<span>y: {segment} {count}</span>
<svelte:component this={child.component} {...child.props}/>
<span>child segment: {child.segment}</span>
<script>
import counts from '../_counts.js';
export default {
preload() {
return {
count: counts.y += 1
};
},
oncreate() {
this.set({
segment: this.get().params.y
});
}
};
</script>

View File

@@ -0,0 +1,5 @@
export default {
x: process.browser ? 1 : 0,
y: process.browser ? 1 : 0,
z: process.browser ? 1 : 0
};

View File

@@ -0,0 +1,15 @@
{#if preloading}
<progress class='preloading-progress' value=0.5/>
{/if}
<svelte:component this={child.component} {rootPreloadFunctionRan} {...child.props}/>
<script>
export default {
preload() {
return {
rootPreloadFunctionRan: true
};
}
};
</script>

View File

@@ -0,0 +1 @@
<h1>reserved words are okay as routes</h1>

View File

@@ -1 +1,11 @@
<h1>I'm afraid I just blue myself</h1> <h1>{phrase}</h1>
<script>
export default {
preload() {
return this.fetch('fünke.json').then(r => r.json()).then(phrase => {
return { phrase };
});
}
};
</script>

View File

@@ -0,0 +1,9 @@
export function get(req, res) {
res.writeHead(200, {
'Content-Type': 'application/json'
});
res.end(JSON.stringify(
"I'm afraid I just blue myself"
));
}

View File

@@ -7,11 +7,14 @@
<a href='.'>home</a> <a href='.'>home</a>
<a href='about'>about</a> <a href='about'>about</a>
<a href='slow-preload'>slow preload</a> <a href='slow-preload'>slow preload</a>
<a href='non-sapper-redirect-from'>redirect</a>
<a href='redirect-from'>redirect</a> <a href='redirect-from'>redirect</a>
<a href='redirect-root'>redirect (root)</a>
<a href='blog/nope'>broken link</a> <a href='blog/nope'>broken link</a>
<a href='blog/throw-an-error'>error link</a> <a href='blog/throw-an-error'>error link</a>
<a href='credentials?creds=include'>credentials</a> <a href='credentials?creds=include'>credentials</a>
<a rel=prefetch class='{page === "blog" ? "selected" : ""}' href='blog'>blog</a> <a rel=prefetch class='{page === "blog" ? "selected" : ""}' href='blog'>blog</a>
<a href="const">const</a>
<div class='hydrate-test'></div> <div class='hydrate-test'></div>

View File

@@ -0,0 +1 @@
<h1>it works</h1>

View File

@@ -0,0 +1 @@
<h1>redirected</h1>

View File

@@ -0,0 +1 @@
<h1>root preload function ran: {rootPreloadFunctionRan}</h1>

View File

@@ -0,0 +1 @@
<svelte:component this={child.component} {...child.props}/>

View File

@@ -0,0 +1,7 @@
<script>
export default {
preload() {
this.redirect(301, '/');
}
};
</script>

View File

@@ -1,9 +0,0 @@
<p>URL is {url}</p>
<script>
export default {
preload({ url }) {
if (url) return { url };
}
};
</script>

View File

@@ -0,0 +1,9 @@
$&
<script>
export default {
preload() {
return '$&';
}
};
</script>

View File

@@ -1,4 +1,4 @@
const config = require('../../../webpack/config.js'); const config = require('../../../config/webpack.js');
const webpack = require('webpack'); const webpack = require('webpack');
const mode = process.env.NODE_ENV; const mode = process.env.NODE_ENV;

View File

@@ -1,4 +1,4 @@
const config = require('../../../webpack/config.js'); const config = require('../../../config/webpack.js');
const sapper_pkg = require('../../../package.json'); const sapper_pkg = require('../../../package.json');
module.exports = { module.exports = {

View File

@@ -1,4 +1,4 @@
const config = require('../../../webpack/config.js'); const config = require('../../../config/webpack.js');
module.exports = { module.exports = {
entry: config.serviceworker.entry(), entry: config.serviceworker.entry(),

View File

@@ -2,9 +2,7 @@ const fs = require('fs');
const path = require('path'); const path = require('path');
const assert = require('assert'); const assert = require('assert');
const Nightmare = require('nightmare'); const Nightmare = require('nightmare');
const serve = require('serve-static');
const walkSync = require('walk-sync'); const walkSync = require('walk-sync');
const fetch = require('node-fetch');
const rimraf = require('rimraf'); const rimraf = require('rimraf');
const ports = require('port-authority'); const ports = require('port-authority');
@@ -32,6 +30,8 @@ Nightmare.action('prefetchRoutes', function(done) {
const cli = path.resolve(__dirname, '../../sapper'); const cli = path.resolve(__dirname, '../../sapper');
const wait = ms => new Promise(f => setTimeout(f, ms));
describe('sapper', function() { describe('sapper', function() {
process.chdir(path.resolve(__dirname, '../app')); process.chdir(path.resolve(__dirname, '../app'));
@@ -41,7 +41,7 @@ describe('sapper', function() {
rimraf.sync('.sapper'); rimraf.sync('.sapper');
rimraf.sync('start.js'); rimraf.sync('start.js');
this.timeout(process.env.CI ? 30000 : 10000); this.timeout(process.env.CI ? 30000 : 15000);
// TODO reinstate dev tests // TODO reinstate dev tests
// run({ // run({
@@ -57,9 +57,19 @@ describe('sapper', function() {
basepath: '/custom-basepath' basepath: '/custom-basepath'
}); });
describe('export', () => { testExport({});
testExport({ basepath: '/custom-basepath' });
});
function testExport({ basepath = '' }) {
describe(basepath ? `export --basepath ${basepath}` : 'export', () => {
before(() => { before(() => {
return exec(`node ${cli} export`); if (basepath) {
process.env.BASEPATH = basepath;
}
return exec(`node ${cli} export ${basepath ? `--basepath ${basepath}` : ''}`);
}); });
it('export all pages', () => { it('export all pages', () => {
@@ -71,6 +81,11 @@ describe('sapper', function() {
'about/index.html', 'about/index.html',
'slow-preload/index.html', 'slow-preload/index.html',
'redirect-from/index.html',
'redirect-to/index.html',
'non-sapper-redirect-from/index.html',
'non-sapper-redirect-to/index.html',
'blog/index.html', 'blog/index.html',
'blog/a-very-long-post/index.html', 'blog/a-very-long-post/index.html',
'blog/how-can-i-get-involved/index.html', 'blog/how-can-i-get-involved/index.html',
@@ -94,16 +109,18 @@ describe('sapper', function() {
'service-worker.js', 'service-worker.js',
'svelte-logo-192.png', 'svelte-logo-192.png',
'svelte-logo-512.png', 'svelte-logo-512.png',
]; ].map(file => {
return basepath ? `${basepath.replace(/^[\/\\]/, '')}/${file}` : file;
});
// Client scripts that should show up in the extraction directory. // Client scripts that should show up in the extraction directory.
const expectedClientRegexes = [ const expectedClientRegexes = [
/client\/[^/]+\/_(\.\d+)?\.js/,
/client\/[^/]+\/about(\.\d+)?\.js/,
/client\/[^/]+\/blog_\$slug\$(\.\d+)?\.js/,
/client\/[^/]+\/blog(\.\d+)?\.js/,
/client\/[^/]+\/main(\.\d+)?\.js/, /client\/[^/]+\/main(\.\d+)?\.js/,
/client\/[^/]+\/show_url(\.\d+)?\.js/, /client\/[^/]+\/index(\.\d+)?\.js/,
/client\/[^/]+\/slow_preload(\.\d+)?\.js/, /client\/[^/]+\/about(\.\d+)?\.js/,
/client\/[^/]+\/blog_\$slug(\.\d+)?\.js/,
/client\/[^/]+\/blog(\.\d+)?\.js/,
/client\/[^/]+\/slow\$45preload(\.\d+)?\.js/,
]; ];
const allPages = walkSync(dest); const allPages = walkSync(dest);
@@ -125,7 +142,7 @@ describe('sapper', function() {
}); });
}); });
}); });
}); }
function run({ mode, basepath = '' }) { function run({ mode, basepath = '' }) {
describe(`mode=${mode}`, function () { describe(`mode=${mode}`, function () {
@@ -266,8 +283,9 @@ function run({ mode, basepath = '' }) {
}) })
.then(requests => { .then(requests => {
assert.deepEqual(requests.map(r => r.url), []); assert.deepEqual(requests.map(r => r.url), []);
return nightmare.path();
}) })
.then(() => wait(100))
.then(() => nightmare.path())
.then(path => { .then(path => {
assert.equal(path, `${basepath}/about`); assert.equal(path, `${basepath}/about`);
return nightmare.title(); return nightmare.title();
@@ -367,16 +385,6 @@ function run({ mode, basepath = '' }) {
}); });
}); });
it('passes entire request object to preload', () => {
return nightmare
.goto(`${base}/show-url`)
.init()
.evaluate(() => document.querySelector('p').innerHTML)
.then(html => {
assert.equal(html, `URL is /show-url`);
});
});
it('calls a delete handler', () => { it('calls a delete handler', () => {
return nightmare return nightmare
.goto(`${base}/delete-test`) .goto(`${base}/delete-test`)
@@ -431,6 +439,33 @@ function run({ mode, basepath = '' }) {
}); });
}); });
it('redirects on server (root)', () => {
return nightmare.goto(`${base}/redirect-root`)
.path()
.then(path => {
assert.equal(path, `${basepath}/`);
})
.then(() => nightmare.page.title())
.then(title => {
assert.equal(title, 'Great success!');
});
});
it('redirects in client (root)', () => {
return nightmare.goto(base)
.wait('[href="redirect-root"]')
.click('[href="redirect-root"]')
.wait(200)
.path()
.then(path => {
assert.equal(path, `${basepath}/`);
})
.then(() => nightmare.page.title())
.then(title => {
assert.equal(title, 'Great success!');
});
});
it('handles 4xx error on server', () => { it('handles 4xx error on server', () => {
return nightmare.goto(`${base}/blog/nope`) return nightmare.goto(`${base}/blog/nope`)
.path() .path()
@@ -485,6 +520,42 @@ function run({ mode, basepath = '' }) {
}); });
}); });
// Ignores are meant for top-level escape.
// ~> Sapper **should** own the entire {basepath} when designated.
if (!basepath) {
it('respects `options.ignore` values (RegExp)', () => {
return nightmare.goto(`${base}/foobar`)
.evaluate(() => document.documentElement.textContent)
.then(text => {
assert.equal(text, 'foobar');
});
});
it('respects `options.ignore` values (String #1)', () => {
return nightmare.goto(`${base}/buzz`)
.evaluate(() => document.documentElement.textContent)
.then(text => {
assert.equal(text, 'buzz');
});
});
it('respects `options.ignore` values (String #2)', () => {
return nightmare.goto(`${base}/fizzer`)
.evaluate(() => document.documentElement.textContent)
.then(text => {
assert.equal(text, 'fizzer');
});
});
it('respects `options.ignore` values (Function)', () => {
return nightmare.goto(`${base}/hello`)
.evaluate(() => document.documentElement.textContent)
.then(text => {
assert.equal(text, 'hello');
});
});
}
it('does not attempt client-side navigation to server routes', () => { it('does not attempt client-side navigation to server routes', () => {
return nightmare.goto(`${base}/blog/how-is-sapper-different-from-next`) return nightmare.goto(`${base}/blog/how-is-sapper-different-from-next`)
.init() .init()
@@ -540,11 +611,11 @@ function run({ mode, basepath = '' }) {
return nightmare.goto(`${base}/store`) return nightmare.goto(`${base}/store`)
.page.title() .page.title()
.then(title => { .then(title => {
assert.equal(title, 'Stored title'); assert.equal(title, 'hello world');
return nightmare.init().page.title(); return nightmare.init().page.title();
}) })
.then(title => { .then(title => {
assert.equal(title, 'Stored title'); assert.equal(title, 'hello world');
}); });
}); });
@@ -619,6 +690,67 @@ function run({ mode, basepath = '' }) {
assert.equal(name, 'BODY'); assert.equal(name, 'BODY');
}); });
}); });
it('replaces %sapper.xxx% tags safely', () => {
return nightmare
.goto(`${base}/unsafe-replacement`)
.init()
.page.html()
.then(html => {
assert.equal(html.indexOf('%sapper'), -1);
});
});
it('only recreates components when necessary', () => {
return nightmare
.goto(`${base}/foo/bar/baz`)
.init()
.evaluate(() => document.querySelector('#sapper').textContent)
.then(text => {
assert.deepEqual(text.split('\n').filter(Boolean), [
'y: bar 1',
'z: baz 1',
'child segment: baz'
]);
return nightmare.click(`a`)
.then(() => wait(100))
.then(() => {
return nightmare.evaluate(() => document.querySelector('#sapper').textContent);
});
})
.then(text => {
assert.deepEqual(text.split('\n').filter(Boolean), [
'y: bar 1',
'z: qux 2',
'child segment: qux'
]);
});
});
it('uses a fallback index component if none is provided', () => {
return nightmare.goto(`${base}/missing-index/ok`)
.page.title()
.then(title => {
assert.equal(title, 'it works');
});
});
it('runs preload in root component', () => {
return nightmare.goto(`${base}/preload-root`)
.page.title()
.then(title => {
assert.equal(title, 'root preload function ran: true');
});
});
it('allows reserved words as route names', () => {
return nightmare.goto(`${base}/const`).init()
.page.title()
.then(title => {
assert.equal(title, 'reserved words are okay as routes');
});
});
}); });
describe('headers', () => { describe('headers', () => {
@@ -631,7 +763,7 @@ function run({ mode, basepath = '' }) {
'text/html' 'text/html'
); );
const str = ['main', '_\\.\\d+'] const str = ['main', '.+?\\.\\d+']
.map(file => { .map(file => {
return `<${basepath}/client/[^/]+/${file}\\.js>;rel="preload";as="script"`; return `<${basepath}/client/[^/]+/${file}\\.js>;rel="preload";as="script"`;
}) })

View File

@@ -0,0 +1,26 @@
import * as fs from 'fs';
import * as path from 'path';
import * as assert from 'assert';
import clean_html from '../../../src/api/utils/clean_html';
describe('clean_html', () => {
const samples = path.join(__dirname, 'samples');
fs.readdirSync(samples).forEach(dir => {
if (dir[0] === '.') return;
it(dir, () => {
const input = fs.readFileSync(`${samples}/${dir}/input.html`, 'utf-8');
const expected = fs.readFileSync(`${samples}/${dir}/output.html`, 'utf-8');
const actual = clean_html(input);
fs.writeFileSync(`${samples}/${dir}/.actual.html`, actual);
assert.equal(
actual.replace(/\s+$/gm, ''),
expected.replace(/\s+$/gm, '')
);
});
});
});

View File

@@ -0,0 +1,14 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<math>
<ms></ms>
<mo>+</mo>
<mn>3</mn>
<mo>=</mo>
<ms></ms>
</math>
</body>
</html>

View File

@@ -0,0 +1,14 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<math>
<ms><![CDATA[x<y]]></ms>
<mo>+</mo>
<mn>3</mn>
<mo>=</mo>
<ms><![CDATA[x<y3]]></ms>
</math>
</body>
</html>

View File

@@ -0,0 +1,14 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<math>
<ms></ms>
<mo>+</mo>
<mn>3</mn>
<mo>=</mo>
<ms></ms>
</math>
</body>
</html>

View File

@@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<a href="keep-me">keep me</a>
</body>
</html>

View File

@@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<a href="keep-me">keep me</a>
<!-- <a href="delete-me">delete me</a> -->
</body>
</html>

View File

@@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<a href="keep-me">keep me</a>
</body>
</html>

View File

@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<script></script>
<script></script>
<script src="attributes-are-preserved.js"></script>
</body>
</html>

View File

@@ -0,0 +1,16 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<script>
console.log('this should be deleted');
</script>
<script>
console.log('so should this');
</script>
<script src="attributes-are-preserved.js"></script>
</body>
</html>

View File

@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
</head>
<body>
<script></script>
<script></script>
<script src="attributes-are-preserved.js"></script>
</body>
</html>

View File

@@ -0,0 +1,168 @@
import * as path from 'path';
import * as assert from 'assert';
import create_manifest_data from '../../../src/core/create_manifest_data';
describe('manifest_data', () => {
it('creates routes', () => {
const { components, pages, server_routes } = create_manifest_data(path.join(__dirname, 'samples/basic'));
const index = { name: 'index', file: 'index.html' };
const about = { name: 'about', file: 'about.html' };
const blog = { name: 'blog', file: 'blog/index.html' };
const blog_$slug = { name: 'blog_$slug', file: 'blog/[slug].html' };
assert.deepEqual(components, [
index,
about,
blog,
blog_$slug
]);
assert.deepEqual(pages, [
{
pattern: /^\/?$/,
parts: [
{ component: index, params: [] }
]
},
{
pattern: /^\/about\/?$/,
parts: [
{ component: about, params: [] }
]
},
{
pattern: /^\/blog\/?$/,
parts: [
null,
{ component: blog, params: [] }
]
},
{
pattern: /^\/blog\/([^\/]+?)\/?$/,
parts: [
null,
{ component: blog_$slug, params: ['slug'] }
]
}
]);
assert.deepEqual(server_routes, [
{
name: 'route_blog_json',
pattern: /^\/blog.json$/,
file: 'blog/index.json.js',
params: []
},
{
name: 'route_blog_$slug_json',
pattern: /^\/blog\/([^\/]+?).json$/,
file: 'blog/[slug].json.js',
params: ['slug']
}
]);
});
it('encodes invalid characters', () => {
const { components, pages } = create_manifest_data(path.join(__dirname, 'samples/encoding'));
// had to remove ? and " because windows
// const quote = { name: '$34', file: '".html' };
const hash = { name: '$35', file: '#.html' };
// const question_mark = { name: '$63', file: '?.html' };
assert.deepEqual(components, [
// quote,
hash,
// question_mark
]);
assert.deepEqual(pages.map(p => p.pattern), [
// /^\/%22\/?$/,
/^\/%23\/?$/,
// /^\/%3F\/?$/
]);
});
it('allows regex qualifiers', () => {
const { pages } = create_manifest_data(path.join(__dirname, 'samples/qualifiers'));
assert.deepEqual(pages.map(p => p.pattern), [
/^\/([0-9-a-z]{3,})\/?$/,
/^\/([a-z]{2})\/?$/,
/^\/([^\/]+?)\/?$/
]);
});
it('sorts routes correctly', () => {
const { pages } = create_manifest_data(path.join(__dirname, 'samples/sorting'));
assert.deepEqual(pages.map(p => p.parts.map(part => part && part.component.file)), [
['index.html'],
['about.html'],
[null, 'post/index.html'],
[null, 'post/bar.html'],
[null, 'post/foo.html'],
[null, 'post/f[xx].html'],
[null, 'post/[id([0-9-a-z]{3,})].html'],
[null, 'post/[id].html'],
['[wildcard].html']
]);
});
it('ignores files and directories with leading underscores', () => {
const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/hidden-underscore'));
assert.deepEqual(server_routes.map(r => r.file), [
'index.js',
'e/f/g/h.js'
]);
});
it('ignores files and directories with leading dots except .well-known', () => {
const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/hidden-dot'));
assert.deepEqual(server_routes.map(r => r.file), [
'.well-known/dnt-policy.txt.js'
]);
});
it('fails on clashes', () => {
assert.throws(() => {
const { pages } = create_manifest_data(path.join(__dirname, 'samples/clash-pages'));
}, /The \[bar\]\/index\.html and \[foo\]\.html pages clash/);
assert.throws(() => {
const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/clash-routes'));
console.log(server_routes);
}, /The \[bar\]\/index\.js and \[foo\]\.js routes clash/);
});
it('fails if dynamic params are not separated', () => {
assert.throws(() => {
create_manifest_data(path.join(__dirname, 'samples/invalid-params'));
}, /Invalid route \[foo\]\[bar\]\.js — parameters must be separated/);
});
it('errors when trying to use reserved characters in route regexp', () => {
assert.throws(() => {
create_manifest_data(path.join(__dirname, 'samples/invalid-qualifier'));
}, /Invalid route \[foo\(\[a-z\]\(\[0-9\]\)\)\].js — cannot use \(, \), \? or \: in route qualifiers/);
});
it('ignores things that look like lockfiles' , () => {
const { server_routes } = create_manifest_data(path.join(__dirname, 'samples/lockfiles'));
assert.deepEqual(server_routes, [{
file: 'foo.js',
name: 'route_foo',
params: [],
pattern: /^\/foo$/
}]);
});
});

Some files were not shown because too many files have changed in this diff Show More