[Feature] Add preserveModulesRoot config option (#3786)

* add initial moduleRootDir implementation

* moduleRootDir -> preserveModulesRoot

Also avoid regex, switch `path.resolve` to `path.join` due to lack of
browser support for `path.join`

* update cli help + docs

* fix optionList test

* add preserveModulesRoot test

* fix preserveModulesRootDir -> preserveModulesRoot

* fix preserveModulesRootDir -> preserveModulesRoot

* Fix cli help styling

* Refactor code

* early return -> path =

cli/help.md

@@ -46,6 +46,7 @@ Basic options:
 --preferConst               Use `const` instead of `var` for exports
 --no-preserveEntrySignatures Avoid facade chunks for entry points
 --preserveModules           Preserve module structure
+--preserveModulesRoot       Preserved modules under this path are rooted in output `dir`
 --preserveSymlinks          Do not follow symlinks when resolving files
 --shimMissingExports        Create shim variables for missing exports
 --silent                    Don't print warnings

docs/01-command-line-reference.md

@@ -78,6 +78,7 @@ export default { // can be an array (for multiple inputs)
     outro,
     paths,
     preserveModules,
+    preserveModulesRoot,
     sourcemap,
     sourcemapExcludeSources,
     sourcemapFile,
@@ -303,6 +304,7 @@ Many options have command line equivalents. In those cases, any arguments passed
 --preferConst               Use `const` instead of `var` for exports
 --no-preserveEntrySignatures Avoid facade chunks for entry points
 --preserveModules           Preserve module structure
+--preserveModulesRoot       Preserved modules under this path are rooted in output `dir`
 --preserveSymlinks          Do not follow symlinks when resolving files
 --shimMissingExports        Create shim variables for missing exports
 --silent                    Don't print warnings

docs/02-javascript-api.md

@@ -138,6 +138,7 @@ const outputOptions = {
   outro,
   paths,
   preserveModules,
+  preserveModulesRoot,
   sourcemap,
   sourcemapExcludeSources,
   sourcemapFile,
@@ -235,4 +236,4 @@ loadConfigFile(path.resolve(__dirname, 'rollup.config.js'), { format: 'es' }).th
 		rollup.watch(options);
 	}
 );
-```
+```

src/Chunk.ts

@@ -441,20 +441,25 @@ export default class Chunk {
 					? '[name].js'
 					: '[name][extname].js'
 				: options.entryFileNames;
-			path = relative(
-				preserveModulesRelativeDir,
-				`${dirname(sanitizedId)}/${renderNamePattern(
-					pattern,
-					'output.entryFileNames',
-					{
-						ext: () => extension.substr(1),
-						extname: () => extension,
-						format: () => options.format as string,
-						name: () => this.getChunkName()
-					},
-					this.getChunkInfo.bind(this)
-				)}`
+			const currentDir = dirname(sanitizedId);
+			const fileName = renderNamePattern(
+				pattern,
+				'output.entryFileNames',
+				{
+					ext: () => extension.substr(1),
+					extname: () => extension,
+					format: () => options.format as string,
+					name: () => this.getChunkName()
+				},
+				this.getChunkInfo.bind(this)
 			);
+			const currentPath = `${currentDir}/${fileName}`;
+			const { preserveModulesRoot } = options;
+			if (preserveModulesRoot && currentPath.startsWith(preserveModulesRoot)) {
+				path = currentPath.slice(preserveModulesRoot.length).replace(/^\//, '');
+			} else {
+				path = relative(preserveModulesRelativeDir, currentPath);
+			}
 		} else {
 			path = `_virtual/${basename(sanitizedId)}`;
 		}

src/rollup/types.d.ts

@@ -583,6 +583,7 @@ export interface OutputOptions {
 	plugins?: OutputPlugin[];
 	preferConst?: boolean;
 	preserveModules?: boolean;
+	preserveModulesRoot?: string;
 	sourcemap?: boolean | 'inline' | 'hidden';
 	sourcemapExcludeSources?: boolean;
 	sourcemapFile?: string;
@@ -628,6 +629,7 @@ export interface NormalizedOutputOptions {
 	plugins: OutputPlugin[];
 	preferConst: boolean;
 	preserveModules: boolean;
+	preserveModulesRoot: string | undefined;
 	sourcemap: boolean | 'inline' | 'hidden';
 	sourcemapExcludeSources: boolean;
 	sourcemapFile: string | undefined;

src/utils/options/mergeOptions.ts

@@ -221,6 +221,7 @@ function mergeOutputOptions(
 		plugins: ensureArray(config.plugins) as Plugin[],
 		preferConst: getOption('preferConst'),
 		preserveModules: getOption('preserveModules'),
+		preserveModulesRoot: getOption('preserveModulesRoot'),
 		sourcemap: getOption('sourcemap'),
 		sourcemapExcludeSources: getOption('sourcemapExcludeSources'),
 		sourcemapFile: getOption('sourcemapFile'),

src/utils/options/normalizeOutputOptions.ts

@@ -13,6 +13,7 @@ import {
 } from '../../rollup/types';
 import { ensureArray } from '../ensureArray';
 import { errInvalidExportOptionValue, error, warnDeprecation } from '../error';
+import { resolve } from '../path';
 import { GenericConfigObject, warnUnknownOptions } from './options';
 
 export function normalizeOutputOptions(
@@ -64,6 +65,7 @@ export function normalizeOutputOptions(
 		plugins: ensureArray(config.plugins) as Plugin[],
 		preferConst: (config.preferConst as boolean | undefined) || false,
 		preserveModules,
+		preserveModulesRoot: getPreserveModulesRoot(config),
 		sourcemap: (config.sourcemap as boolean | 'inline' | 'hidden' | undefined) || false,
 		sourcemapExcludeSources: (config.sourcemapExcludeSources as boolean | undefined) || false,
 		sourcemapFile: config.sourcemapFile as string | undefined,
@@ -169,6 +171,14 @@ const getPreserveModules = (
 	return preserveModules;
 };
 
+const getPreserveModulesRoot = (config: GenericConfigObject): string | undefined => {
+	const preserveModulesRoot = config.preserveModulesRoot as string | null | undefined;
+	if (preserveModulesRoot === null || preserveModulesRoot === undefined) {
+		return undefined;
+	}
+	return resolve(preserveModulesRoot);
+};
+
 const getAmd = (
 	config: GenericConfigObject
 ): {

test/chunking-form/samples/preserve-modules-root/_config.js

@@ -0,0 +1,21 @@
+const commonjs = require('@rollup/plugin-commonjs');
+const resolve = require('@rollup/plugin-node-resolve').default;
+
+module.exports = {
+	description: 'confirm preserveModulesRoot restructures src appropriately',
+	options: {
+		input: ['src/under-build.js', 'src/below/module.js'],
+		plugins: [
+			resolve({
+				customResolveOptions: {
+					moduleDirectory: ['custom_modules']
+				}
+			}),
+			commonjs()
+		],
+		output: {
+			preserveModules: true,
+			preserveModulesRoot: 'src'
+		}
+	}
+};

test/chunking-form/samples/preserve-modules-root/_expected/amd/_virtual/_commonjsHelpers.js

@@ -0,0 +1,22 @@
+define(['exports'], function (exports) { 'use strict';
+
+	function createCommonjsModule(fn, basedir, module) {
+		return module = {
+		  path: basedir,
+		  exports: {},
+		  require: function (path, base) {
+	      return commonjsRequire(path, (base === undefined || base === null) ? module.path : base);
+	    }
+		}, fn(module, module.exports), module.exports;
+	}
+
+	function commonjsRequire () {
+		throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');
+	}
+
+	exports.commonjsRequire = commonjsRequire;
+	exports.createCommonjsModule = createCommonjsModule;
+
+	Object.defineProperty(exports, '__esModule', { value: true });
+
+});

test/chunking-form/samples/preserve-modules-root/_expected/amd/_virtual/index.js_commonjs-proxy

@@ -0,0 +1,7 @@
+define(['../custom_modules/@my-scope/my-base-pkg/index'], function (index) { 'use strict';
+
+
+
+	return index.myBasePkg;
+
+});

test/chunking-form/samples/preserve-modules-root/_expected/amd/below/module.js

@@ -0,0 +1,9 @@
+define(['../custom_modules/@my-scope/my-base-pkg/index'], function (index) { 'use strict';
+
+  var module = {
+    base2: index.myBasePkg,
+  };
+
+  return module;
+
+});

test/chunking-form/samples/preserve-modules-root/_expected/amd/custom_modules/@my-scope/my-base-pkg/index.js

@@ -0,0 +1,16 @@
+define(['exports', '../../../_virtual/_commonjsHelpers'], function (exports, _commonjsHelpers) { 'use strict';
+
+	var myBasePkg = _commonjsHelpers.createCommonjsModule(function (module, exports) {
+
+	Object.defineProperty(exports, '__esModule', { value: true });
+
+	var hello = 'world';
+
+	exports.hello = hello;
+	});
+
+	exports.myBasePkg = myBasePkg;
+
+	Object.defineProperty(exports, '__esModule', { value: true });
+
+});

test/chunking-form/samples/preserve-modules-root/_expected/amd/under-build.js

@@ -0,0 +1,9 @@
+define(['./custom_modules/@my-scope/my-base-pkg/index'], function (index) { 'use strict';
+
+	var underBuild = {
+		base: index.myBasePkg
+	};
+
+	return underBuild;
+
+});

test/chunking-form/samples/preserve-modules-root/_expected/cjs/_virtual/_commonjsHelpers.js

@@ -0,0 +1,20 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function createCommonjsModule(fn, basedir, module) {
+	return module = {
+	  path: basedir,
+	  exports: {},
+	  require: function (path, base) {
+      return commonjsRequire(path, (base === undefined || base === null) ? module.path : base);
+    }
+	}, fn(module, module.exports), module.exports;
+}
+
+function commonjsRequire () {
+	throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');
+}
+
+exports.commonjsRequire = commonjsRequire;
+exports.createCommonjsModule = createCommonjsModule;

test/chunking-form/samples/preserve-modules-root/_expected/cjs/_virtual/index.js_commonjs-proxy

@@ -0,0 +1,7 @@
+'use strict';
+
+var index = require('../custom_modules/@my-scope/my-base-pkg/index.js');
+
+
+
+module.exports = index.myBasePkg;

test/chunking-form/samples/preserve-modules-root/_expected/cjs/below/module.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var index = require('../custom_modules/@my-scope/my-base-pkg/index.js');
+
+var module$1 = {
+  base2: index.myBasePkg,
+};
+
+module.exports = module$1;

test/chunking-form/samples/preserve-modules-root/_expected/cjs/custom_modules/@my-scope/my-base-pkg/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _commonjsHelpers = require('../../../_virtual/_commonjsHelpers.js');
+
+var myBasePkg = _commonjsHelpers.createCommonjsModule(function (module, exports) {
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var hello = 'world';
+
+exports.hello = hello;
+});
+
+exports.myBasePkg = myBasePkg;

test/chunking-form/samples/preserve-modules-root/_expected/cjs/under-build.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var index = require('./custom_modules/@my-scope/my-base-pkg/index.js');
+
+var underBuild = {
+	base: index.myBasePkg
+};
+
+module.exports = underBuild;

test/chunking-form/samples/preserve-modules-root/_expected/es/_virtual/_commonjsHelpers.js

@@ -0,0 +1,15 @@
+function createCommonjsModule(fn, basedir, module) {
+	return module = {
+	  path: basedir,
+	  exports: {},
+	  require: function (path, base) {
+      return commonjsRequire(path, (base === undefined || base === null) ? module.path : base);
+    }
+	}, fn(module, module.exports), module.exports;
+}
+
+function commonjsRequire () {
+	throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');
+}
+
+export { commonjsRequire, createCommonjsModule };

test/chunking-form/samples/preserve-modules-root/_expected/es/_virtual/index.js_commonjs-proxy

@@ -0,0 +1,2 @@
+import { m as myBasePkg } from '../custom_modules/@my-scope/my-base-pkg/index.js';
+export { m as default } from '../custom_modules/@my-scope/my-base-pkg/index.js';

test/chunking-form/samples/preserve-modules-root/_expected/es/below/module.js

@@ -0,0 +1,7 @@
+import { m as myBasePkg } from '../custom_modules/@my-scope/my-base-pkg/index.js';
+
+var module = {
+  base2: myBasePkg,
+};
+
+export default module;

test/chunking-form/samples/preserve-modules-root/_expected/es/custom_modules/@my-scope/my-base-pkg/index.js

@@ -0,0 +1,12 @@
+import { createCommonjsModule } from '../../../_virtual/_commonjsHelpers.js';
+
+var myBasePkg = createCommonjsModule(function (module, exports) {
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var hello = 'world';
+
+exports.hello = hello;
+});
+
+export { myBasePkg as m };

test/chunking-form/samples/preserve-modules-root/_expected/es/under-build.js

@@ -0,0 +1,7 @@
+import { m as myBasePkg } from './custom_modules/@my-scope/my-base-pkg/index.js';
+
+var underBuild = {
+	base: myBasePkg
+};
+
+export default underBuild;

test/chunking-form/samples/preserve-modules-root/_expected/system/_virtual/_commonjsHelpers.js

@@ -0,0 +1,27 @@
+System.register([], function (exports) {
+	'use strict';
+	return {
+		execute: function () {
+
+			exports({
+				commonjsRequire: commonjsRequire,
+				createCommonjsModule: createCommonjsModule
+			});
+
+			function createCommonjsModule(fn, basedir, module) {
+				return module = {
+				  path: basedir,
+				  exports: {},
+				  require: function (path, base) {
+			      return commonjsRequire(path, (base === undefined || base === null) ? module.path : base);
+			    }
+				}, fn(module, module.exports), module.exports;
+			}
+
+			function commonjsRequire () {
+				throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');
+			}
+
+		}
+	};
+});

test/chunking-form/samples/preserve-modules-root/_expected/system/_virtual/index.js_commonjs-proxy

@@ -0,0 +1,15 @@
+System.register(['../custom_modules/@my-scope/my-base-pkg/index.js'], function (exports) {
+	'use strict';
+	var myBasePkg;
+	return {
+		setters: [function (module) {
+			myBasePkg = module.m;
+			exports('default', module.m);
+		}],
+		execute: function () {
+
+
+
+		}
+	};
+});

test/chunking-form/samples/preserve-modules-root/_expected/system/below/module.js

@@ -0,0 +1,16 @@
+System.register(['../custom_modules/@my-scope/my-base-pkg/index.js'], function (exports) {
+  'use strict';
+  var myBasePkg;
+  return {
+    setters: [function (module) {
+      myBasePkg = module.m;
+    }],
+    execute: function () {
+
+      var module$1 = exports('default', {
+        base2: myBasePkg,
+      });
+
+    }
+  };
+});