builder/lib/tasks/bundlers/generateBundle.js

  1. import moduleBundler from "../../processors/bundlers/moduleBundler.js";
  2. import createModuleNameMapping from "./utils/createModuleNameMapping.js";
  3. import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
  5. /**
  6.  * @public
  7.  * @module @ui5/builder/tasks/bundlers/generateBundle
  8.  */
  10. /* eslint-disable max-len */
  11. /**
  12.  * Generates a bundle based on the given bundle definition
  13.  *
  14.  * @public
  15.  * @function default
  16.  * @static
  17.  *
  18.  * @param {object} parameters Parameters
  19.  * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  20.  * @param {@ui5/fs/ReaderCollection} parameters.dependencies Collection to read dependency files
  21.  * @param {@ui5/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
  22.  * @param {object} parameters.options Options
  23.  * @param {string} parameters.options.projectName Project name
  24.  * @param {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleDefinition} parameters.options.bundleDefinition Module
  25.  * 			bundle definition
  26.  * @param {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleOptions} [parameters.options.bundleOptions] Module
  27.  * 			bundle options
  28.  * @returns {Promise} Promise resolving with <code>undefined</code> once data has been written
  29.  */
  30. /* eslint-enable max-len */
  31. export default async function({
  32. 	workspace, dependencies, taskUtil, options: {projectName, bundleDefinition, bundleOptions}
  33. }) {
  34. 	let combo = new ReaderCollectionPrioritized({
  35. 		name: `generateBundle - prioritize workspace over dependencies: ${projectName}`,
  36. 		readers: [workspace, dependencies]
  37. 	});
  39. 	const optimize = !bundleOptions || bundleOptions.optimize !== false;
  40. 	if (taskUtil) {
  41. 		/* Scenarios
  42. 			1. Optimize bundle with minification already done
  43. 				Workspace:
  44. 					* /resources/my/lib/Control.js 				[ui5:HasDebugVariant]
  45. 					* /resources/my/lib/Control.js.map 			[ui5:HasDebugVariant]
  46. 					* /resources/my/lib/Control-dbg.js 			[ui5:IsDebugVariant]
  48. 				Bundler input:
  49. 					* /resources/my/lib/Control.js
  50. 					* /resources/my/lib/Control.js.map
  52. 				=> Filter out debug resources
  54. 			2. Optimize bundle with no minification
  55. 				* /resources/my/lib/Control.js
  57. 				=> No action necessary
  59. 			3. Debug-bundle with minification already done
  60. 				Workspace:
  61. 					* /resources/my/lib/Control.js 				[ui5:HasDebugVariant]
  62. 					* /resources/my/lib/Control.js.map 			[ui5:HasDebugVariant]
  63. 					* /resources/my/lib/Control-dbg.js 			[ui5:IsDebugVariant]
  65. 				Bundler input:
  66. 					* /resources/my/lib/Control-dbg.js
  67. 					* moduleNameMapping: [{"/resources/my/lib/Control-dbg.js": "my/lib/Control.js"}]
  69. 				=> Filter out minified-resources (tagged as "HasDebugVariant", incl. source maps) and rename debug-files
  71. 			4. Debug-bundle with no minification
  72. 				* /resources/my/lib/Control.js
  74. 				=> No action necessary
  76. 			5. Bundle with external input (optimize or not), e.g. TS-project
  77. 				Workspace:
  78. 					* /resources/my/lib/Control.ts
  79. 					* /resources/my/lib/Control.js
  80. 					* /resources/my/lib/Control.js.map
  82. 				Bundler input:
  83. 					* /resources/my/lib/Control.js
  84. 					* /resources/my/lib/Control.js.map
  85. 		*/
  87. 		// Omit -dbg files for optimize bundles and vice versa
  88. 		const filterTag = optimize ?
  89. 			taskUtil.STANDARD_TAGS.IsDebugVariant : taskUtil.STANDARD_TAGS.HasDebugVariant;
  90. 		combo = taskUtil.resourceFactory.createFilterReader({
  91. 			reader: combo,
  92. 			callback: function(resource) {
  93. 				return !taskUtil.getTag(resource, filterTag);
  94. 			}
  95. 		});
  96. 	}
  98. 	return combo.byGlob("/resources/**/*.{js,json,xml,html,properties,library,js.map}").then((resources) => {
  99. 		const options = {bundleDefinition, bundleOptions};
  100. 		if (!optimize && taskUtil) {
  101. 			options.moduleNameMapping = createModuleNameMapping({resources, taskUtil});
  102. 		}
  103. 		return moduleBundler({options, resources}).then((bundles) => {
  104. 			return Promise.all(bundles.map(({bundle, sourceMap} = {}) => {
  105. 				if (!bundle) {
  106. 					// Skip empty bundles
  107. 					return;
  108. 				}
  109. 				if (taskUtil) {
  110. 					taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
  111. 					if (sourceMap) {
  112. 						// Clear tag that might have been set by the minify task, in cases where
  113. 						// the bundle name is identical to a source file
  114. 						taskUtil.clearTag(sourceMap, taskUtil.STANDARD_TAGS.OmitFromBuildResult);
  115. 					}
  116. 				}
  117. 				const writes = [workspace.write(bundle)];
  118. 				if (sourceMap) {
  119. 					writes.push(workspace.write(sourceMap));
  120. 				}
  121. 				return Promise.all(writes);
  122. 			}));
  123. 		});
  124. 	});
  125. }