builder/lib/tasks/generateResourcesJson.js

  1. "use strict";
  3. const resourceListCreator = require("../processors/resourceListCreator");
  5. const DEFAULT_EXCLUDES = [
  6. 	/*
  7. 	 * exclude mac metadata files
  8. 	 */
  9. 	"!**/.DS_Store",
  10. 	/*
  11. 	 * sap-ui-version.json is not part of the resources
  12. 	 */
  13. 	"!/resources/sap-ui-version.json"
  14. ];
  16. function getCreatorOptions(projectName) {
  17. 	const creatorOptions = {};
  18. 	// TODO: Move configuration into ui5.yaml
  19. 	if ( projectName === "sap.ui.core" ) {
  20. 		Object.assign(creatorOptions, {
  21. 			externalResources: {
  22. 				"sap/ui/core": [
  23. 					"*",
  24. 					"sap/base/",
  25. 					"sap/ui/"
  26. 				]
  27. 			}
  28. 		});
  29. 	} else if ( projectName === "sap.ui.integration" ) {
  30. 		Object.assign(creatorOptions, {
  31. 			externalResources: {
  32. 				"sap/ui/integration": [
  33. 					"sap-ui-integration*.js",
  34. 				]
  35. 			}
  36. 		});
  37. 	}
  38. 	return creatorOptions;
  39. }
  41. /**
  42.  * Task for creating a resources.json file, describing all productive build resources.
  43.  *
  44.  * <p>
  45.  * The detailed structure can be found in the documentation:
  46.  * {@link https://sdk.openui5.org/topic/adcbcf8b50924556ab3f321fcd9353ea}
  47.  * </p>
  48.  *
  49.  * <p>
  50.  * Not supported in combination with task {@link module:@ui5/builder.tasks.generateStandaloneAppBundle}.
  51.  * Therefore it is also not supported in combination with self-contained build.
  52.  * </p>
  53.  *
  54.  * @example <caption>sample resources.json</caption>
  55.  * const resourcesJson = {
  56.  * 	"_version": "1.1.0",
  57.  * 	"resources": [
  58.  * 		{
  59.  * 			"name": "Component-preload.js",
  60.  * 			"module": "application/mine/Component-preload.js",
  61.  * 			"size": 3746,
  62.  * 			"merged": true,
  63.  * 			"included": [
  64.  * 				"application/mine/Component.js",
  65.  * 				"application/mine/changes/coding/MyExtension.js",
  66.  * 				"application/mine/changes/flexibility-bundle.json",
  67.  * 				"application/mine/changes/fragments/MyFragment.fragment.xml",
  68.  * 				"application/mine/manifest.json"
  69.  * 			]
  70.  * 		},
  71.  * 		{
  72.  * 			"name": "resources.json",
  73.  * 			"size": 1870
  74.  * 		},
  75.  * 		{
  76.  * 			"name": "rules/Button-dbg.support.js",
  77.  * 			"module": "application/mine/rules/Button.support.js",
  78.  * 			"size": 211,
  79.  * 			"format": "raw",
  80.  * 			"isDebug": true,
  81.  * 			"required": [
  82.  * 				"application/mine/library.js",
  83.  * 				"sap/ui/core/Control.js"
  84.  * 			],
  85.  * 			"condRequired": [
  86.  * 				"application/mine/changeHandler/SplitButton.js",
  87.  * 				"sap/ui/core/format/DateFormat.js"
  88.  * 			],
  89.  * 			"dynRequired": true,
  90.  * 			"support": true
  91.  * 		}
  92.  * 	]
  93.  * };
  94.  *
  95.  * @public
  96.  * @alias module:@ui5/builder.tasks.generateResourcesJson
  97.  * @param {object} parameters Parameters
  98.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  99.  * @param {module:@ui5/fs.AbstractReader} [parameters.dependencies] Reader or Collection to read dependency files
  100.  * @param {object} parameters.options Options
  101.  * @param {string} parameters.options.projectName Project name
  102.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  103.  */
  104. module.exports = async function({workspace, dependencies, options: {projectName}}) {
  105. 	const resources = await workspace.byGlob(["/resources/**/*"].concat(DEFAULT_EXCLUDES));
  107. 	// TODO 3.0: Make dependencies parameter mandatory
  108. 	let dependencyResources;
  109. 	if (dependencies) {
  110. 		dependencyResources =
  111. 			await dependencies.byGlob("/resources/**/*.{js,json,xml,html,properties,library}");
  112. 	}
  114. 	const resourceLists = await resourceListCreator({
  115. 		resources,
  116. 		dependencyResources,
  117. 		options: getCreatorOptions(projectName),
  118. 	});
  119. 	await Promise.all(
  120. 		resourceLists.map((resourceList) => workspace.write(resourceList))
  121. 	);
  122. };