-> v0.15.4

Add `ignore` option

CHANGELOG.md

@@ -1,5 +1,14 @@
 # sapper changelog
 
+## 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))

README.md

@@ -31,6 +31,44 @@ npm run build
 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
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sapper",
-  "version": "0.15.2",
+  "version": "0.15.4",
   "description": "Military-grade apps, engineered by Svelte",
   "main": "dist/middleware.ts.js",
   "bin": {
@@ -23,7 +23,7 @@
     "cheerio": "^1.0.0-rc.2",
     "chokidar": "^2.0.3",
     "cookie": "^0.3.1",
-    "devalue": "^1.0.1",
+    "devalue": "^1.0.4",
     "glob": "^7.1.2",
     "html-minifier": "^3.5.16",
     "mkdirp": "^0.5.1",

src/api/export.ts

@@ -118,9 +118,7 @@ async function execute(emitter: EventEmitter, {
 					}
 				});
 
-				for (const url of urls) {
-					await handle(url);
-				}
+				await Promise.all(urls.map(handle));
 			}
 		}
 	}

src/api/utils/minify_html.ts

@@ -8,7 +8,7 @@ export function minify_html(html: string) {
 		decodeEntities: true,
 		html5: true,
 		minifyCSS: true,
-		minifyJS: true,
+		minifyJS: false,
 		removeAttributeQuotes: true,
 		removeComments: true,
 		removeOptionalTags: true,

src/middleware.ts

@@ -73,9 +73,18 @@ interface Component {
 	preload: (data: any) => any | Promise<any>
 }
 
+const IGNORE = '__SAPPER__IGNORE__';
+function toIgnore(uri: string, val: any) {
+	if (Array.isArray(val)) return val.some(x => toIgnore(uri, x));
+	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) => Store,
+	ignore?: any,
 	routes?: any // legacy
 }) {
 	if (opts.routes) {
@@ -84,12 +93,19 @@ export default function middleware(opts: {
 
 	const output = locations.dest();
 
-	const { manifest, store } = opts;
+	const { manifest, store, ignore } = opts;
 
 	let emitted_basepath = false;
 
 	const middleware = compose_handlers([
+		ignore && ((req: Req, res: ServerResponse, next: () => void) => {
+			req[IGNORE] = toIgnore(req.path, ignore);
+			next();
+		}),
+
 		(req: Req, res: ServerResponse, next: () => void) => {
+			if (req[IGNORE]) return next();
+
 			if (req.baseUrl === undefined) {
 				let { originalUrl } = req;
 				if (req.url === '/' && originalUrl[originalUrl.length - 1] !== '/') {
@@ -163,6 +179,8 @@ function serve({ prefix, pathname, cache_control }: {
 		: (file: string) => (cache.has(file) ? cache : cache.set(file, fs.readFileSync(path.resolve(output, file)))).get(file)
 
 	return (req: Req, res: ServerResponse, next: () => void) => {
+		if (req[IGNORE]) return next();
+
 		if (filter(req)) {
 			const type = lookup(req.path);
 
@@ -245,6 +263,8 @@ function get_server_route_handler(routes: ServerRoute[]) {
 	}
 
 	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);
@@ -452,9 +472,9 @@ function get_page_handler(manifest: Manifest, store_getter: (req: Req) => Store)
 
 			let inline_script = `__SAPPER__={${[
 				error && `error:1`,
-				`baseUrl: "${req.baseUrl}"`,
-				serialized.preloaded && `preloaded: ${serialized.preloaded}`,
-				serialized.store && `store: ${serialized.store}`
+				`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'));
@@ -494,7 +514,9 @@ function get_page_handler(manifest: Manifest, store_getter: (req: Req) => Store)
 		});
 	}
 
-	return function find_route(req: Req, res: ServerResponse) {
+	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)) {

src/runtime/index.ts

@@ -233,7 +233,7 @@ function prepare_page(target: Target): Promise<{
 			path,
 			preloading: false,
 			child: Object.assign({}, root_props.child, {
-				segment: new_segments[0]
+				segment: segments[0]
 			})
 		};
 		if (changed(query, root_props.query)) data.query = query;
@@ -260,12 +260,11 @@ function prepare_page(target: Target): Promise<{
 					params: get_params(target.match),
 				}, results[i].preloaded);
 
-				level.props.child = {
-					segment: new_segments[i + 1]
-				};
+				level.props.child = {};
 			}
 
 			level = level.props.child;
+			level.segment = segments[i + 1];
 		}
 
 		return { data, nullable_depth };

test/app/app/server.js

@@ -91,8 +91,14 @@ const middlewares = [
 			return new Store({
 				title: 'Stored title'
 			});
-		}
-	})
+		},
+		ignore: [
+			/foobar/i,
+			'/buzz',
+			'fizz',
+			x => x === '/hello'
+		]
+	}),
 ];
 
 if (BASEPATH) {
@@ -101,4 +107,8 @@ if (BASEPATH) {
 	app.use(...middlewares);
 }
 
-app.listen(PORT);
+['foobar', 'buzz', 'fizzer', 'hello'].forEach(uri => {
+	app.get('/'+uri, (req, res) => res.end(uri));
+});
+
+app.listen(PORT);

test/app/routes/[x]/[y]/_layout.html

@@ -1,6 +1,8 @@
 <span>y: {segment} {count}</span>
 <svelte:component this={child.component} {...child.props}/>
 
+<span>child segment: {child.segment}</span>
+
 <script>
 	import counts from '../_counts.js';
 

test/common/test.js

@@ -477,6 +477,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', () => {
 				return nightmare.goto(`${base}/blog/how-is-sapper-different-from-next`)
 					.init()
@@ -630,7 +666,8 @@ function run({ mode, basepath = '' }) {
 					.then(text => {
 						assert.deepEqual(text.split('\n').filter(Boolean), [
 							'y: bar 1',
-							'z: baz 1'
+							'z: baz 1',
+							'child segment: baz'
 						]);
 
 						return nightmare.click(`a`)
@@ -642,7 +679,8 @@ function run({ mode, basepath = '' }) {
 					.then(text => {
 						assert.deepEqual(text.split('\n').filter(Boolean), [
 							'y: bar 1',
-							'z: qux 2'
+							'z: qux 2',
+							'child segment: qux'
 						]);
 					});
 			});