implement amd.autoId/amd.basePath options (#3867)

* implement `amd.idFromChunkName` option

* update output-options-hook test

* update NormalizedOutputOptions type

* simiplify removeExtension()

* fix `idFromChunkName` type

* make `idFromChunkName` required in normalized options

* reference actual types in normalizeOutputOptions

* switch to using a pattern instead

* also removeExtensionFromRelativeAmdId in UMD finaliser

* support id in output.amd.id in umd finaliser

* move test to chunking-form/samples

* remove test from cli section

* remove idFromChunkName

* revert chunking-form index change

* break out to amd.autoId and amd.basePath options

* remove unneeded changes

* update docs

* update test to also put chunks in folder

* throw error if amd.id used with muli-file build

* more accurate amd options type

* update output.amd doc

* fix `@ts-expect-error` comments

* add tests for invalid options

* add test for entryFileNames with output.preserveModules

* ignore internal error in coverage

* simplify type

* fix output options test

* fix type tests

* improve types again

* simply again

* make it a warning

cli/help.md

@@ -20,6 +20,8 @@ Basic options:
 -v, --version               Show version number
 -w, --watch                 Watch files in bundle and rebuild on changes
 --amd.id <id>               ID for AMD module (default is anonymous)
+--amd.autoId                Generate the AMD ID based off the chunk name
+--amd.basePath <prefix>     Path to prepend to auto generated AMD ID
 --amd.define <name>         Function to use in place of `define`
 --assetFileNames <pattern>  Name pattern for emitted assets
 --banner <text>             Code to insert at top of bundle (outside wrapper)

docs/01-command-line-reference.md

@@ -278,6 +278,8 @@ Many options have command line equivalents. In those cases, any arguments passed
 -v, --version               Show version number
 -w, --watch                 Watch files in bundle and rebuild on changes
 --amd.id <id>               ID for AMD module (default is anonymous)
+--amd.autoId                Generate the AMD ID based off the chunk name
+--amd.basePath <prefix>     Path to prepend to auto generated AMD ID
 --amd.define <name>         Function to use in place of `define`
 --assetFileNames <pattern>  Name pattern for emitted assets
 --banner <text>             Code to insert at top of bundle (outside wrapper)

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

@@ -1053,9 +1053,9 @@ Type: `((id: string) => string) | { [id: string]: string }`<br>
 Same as [`context`](guide/en/#context), but per-module – can either be an object of `id: context` pairs, or an `id => context` function.
 
 #### output.amd
-Type: `{ id?: string, define?: string}`
+Type: `{ id?: string, autoId?: boolean, basePath?: string, define?: string }`
 
-An object that can contain the following properties:
+Note `id` can only be used for single-file builds, and cannot be combined with `autoId`/`basePath`.
 
 **output.amd.id**<br>
 Type: `string`<br>
@@ -1076,6 +1076,49 @@ export default {
 // -> define('my-bundle', ['dependency'], ...
 ```
 
+**output.amd.autoId**<br>
+Type: `boolean`<br>
+CLI: `--amd.autoId`
+
+Set the ID to the chunk ID (with the '.js' extension removed).
+
+```js
+// rollup.config.js
+export default {
+  ...,
+  format: 'amd',
+  amd: {
+    autoId: true
+  }
+};
+
+// -> define('main', ['dependency'], ...
+// -> define('dynamic-chunk', ['dependency'], ...
+```
+
+**output.amd.basePath**<br>
+Type: `string`<br>
+CLI: `--amd.basePath`
+
+The path that will be prepended to the auto generated ID. This is useful if the build is going to be placed inside another AMD project, and is not at the root.
+
+Only valid with `output.amd.autoId`.
+
+```js
+// rollup.config.js
+export default {
+  ...,
+  format: 'amd',
+  amd: {
+    autoId: true
+    basePath: 'some/where'
+  }
+};
+
+// -> define('some/where/main', ['dependency'], ...
+// -> define('some/where/dynamic-chunk', ['dependency'], ...
+```
+
 **output.amd.define**<br>
 Type: `string`<br>
 CLI: `--amd.define <defineFunctionName>`

src/Bundle.ts

@@ -8,7 +8,8 @@ import {
 	NormalizedOutputOptions,
 	OutputBundle,
 	OutputBundleWithPlaceholders,
-	OutputChunk
+	OutputChunk,
+	WarningHandler
 } from './rollup/types';
 import { Addons, createAddons } from './utils/addons';
 import { getChunkAssignments } from './utils/chunkAssignment';
@@ -46,7 +47,7 @@ export default class Bundle {
 			timeStart('generate chunks', 2);
 			const chunks = await this.generateChunks();
 			if (chunks.length > 1) {
-				validateOptionsForMultiChunkOutput(this.outputOptions);
+				validateOptionsForMultiChunkOutput(this.outputOptions, this.inputOptions.onwarn);
 			}
 			const inputBase = commondir(getAbsoluteEntryModulePaths(chunks));
 			timeEnd('generate chunks', 2);
@@ -243,7 +244,10 @@ function getAbsoluteEntryModulePaths(chunks: Chunk[]): string[] {
 	return absoluteEntryModulePaths;
 }
 
-function validateOptionsForMultiChunkOutput(outputOptions: NormalizedOutputOptions) {
+function validateOptionsForMultiChunkOutput(
+	outputOptions: NormalizedOutputOptions,
+	onWarn: WarningHandler
+) {
 	if (outputOptions.format === 'umd' || outputOptions.format === 'iife')
 		return error({
 			code: 'INVALID_OPTION',
@@ -261,6 +265,12 @@ function validateOptionsForMultiChunkOutput(outputOptions: NormalizedOutputOptio
 			code: 'INVALID_OPTION',
 			message: '"output.sourcemapFile" is only supported for single-file builds.'
 		});
+	if (!outputOptions.amd.autoId && outputOptions.amd.id)
+		onWarn({
+			code: 'INVALID_OPTION',
+			message:
+				'"output.amd.id" is only properly supported for single-file builds. Use "output.amd.autoId" and "output.amd.basePath".'
+		});
 }
 
 function getIncludedModules(modulesById: Map<string, Module | ExternalModule>): Module[] {

src/Chunk.ts

@@ -414,7 +414,7 @@ export default class Chunk {
 				: [options.chunkFileNames, 'output.chunkFileNames'];
 		return makeUnique(
 			renderNamePattern(
-				pattern,
+				typeof pattern === 'function' ? pattern(this.getChunkInfo()) : pattern,
 				patternName,
 				{
 					format: () => options.format,
@@ -423,8 +423,7 @@ export default class Chunk {
 							? this.computeContentHashWithDependencies(addons, options, existingNames)
 							: '[hash]',
 					name: () => this.getChunkName()
-				},
-				this.getChunkInfo.bind(this)
+				}
 			),
 			existingNames
 		);
@@ -448,15 +447,14 @@ export default class Chunk {
 				: options.entryFileNames;
 			const currentDir = dirname(sanitizedId);
 			const fileName = renderNamePattern(
-				pattern,
+				typeof pattern === 'function' ? pattern(this.getChunkInfo()) : 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;
@@ -712,13 +710,19 @@ export default class Chunk {
 			});
 		}
 
+		/* istanbul ignore next */
+		if (!this.id) {
+			throw new Error('Internal Error: expecting chunk id');
+		}
+
 		const magicString = finalise(
 			this.renderedSource!,
 			{
 				accessedGlobals,
 				dependencies: [...this.renderedDependencies!.values()],
 				exports: this.renderedExports!,
 				hasExports,
+				id: this.id,
 				indentString: this.indentString,
 				intro: addons.intro!,
 				isEntryFacade:
@@ -754,8 +758,8 @@ export default class Chunk {
 
 			let file: string;
 			if (options.file) file = resolve(options.sourcemapFile || options.file);
-			else if (options.dir) file = resolve(options.dir, this.id!);
-			else file = resolve(this.id!);
+			else if (options.dir) file = resolve(options.dir, this.id);
+			else file = resolve(this.id);
 
 			const decodedMap = magicString.generateDecodedMap({});
 			map = collapseSourcemaps(

src/finalisers/amd.ts

@@ -1,6 +1,7 @@
 import { Bundle as MagicStringBundle } from 'magic-string';
 import { NormalizedOutputOptions } from '../rollup/types';
 import { FinaliserOptions } from './index';
+import getCompleteAmdId from './shared/getCompleteAmdId';
 import { getExportBlock, getNamespaceMarkers } from './shared/getExportBlock';
 import getInteropBlock from './shared/getInteropBlock';
 import removeExtensionFromRelativeAmdId from './shared/removeExtensionFromRelativeAmdId';
@@ -13,6 +14,7 @@ export default function amd(
 		dependencies,
 		exports,
 		hasExports,
+		id,
 		indentString: t,
 		intro,
 		isEntryFacade,
@@ -23,7 +25,7 @@ export default function amd(
 		warn
 	}: FinaliserOptions,
 	{
-		amd: { define: amdDefine, id: amdId },
+		amd,
 		compact,
 		esModule,
 		externalLiveBindings,
@@ -55,8 +57,10 @@ export default function amd(
 		deps.unshift(`'module'`);
 	}
 
+	const completeAmdId = getCompleteAmdId(amd, id);
 	const params =
-		(amdId ? `'${amdId}',${_}` : ``) + (deps.length ? `[${deps.join(`,${_}`)}],${_}` : ``);
+		(completeAmdId ? `'${completeAmdId}',${_}` : ``) +
+		(deps.length ? `[${deps.join(`,${_}`)}],${_}` : ``);
 	const useStrict = strict ? `${_}'use strict';` : '';
 
 	magicString.prepend(
@@ -97,6 +101,6 @@ export default function amd(
 	magicString.append(`${exportBlock}${namespaceMarkers}${outro}`);
 	return magicString
 		.indent(t)
-		.prepend(`${amdDefine}(${params}function${_}(${args.join(`,${_}`)})${_}{${useStrict}${n}${n}`)
+		.prepend(`${amd.define}(${params}function${_}(${args.join(`,${_}`)})${_}{${useStrict}${n}${n}`)
 		.append(`${n}${n}});`);
 }

src/finalisers/index.ts

@@ -13,6 +13,7 @@ export interface FinaliserOptions {
 	dependencies: ChunkDependencies;
 	exports: ChunkExports;
 	hasExports: boolean;
+	id: string;
 	indentString: string;
 	intro: string;
 	isEntryFacade: boolean;

src/finalisers/shared/getCompleteAmdId.ts

@@ -0,0 +1,13 @@
+import { NormalizedOutputOptions } from '../../rollup/types';
+import removeJsExtension from './removeJsExtension';
+
+export default function getCompleteAmdId(
+	options: NormalizedOutputOptions['amd'],
+	chunkId: string
+): string {
+	if (!options.autoId) {
+		return options.id || '';
+	} else {
+		return `${options.basePath ? options.basePath + '/' : ''}${removeJsExtension(chunkId)}`;
+	}
+}

src/finalisers/shared/removeExtensionFromRelativeAmdId.ts

@@ -1,9 +1,8 @@
+import removeJsExtension from './removeJsExtension';
+
 // AMD resolution will only respect the AMD baseUrl if the .js extension is omitted.
 // The assumption is that this makes sense for all relative ids:
 // https://requirejs.org/docs/api.html#jsfiles
 export default function removeExtensionFromRelativeAmdId(id: string) {
-	if (id[0] === '.' && id.endsWith('.js')) {
-		return id.slice(0, -3);
-	}
-	return id;
+	return id[0] === '.' ? removeJsExtension(id) : id;
 }

src/finalisers/shared/removeJsExtension.ts

@@ -0,0 +1,3 @@
+export default function removeJsExtension(name: string) {
+	return name.endsWith('.js') ? name.slice(0, -3) : name;
+}

src/finalisers/umd.ts

@@ -2,6 +2,7 @@ import { Bundle as MagicStringBundle } from 'magic-string';
 import { NormalizedOutputOptions } from '../rollup/types';
 import { error } from '../utils/error';
 import { FinaliserOptions } from './index';
+import getCompleteAmdId from './shared/getCompleteAmdId';
 import { getExportBlock, getNamespaceMarkers } from './shared/getExportBlock';
 import getInteropBlock from './shared/getInteropBlock';
 import removeExtensionFromRelativeAmdId from './shared/removeExtensionFromRelativeAmdId';
@@ -29,6 +30,7 @@ export default function umd(
 		dependencies,
 		exports,
 		hasExports,
+		id,
 		indentString: t,
 		intro,
 		namedExportsMode,
@@ -37,7 +39,7 @@ export default function umd(
 		warn
 	}: FinaliserOptions,
 	{
-		amd: { define: amdDefine, id: amdId },
+		amd,
 		compact,
 		esModule,
 		extend,
@@ -90,10 +92,12 @@ export default function umd(
 		factoryArgs.unshift('exports');
 	}
 
+	const completeAmdId = getCompleteAmdId(amd, id);
 	const amdParams =
-		(amdId ? `'${amdId}',${_}` : ``) + (amdDeps.length ? `[${amdDeps.join(`,${_}`)}],${_}` : ``);
+		(completeAmdId ? `'${completeAmdId}',${_}` : ``) +
+		(amdDeps.length ? `[${amdDeps.join(`,${_}`)}],${_}` : ``);
 
-	const define = amdDefine;
+	const define = amd.define;
 	const cjsExport = !namedExportsMode && hasExports ? `module.exports${_}=${_}` : ``;
 	const useStrict = strict ? `${_}'use strict';${n}` : ``;