Generate sourcemaps but omit the comment (#3120)

* Generate sourcemaps without comment using `hidden` option (#2743)

Signed-off-by: Rohit Mohan <rohitmohan96@gmail.com>

* Added tests for hidden sourcemaps

Signed-off-by: Rohit Mohan <rohitmohan96@gmail.com>

* Added cli tests for hidden sourcemaps

Signed-off-by: Rohit Mohan <rohitmohan96@gmail.com>

* Update documentation and improve test

docs/999-big-list-of-options.md

@@ -486,11 +486,11 @@ define(['https://d3js.org/d3.v4.min'], function (d3) {
 ```
 
 #### output.sourcemap
-Type: `boolean | 'inline'`<br>
+Type: `boolean | 'inline' | 'hidden'`<br>
 CLI: `-m`/`--sourcemap`/`--no-sourcemap`<br>
 Default: `false`
 
-If `true`, a separate sourcemap file will be created. If `inline`, the sourcemap will be appended to the resulting `output` file as a data URI.
+If `true`, a separate sourcemap file will be created. If `"inline"`, the sourcemap will be appended to the resulting `output` file as a data URI. `"hidden"` works like `true` except that the corresponding sourcemap comments in the bundled files are suppressed.
 
 #### output.sourcemapExcludeSources
 Type: `boolean`<br>

src/rollup/index.ts

@@ -402,7 +402,9 @@ function writeOutputFile(
 				url = `${basename(outputFile.fileName)}.map`;
 				writeSourceMapPromise = writeFile(`${fileName}.map`, outputFile.map.toString());
 			}
-			source += `//# ${SOURCEMAPPING_URL}=${url}\n`;
+			if (outputOptions.sourcemap !== 'hidden') {
+				source += `//# ${SOURCEMAPPING_URL}=${url}\n`;
+			}
 		}
 	}
 

src/rollup/types.d.ts

@@ -475,7 +475,7 @@ export interface OutputOptions {
 	outro?: string | (() => string | Promise<string>);
 	paths?: OptionsPaths;
 	preferConst?: boolean;
-	sourcemap?: boolean | 'inline';
+	sourcemap?: boolean | 'inline' | 'hidden';
 	sourcemapExcludeSources?: boolean;
 	sourcemapFile?: string;
 	sourcemapPathTransform?: (sourcePath: string) => string;

test/cli/samples/sourcemap-hidden/_config.js

@@ -0,0 +1,17 @@
+const fs = require('fs');
+const assert = require('assert');
+
+module.exports = {
+	description: 'omits sourcemap comments',
+	command: 'rollup -i main.js -f es -m hidden -o output.js',
+	test() {
+		assert.equal(fs.readFileSync('output.js', 'utf-8').trim(), 'console.log( 42 );');
+		fs.unlinkSync('output.js');
+		assert.equal(
+			fs.readFileSync('output.js.map', 'utf-8').trim(),
+			'{"version":3,"file":"output.js","sources":["main.js"],"sourcesContent":' +
+				'["console.log( 42 );\\n"],"names":[],"mappings":"AAAA,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC"}'
+		);
+		fs.unlinkSync('output.js.map');
+	}
+};

test/cli/samples/sourcemap-hidden/main.js

@@ -0,0 +1 @@
+console.log( 42 );

test/form/samples/sourcemaps-hidden/_config.js

@@ -0,0 +1,7 @@
+module.exports = {
+	description: 'correct sourcemaps are written (separate file) without comment',
+	skipIfWindows: true,
+	options: {
+		output: { sourcemap: 'hidden' }
+	}
+};

test/form/samples/sourcemaps-hidden/_expected/amd.js

@@ -0,0 +1,16 @@
+define(function () { 'use strict';
+
+	function foo () {
+		console.log( 'hello from foo.js' );
+	}
+
+	function bar () {
+		console.log( 'hello from bar.js' );
+	}
+
+	console.log( 'hello from main.js' );
+
+	foo();
+	bar();
+
+});

test/form/samples/sourcemaps-hidden/_expected/cjs.js

@@ -0,0 +1,14 @@
+'use strict';
+
+function foo () {
+	console.log( 'hello from foo.js' );
+}
+
+function bar () {
+	console.log( 'hello from bar.js' );
+}
+
+console.log( 'hello from main.js' );
+
+foo();
+bar();

test/form/samples/sourcemaps-hidden/_expected/es.js

@@ -0,0 +1,12 @@
+function foo () {
+	console.log( 'hello from foo.js' );
+}
+
+function bar () {
+	console.log( 'hello from bar.js' );
+}
+
+console.log( 'hello from main.js' );
+
+foo();
+bar();

test/form/samples/sourcemaps-hidden/_expected/iife.js

@@ -0,0 +1,17 @@
+(function () {
+	'use strict';
+
+	function foo () {
+		console.log( 'hello from foo.js' );
+	}
+
+	function bar () {
+		console.log( 'hello from bar.js' );
+	}
+
+	console.log( 'hello from main.js' );
+
+	foo();
+	bar();
+
+}());

test/form/samples/sourcemaps-hidden/_expected/system.js

@@ -0,0 +1,21 @@
+System.register([], function () {
+	'use strict';
+	return {
+		execute: function () {
+
+			function foo () {
+				console.log( 'hello from foo.js' );
+			}
+
+			function bar () {
+				console.log( 'hello from bar.js' );
+			}
+
+			console.log( 'hello from main.js' );
+
+			foo();
+			bar();
+
+		}
+	};
+});

test/form/samples/sourcemaps-hidden/_expected/umd.js

@@ -0,0 +1,19 @@
+(function (factory) {
+	typeof define === 'function' && define.amd ? define(factory) :
+	factory();
+}(function () { 'use strict';
+
+	function foo () {
+		console.log( 'hello from foo.js' );
+	}
+
+	function bar () {
+		console.log( 'hello from bar.js' );
+	}
+
+	console.log( 'hello from main.js' );
+
+	foo();
+	bar();
+
+}));

test/form/samples/sourcemaps-hidden/bar.js

@@ -0,0 +1,3 @@
+export default function bar () {
+	console.log( 'hello from bar.js' );
+}

test/form/samples/sourcemaps-hidden/foo.js

@@ -0,0 +1,3 @@
+export default function foo () {
+	console.log( 'hello from foo.js' );
+}

test/form/samples/sourcemaps-hidden/main.js

@@ -0,0 +1,7 @@
+import foo from './foo';
+import bar from './bar';
+
+console.log( 'hello from main.js' );
+
+foo();
+bar();