builder/lib/tasks/generateResourcesJson.js

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