Strip comments and add tests

Author: benmccann

package-lock.json

@@ -22,7 +22,8 @@
     "http-link-header": "^1.0.2",
     "shimport": "^1.0.1",
     "sourcemap-codec": "^1.4.6",
-    "string-hash": "^1.1.3"
+    "string-hash": "^1.1.3",
+    "strip-comments": "^2.0.1"
   },
   "devDependencies": {
     "@types/mocha": "^5.2.7",

package.json

@@ -1,8 +1,13 @@
 import * as fs from 'fs';
 import * as path from 'path';
+import stripComments from 'strip-comments';
 import { Page, PageComponent, ServerRoute, ManifestData } from '../interfaces';
 import { posixify, reserved_words } from '../utils';
 
+export function string_has_preload(source: string) {
+	return /export\s+.*?preload/.test(stripComments(source));
+}
+
 export default function create_manifest_data(cwd: string, extensions: string = '.svelte .html'): ManifestData {
 
 	const component_extensions = extensions.split(' ');
@@ -12,22 +17,24 @@ export default function create_manifest_data(cwd: string, extensions: string = '
 		throw new Error(`As of Sapper 0.21, the routes/ directory should become src/routes/`);
 	}
 
-	function has_preload(file: string) {
+	function file_has_preload(file: string) {
 		const source = fs.readFileSync(path.join(cwd, file), 'utf-8');
-		return /export\s+.*?preload/.test(source);
+		return string_has_preload(source);
 	}
 
 	function find_layout(file_name: string, component_name: string, dir: string = '') {
 		const ext = component_extensions.find((ext) => fs.existsSync(path.join(cwd, dir, `${file_name}${ext}`)));
 		const file = posixify(path.join(dir, `${file_name}${ext}`))
 
-		return ext
-			? {
+		if (!ext) {
+			return null;
+		}
+
+		return {
 				name: component_name,
 				file: file,
-				has_preload: has_preload(file)
-			}
-			: null;
+				has_preload: file_has_preload(file)
+			};
 	}
 
 	const components: PageComponent[] = [];
@@ -153,7 +160,7 @@ export default function create_manifest_data(cwd: string, extensions: string = '
 				const component = {
 					name: get_slug(item.file),
 					file: item.file,
-					has_preload: has_preload(item.file)
+					has_preload: file_has_preload(item.file)
 				};
 
 				components.push(component);

src/core/create_manifest_data.ts

@@ -1,6 +1,65 @@
 import * as path from 'path';
 import * as assert from 'assert';
-import create_manifest_data from '../../../src/core/create_manifest_data';
+import create_manifest_data, { string_has_preload } from '../../../src/core/create_manifest_data';
+
+describe('string_has_preload', () => {
+	it('should detect async preload', () => {
+		const source = `
+			<script context="module">
+				export async function preload() {
+					const client = getClient();
+					let response = await client.query({ query: GET_POSTS });
+					let posts = response.data.getPosts;
+					return { posts };
+				}
+			</script>
+		`;
+		assert.ok(string_has_preload(source));
+	});
+
+	it('should detect preload in composed function', () => {
+		const source = `
+			<script context="module">
+				export const preload = verifyUser(catchErrors(function () { console.log('test'); }));
+			</script>
+		`;
+		assert.ok(string_has_preload(source));
+	});
+
+	it('should detect reusable preload functions', () => {
+		const source = `
+			<script context="module">
+				export { preload } from './userData'
+			</script>
+		`;
+		assert.ok(string_has_preload(source));
+	});
+
+	it('should not detect preload functions in single line comment', () => {
+		const source = `
+			<script context="module">
+				//export { preload } from './userData'
+			</script>
+		`;
+		assert.ok(!string_has_preload(source));
+	});
+
+	it('should not detect preload functions in comment block', () => {
+		const source = `
+			<script context="module">
+				/*
+				export async function preload() {
+					const client = getClient();
+					let response = await client.query({ query: GET_POSTS });
+					let posts = response.data.getPosts;
+					return { posts };
+				}
+				*/
+			</script>
+		`;
+		assert.ok(!string_has_preload(source));
+	});
+});
 
 describe('manifest_data', () => {
 	it('creates routes', () => {