Merge pull request #3870 from sveltejs/gh-3855

reinstate comments

Author: Rich-Harris

package-lock.json

@@ -56,15 +56,15 @@
   },
   "homepage": "https://github.com/sveltejs/svelte#README",
   "devDependencies": {
+    "@rollup/plugin-replace": "^2.2.1",
     "@types/mocha": "^5.2.7",
     "@types/node": "^8.10.53",
     "@typescript-eslint/eslint-plugin": "^1.13.0",
     "@typescript-eslint/parser": "^2.1.0",
-    "@rollup/plugin-replace": "^2.2.1",
     "acorn": "^7.1.0",
     "agadoo": "^1.1.0",
     "c8": "^5.0.1",
-    "code-red": "0.0.18",
+    "code-red": "0.0.19",
     "codecov": "^3.5.0",
     "css-tree": "1.0.0-alpha22",
     "eslint": "^6.3.0",

package.json

@@ -240,8 +240,7 @@ export default class Component {
 			const { compile_options, name } = this;
 			const { format = 'esm' } = compile_options;
 
-			// TODO reinstate banner (along with fragment marker comments)
-			const banner = `/* ${this.file ? `${this.file} ` : ``}generated by Svelte v${'__VERSION__'} */`;
+			const banner = `${this.file ? `${this.file} ` : ``}generated by Svelte v${'__VERSION__'}`;
 
 			const program: any = { type: 'Program', body: result };
 

src/compiler/compile/Component.ts

@@ -44,7 +44,7 @@ function edit_source(source, sveltePath) {
 function esm(
 	program: any,
 	name: Identifier,
-	_banner: string,
+	banner: string,
 	sveltePath: string,
 	internal_path: string,
 	helpers: Array<{ name: string; alias: Identifier }>,
@@ -98,6 +98,8 @@ function esm(
 	};
 
 	program.body = b`
+		/* ${banner} */
+
 		${import_declaration}
 		${internal_globals}
 		${imports}
@@ -112,7 +114,7 @@ function esm(
 function cjs(
 	program: any,
 	name: Identifier,
-	_banner: string,
+	banner: string,
 	sveltePath: string,
 	internal_path: string,
 	helpers: Array<{ name: string; alias: Identifier }>,
@@ -188,6 +190,8 @@ function cjs(
 	const exports = module_exports.map(x => b`exports.${{ type: 'Identifier', name: x.as }} = ${{ type: 'Identifier', name: x.name }};`);
 
 	program.body = b`
+		/* ${banner} */
+
 		"use strict";
 		${internal_requires}
 		${internal_globals}

src/compiler/compile/create_module.ts

@@ -423,17 +423,17 @@ export default class Block {
 		const key = this.key && this.get_unique_name('key');
 
 		const args: any[] = [x`#ctx`];
-
 		if (key) args.unshift(key);
 
-		// TODO include this.comment
-		// ${this.comment && `// ${escape(this.comment, { only_escape_at_symbol: true })}`}
+		const fn = b`function ${this.name}(${args}) {
+			${this.get_contents(key)}
+		}`;
 
-		return b`
-			function ${this.name}(${args}) {
-				${this.get_contents(key)}
-			}
-		`;
+		return this.comment
+			? b`
+				// ${this.comment}
+				${fn}`
+			: fn;
 	}
 
 	render_listeners(chunk: string = '') {

src/compiler/compile/render_dom/Block.ts

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	detach,

test/js/samples/action-custom-event-handler/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	attr,

test/js/samples/action/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	add_render_callback,

test/js/samples/bind-online/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	detach,

test/js/samples/bind-open/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	add_render_callback,

test/js/samples/bind-width-height/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	attr,

test/js/samples/bindings-readonly-order/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/capture-inject-dev-only/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/collapses-text-around-comments/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	create_component,

test/js/samples/component-static-array/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	create_component,

test/js/samples/component-static-immutable/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	create_component,

test/js/samples/component-static-immutable2/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	create_component,

test/js/samples/component-static-var/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	create_component,

test/js/samples/component-static/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/component-store-access-invalidate/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	component_subscribe,

test/js/samples/component-store-file-invalidate/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/component-store-reassign-invalidate/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import { SvelteComponent, init, safe_not_equal } from "svelte/internal";
 
 function instance($$self, $$props, $$invalidate) {

test/js/samples/computed-collapsed-if/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/css-media-query/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteElement,
 	detach,

test/js/samples/css-shadow-dom-keyframes/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	attr,

test/js/samples/data-attribute/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponentDev,
 	add_location,

test/js/samples/debug-empty/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponentDev,
 	add_location,
@@ -23,6 +24,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (8:0) {#each things as thing}
 function create_each_block(ctx) {
 	let span;
 	let t0_value = ctx.thing.name + "";

test/js/samples/debug-foo-bar-baz-things/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponentDev,
 	add_location,
@@ -23,6 +24,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (6:0) {#each things as thing}
 function create_each_block(ctx) {
 	let span;
 	let t0_value = ctx.thing.name + "";

test/js/samples/debug-foo/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponentDev,
 	dispatch_dev,

test/js/samples/debug-hoisted/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponentDev,
 	destroy_each,
@@ -21,6 +22,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (4:0) {#each things as thing, index}
 function create_each_block(ctx) {
 	let t0;
 	let t1_value = ctx.thing + "";

test/js/samples/debug-no-dependencies/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import { create_ssr_component, debug, each, escape } from "svelte/internal";
 
 const Component = create_ssr_component(($$result, $$props, $$bindings, $$slots) => {

test/js/samples/debug-ssr-foo/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,
@@ -19,6 +20,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (5:0) {#each createElement as node}
 function create_each_block(ctx) {
 	let span;
 	let t_value = ctx.node + "";

test/js/samples/deconflict-builtins/expected.js

@@ -1,4 +1,6 @@
+/* generated by Svelte vX.Y.Z */
 import { SvelteComponent, init, safe_not_equal } from "svelte/internal";
+
 import { onMount } from "svelte";
 
 function instance($$self, $$props, $$invalidate) {

test/js/samples/deconflict-globals/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponentDev,
 	add_location,

test/js/samples/dev-warning-missing-data-computed/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	detach,

test/js/samples/dont-invalidate-this/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	create_component,

test/js/samples/dynamic-import/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,
@@ -19,6 +20,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (9:0) {#each [a, b, c, d, e] as num}
 function create_each_block(ctx) {
 	let span;
 	let t_value = ctx.num + "";

test/js/samples/each-block-array-literal/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	HtmlTag,
 	SvelteComponent,
@@ -22,6 +23,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (8:0) {#each comments as comment, i}
 function create_each_block(ctx) {
 	let div;
 	let strong;
@@ -163,13 +165,7 @@ function instance($$self, $$props, $$invalidate) {
 class Component extends SvelteComponent {
 	constructor(options) {
 		super();
-
-		init(this, options, instance, create_fragment, safe_not_equal, {
-			comments: 0,
-			elapsed: 0,
-			time: 0,
-			foo: 0
-		});
+		init(this, options, instance, create_fragment, safe_not_equal, { comments: 0, elapsed: 0, time: 0, foo: 0 });
 	}
 }
 

test/js/samples/each-block-changed-check/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,
@@ -22,6 +23,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (19:0) {#each things as thing (thing.id)}
 function create_each_block(key_1, ctx) {
 	let div;
 	let t_value = ctx.thing.name + "";

test/js/samples/each-block-keyed-animated/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,
@@ -20,6 +21,7 @@ function get_each_context(ctx, list, i) {
 	return child_ctx;
 }
 
+// (5:0) {#each things as thing (thing.id)}
 function create_each_block(key_1, ctx) {
 	let div;
 	let t_value = ctx.thing.name + "";

test/js/samples/each-block-keyed/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import { SvelteComponent, init, safe_not_equal } from "svelte/internal";
 
 function instance($$self) {

test/js/samples/empty-dom/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/event-handler-dynamic/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	attr,

test/js/samples/event-handler-no-passive/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/event-modifiers/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	append,

test/js/samples/head-no-whitespace/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	detach,

test/js/samples/hoisted-const/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	detach,

test/js/samples/hoisted-let/expected.js

@@ -1,3 +1,4 @@
+/* generated by Svelte vX.Y.Z */
 import {
 	SvelteComponent,
 	attr,