Add ImportAttributesKey to choose keyword ("with" | "assert") (#5474)

* Add ImportAttributesKey to choose keyword ("with" | "assert") * Revert settings.json change * Added documentation for importAttributesKey * Revert wasm bindings * Fix lint issue * Remove space * Revert bindings_wasm_bg.wasm.d.ts * Revert test/form/index.js --------- Co-authored-by: Lukas Taegert-Atkinson <lukastaegert@users.noreply.github.com>
rollup · Apr 20, 2024 · f24679e · f24679e
1 parent 0bf4675
commit f24679e
Show file tree

Hide file tree

Showing 35 changed files with 667 additions and 6 deletions.
diff --git a/cli/help.md b/cli/help.md
@@ -50,6 +50,7 @@ Basic options:
 --generatedCode.symbols     Use symbols in generated code
 --hashCharacters <name>     Use the specified character set for file hashes
 --no-hoistTransitiveImports Do not hoist transitive imports into entry chunks
+--importAttributesKey <name> Use the specified keyword for import attributes
 --no-indent                 Don't indent result
 --inlineDynamicImports      Create single bundle when using dynamic imports
 --no-interop                Do not include interop block

diff --git a/docs/command-line-interface/index.md b/docs/command-line-interface/index.md
@@ -97,6 +97,7 @@ export default {
 		generatedCode,
 		hashCharacters,
 		hoistTransitiveImports,
+		importAttributesKey,
 		inlineDynamicImports,
 		interop,
 		intro,
@@ -417,6 +418,7 @@ Many options have command line equivalents. In those cases, any arguments passed
 --generatedCode.symbols     Use symbols in generated code
 --hashCharacters <name>     Use the specified character set for file hashes
 --no-hoistTransitiveImports Do not hoist transitive imports into entry chunks
+--importAttributesKey <name> Use the specified keyword for import attributes
 --no-indent                 Don't indent result
 --inlineDynamicImports      Create single bundle when using dynamic imports
 --no-interop                Do not include interop block

diff --git a/docs/configuration-options/index.md b/docs/configuration-options/index.md
@@ -930,6 +930,16 @@ This determines the character set that Rollup is allowed to use in file hashes.
 
 By default, when creating multiple chunks, transitive imports of entry chunks will be added as empty imports to the entry chunks. See ["Why do additional imports turn up in my entry chunks when code-splitting?"](../faqs/index.md#why-do-additional-imports-turn-up-in-my-entry-chunks-when-code-splitting) for details and background. Setting this option to `false` will disable this behaviour. This option is ignored when using the [`output.preserveModules`](#output-preservemodules) option as here, imports will never be hoisted.
 
+### output.importAttributesKey
+
+|          |                                |
+| -------: | :----------------------------- |
+|    Type: | `"with" \| "assert"`           |
+|     CLI: | `--importAttributesKey <name>` |
+| Default: | `"assert"`                     |
+
+This determines the keyword set that Rollup will use for import attributes.
+
 ### output.inlineDynamicImports
 
 |          |                                                      |

diff --git a/docs/javascript-api/index.md b/docs/javascript-api/index.md
@@ -196,6 +196,7 @@ const outputOptions = {
 	generatedCode,
 	hashCharacters,
 	hoistTransitiveImports,
+	importAttributesKey,
 	inlineDynamicImports,
 	interop,
 	intro,

diff --git a/docs/repl/stores/options.ts b/docs/repl/stores/options.ts
@@ -252,6 +252,11 @@ export const useOptions = defineStore('options2', () => {
 		defaultValue: true,
 		name: 'output.hoistTransitiveImports'
 	});
+	const optionOutputImportAttributesKey = getSelect({
+		defaultValue: 'assert',
+		name: 'output.importAttributesKey',
+		options: () => ['with', 'assert']
+	});
 	const optionOutputIndent = getBoolean({
 		available: () => ['amd', 'iife', 'umd', 'system'].includes(optionOutputFormat.value.value!),
 		defaultValue: true,
@@ -445,6 +450,7 @@ export const useOptions = defineStore('options2', () => {
 		optionOutputGlobals,
 		optionOutputHashCharacters,
 		optionOutputHoistTransitiveImports,
+		optionOutputImportAttributesKey,
 		optionOutputIndent,
 		optionOutputInlineDynamicImports,
 		optionOutputInterop,

diff --git a/src/finalisers/es.ts b/src/finalisers/es.ts
@@ -1,6 +1,6 @@
 import type { Bundle as MagicStringBundle } from 'magic-string';
 import type { ChunkDependency, ChunkExports, ImportSpecifier, ReexportSpecifier } from '../Chunk';
-import type { NormalizedOutputOptions } from '../rollup/types';
+import type { ImportAttributesKey, NormalizedOutputOptions } from '../rollup/types';
 import type { GenerateCodeSnippets } from '../utils/generateCodeSnippets';
 import { stringifyIdentifierIfNeeded } from '../utils/identifierHelpers';
 import { getHelpersBlock } from '../utils/interopHelpers';
@@ -9,11 +9,16 @@ import type { FinaliserOptions } from './index';
 export default function es(
 	magicString: MagicStringBundle,
 	{ accessedGlobals, indent: t, intro, outro, dependencies, exports, snippets }: FinaliserOptions,
-	{ externalLiveBindings, freeze, generatedCode: { symbols } }: NormalizedOutputOptions
+	{
+		externalLiveBindings,
+		freeze,
+		generatedCode: { symbols },
+		importAttributesKey
+	}: NormalizedOutputOptions
 ): void {
 	const { n } = snippets;
 
-	const importBlock = getImportBlock(dependencies, snippets);
+	const importBlock = getImportBlock(dependencies, importAttributesKey, snippets);
 	if (importBlock.length > 0) intro += importBlock.join(n) + n + n;
 	intro += getHelpersBlock(
 		null,
@@ -35,11 +40,12 @@ export default function es(
 
 function getImportBlock(
 	dependencies: readonly ChunkDependency[],
+	importAttributesKey: ImportAttributesKey,
 	{ _ }: GenerateCodeSnippets
 ): string[] {
 	const importBlock: string[] = [];
 	for (const { importPath, reexports, imports, name, attributes } of dependencies) {
-		const assertion = attributes ? `${_}assert${_}${attributes}` : '';
+		const assertion = attributes ? `${_}${importAttributesKey}${_}${attributes}` : '';
 		const pathWithAssertion = `'${importPath}'${assertion};`;
 		if (!reexports && !imports) {
 			importBlock.push(`import${_}${pathWithAssertion}`);

diff --git a/src/rollup/types.d.ts b/src/rollup/types.d.ts
@@ -623,6 +623,7 @@ export interface NormalizedInputOptions {
 }
 
 export type InternalModuleFormat = 'amd' | 'cjs' | 'es' | 'iife' | 'system' | 'umd';
+export type ImportAttributesKey = 'with' | 'assert';
 
 export type ModuleFormat = InternalModuleFormat | 'commonjs' | 'esm' | 'module' | 'systemjs';
 
@@ -712,6 +713,7 @@ export interface OutputOptions {
 	globals?: GlobalsOption;
 	hashCharacters?: HashCharacters;
 	hoistTransitiveImports?: boolean;
+	importAttributesKey?: ImportAttributesKey;
 	indent?: string | boolean;
 	inlineDynamicImports?: boolean;
 	interop?: InteropType | GetInterop;
@@ -764,6 +766,7 @@ export interface NormalizedOutputOptions {
 	globals: GlobalsOption;
 	hashCharacters: HashCharacters;
 	hoistTransitiveImports: boolean;
+	importAttributesKey: ImportAttributesKey;
 	indent: true | string;
 	inlineDynamicImports: boolean;
 	interop: GetInterop;

diff --git a/src/utils/options/mergeOptions.ts b/src/utils/options/mergeOptions.ts
@@ -254,6 +254,7 @@ async function mergeOutputOptions(
 		globals: getOption('globals'),
 		hashCharacters: getOption('hashCharacters'),
 		hoistTransitiveImports: getOption('hoistTransitiveImports'),
+		importAttributesKey: getOption('importAttributesKey'),
 		indent: getOption('indent'),
 		inlineDynamicImports: getOption('inlineDynamicImports'),
 		interop: getOption('interop'),

diff --git a/src/utils/options/normalizeOutputOptions.ts b/src/utils/options/normalizeOutputOptions.ts
@@ -71,6 +71,7 @@ export async function normalizeOutputOptions(
 		globals: config.globals || {},
 		hashCharacters: config.hashCharacters ?? 'base64',
 		hoistTransitiveImports: config.hoistTransitiveImports ?? true,
+		importAttributesKey: config.importAttributesKey ?? 'assert',
 		indent: getIndent(config, compact),
 		inlineDynamicImports,
 		interop: getInterop(config),

diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_config.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_config.js
@@ -0,0 +1,14 @@
+module.exports = defineTest({
+	description: 'keeps any import attributes on input using import attributes with "with" key',
+	expectedWarnings: ['UNRESOLVED_IMPORT'],
+	options: {
+		external: id => {
+			if (id === 'unresolved') return null;
+			return true;
+		},
+		output: {
+			name: 'bundle',
+			importAttributesKey: 'assert'
+		}
+	}
+});
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/amd.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/amd.js
@@ -0,0 +1,35 @@
+define(['exports', 'a', 'b', 'c', 'd', 'unresolved'], (function (exports, a, b, c, d$1, unresolved) { 'use strict';
+
+	function _interopNamespaceDefault(e) {
+		var n = Object.create(null);
+		if (e) {
+			Object.keys(e).forEach(function (k) {
+				if (k !== 'default') {
+					var d = Object.getOwnPropertyDescriptor(e, k);
+					Object.defineProperty(n, k, d.get ? d : {
+						enumerable: true,
+						get: function () { return e[k]; }
+					});
+				}
+			});
+		}
+		n.default = e;
+		return Object.freeze(n);
+	}
+
+	var b__namespace = /*#__PURE__*/_interopNamespaceDefault(b);
+
+	console.log(a.a, b__namespace, d);
+
+	Object.defineProperty(exports, "c", {
+		enumerable: true,
+		get: function () { return c.c; }
+	});
+	Object.keys(d$1).forEach(function (k) {
+		if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+			enumerable: true,
+			get: function () { return d$1[k]; }
+		});
+	});
+
+}));
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/cjs.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/cjs.js
@@ -0,0 +1,39 @@
+'use strict';
+
+var a = require('a');
+var b = require('b');
+var c = require('c');
+var d$1 = require('d');
+require('unresolved');
+
+function _interopNamespaceDefault(e) {
+	var n = Object.create(null);
+	if (e) {
+		Object.keys(e).forEach(function (k) {
+			if (k !== 'default') {
+				var d = Object.getOwnPropertyDescriptor(e, k);
+				Object.defineProperty(n, k, d.get ? d : {
+					enumerable: true,
+					get: function () { return e[k]; }
+				});
+			}
+		});
+	}
+	n.default = e;
+	return Object.freeze(n);
+}
+
+var b__namespace = /*#__PURE__*/_interopNamespaceDefault(b);
+
+console.log(a.a, b__namespace, d);
+
+Object.defineProperty(exports, "c", {
+	enumerable: true,
+	get: function () { return c.c; }
+});
+Object.keys(d$1).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return d$1[k]; }
+	});
+});
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/es.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/es.js
@@ -0,0 +1,7 @@
+import { a } from 'a' assert { type: 'a', extra: 'extra' };
+import * as b from 'b' assert { type: 'b' };
+export { c } from 'c' assert { type: 'c' };
+export * from 'd' assert { type: 'd' };
+import 'unresolved' assert { type: 'e' };
+
+console.log(a, b, d);
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/iife.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/iife.js
@@ -0,0 +1,38 @@
+var bundle = (function (exports, a, b, c, d$1) {
+	'use strict';
+
+	function _interopNamespaceDefault(e) {
+		var n = Object.create(null);
+		if (e) {
+			Object.keys(e).forEach(function (k) {
+				if (k !== 'default') {
+					var d = Object.getOwnPropertyDescriptor(e, k);
+					Object.defineProperty(n, k, d.get ? d : {
+						enumerable: true,
+						get: function () { return e[k]; }
+					});
+				}
+			});
+		}
+		n.default = e;
+		return Object.freeze(n);
+	}
+
+	var b__namespace = /*#__PURE__*/_interopNamespaceDefault(b);
+
+	console.log(a.a, b__namespace, d);
+
+	Object.defineProperty(exports, "c", {
+		enumerable: true,
+		get: function () { return c.c; }
+	});
+	Object.keys(d$1).forEach(function (k) {
+		if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+			enumerable: true,
+			get: function () { return d$1[k]; }
+		});
+	});
+
+	return exports;
+
+})({}, a, b, c, d$1);
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/system.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/system.js
@@ -0,0 +1,29 @@
+System.register('bundle', ['a', 'b', 'c', 'd', 'unresolved'], (function (exports) {
+	'use strict';
+	var _starExcludes = {
+		__proto__: null,
+		default: 1,
+		c: 1
+	};
+	var a, b;
+	return {
+		setters: [function (module) {
+			a = module.a;
+		}, function (module) {
+			b = module;
+		}, function (module) {
+			exports("c", module.c);
+		}, function (module) {
+			var setter = { __proto__: null };
+			for (var name in module) {
+				if (!_starExcludes[name]) setter[name] = module[name];
+			}
+			exports(setter);
+		}, null],
+		execute: (function () {
+
+			console.log(a, b, d);
+
+		})
+	};
+}));
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/umd.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/_expected/umd.js
@@ -0,0 +1,39 @@
+(function (global, factory) {
+	typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('a'), require('b'), require('c'), require('d'), require('unresolved')) :
+	typeof define === 'function' && define.amd ? define(['exports', 'a', 'b', 'c', 'd', 'unresolved'], factory) :
+	(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.bundle = {}, global.a, global.b, global.c, global.d$1));
+})(this, (function (exports, a, b, c, d$1) { 'use strict';
+
+	function _interopNamespaceDefault(e) {
+		var n = Object.create(null);
+		if (e) {
+			Object.keys(e).forEach(function (k) {
+				if (k !== 'default') {
+					var d = Object.getOwnPropertyDescriptor(e, k);
+					Object.defineProperty(n, k, d.get ? d : {
+						enumerable: true,
+						get: function () { return e[k]; }
+					});
+				}
+			});
+		}
+		n.default = e;
+		return Object.freeze(n);
+	}
+
+	var b__namespace = /*#__PURE__*/_interopNamespaceDefault(b);
+
+	console.log(a.a, b__namespace, d);
+
+	Object.defineProperty(exports, "c", {
+		enumerable: true,
+		get: function () { return c.c; }
+	});
+	Object.keys(d$1).forEach(function (k) {
+		if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+			enumerable: true,
+			get: function () { return d$1[k]; }
+		});
+	});
+
+}));
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-assert/main.js b/test/form/samples/import-attributes/keeps-static-attributes-key-assert/main.js
@@ -0,0 +1,9 @@
+import { a } from 'a' with { type: 'a', extra: 'extra' };
+import * as b from 'b' with { type: 'b' };
+export { c } from 'c' with { type: 'c' };
+export * from 'd' with { type: 'd' };
+import 'unresolved' with { type: 'e' };
+
+console.log(a, b, d);
+
+
diff --git a/test/form/samples/import-attributes/keeps-static-attributes-key-default/_config.js b/test/form/samples/import-attributes/keeps-static-attributes-key-default/_config.js
@@ -0,0 +1,13 @@
+module.exports = defineTest({
+	description: 'keeps any import attributes on input using import attributes with "with" key',
+	expectedWarnings: ['UNRESOLVED_IMPORT'],
+	options: {
+		external: id => {
+			if (id === 'unresolved') return null;
+			return true;
+		},
+		output: {
+			name: 'bundle'
+		}
+	}
+});