builder/lib/tasks/generateLibraryManifest.js

  2. import {getLogger} from "@ui5/logger";
  3. const log = getLogger("builder:tasks:generateLibraryManifest");
  4. import manifestCreator from "../processors/manifestCreator.js";
  6. /**
  7.  * @public
  8.  * @module @ui5/builder/tasks/generateLibraryManifest
  9.  */
  11. /**
  12.  * Task for creating a library manifest.json from its .library file.
  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/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
  21.  * @param {object} parameters.options Options
  22.  * @param {string} parameters.options.projectName Project name
  23.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  24.  */
  25. export default function({workspace, taskUtil, options: {projectName}}) {
  26. 	// Note:
  27. 	// *.library files are needed to identify libraries
  28. 	// *.json files are needed to avoid overwriting them
  29. 	// *.js files are needed to identify nested components
  30. 	// *.less, *.css, *.theming and *.theme files are needed to identify supported themes
  31. 	// *.properties to identify existence of i18n bundles (e.g. messagebundle.properties)
  32. 	return workspace.byGlob("/resources/**/*.{js,json,library,less,css,theming,theme,properties}").then((resources) => {
  33. 		// Find all libraries and create a manifest.json file
  34. 		return workspace.byGlob("/resources/**/.library").then((libraryIndicatorResources) => {
  35. 			if (libraryIndicatorResources.length < 1) {
  36. 				// No library found - nothing to do
  37. 				log.verbose(`Could not find a ".library" file for project ${projectName}. ` +
  38. 					`Skipping library manifest generation.`);
  39. 				return;
  40. 			}
  42. 			return Promise.all(libraryIndicatorResources.map((libraryIndicatorResource) => {
  43. 				// Determine library namespace from library indicator file path
  44. 				// ending with ".library"
  45. 				// e.g. /resources/sap/foo/.library => sap/foo
  46. 				const libraryNamespacePattern = /^\/resources\/(.*)\/\.library$/;
  47. 				const libraryIndicatorPath = libraryIndicatorResource.getPath();
  48. 				const libraryNamespaceMatch = libraryIndicatorPath.match(libraryNamespacePattern);
  49. 				if (libraryNamespaceMatch && libraryNamespaceMatch[1]) {
  50. 					const libraryNamespace = libraryNamespaceMatch[1];
  51. 					return manifestCreator({
  52. 						libraryResource: libraryIndicatorResource,
  53. 						namespace: libraryNamespace,
  54. 						resources,
  55. 						getProjectVersion: (projectName) => {
  56. 							return taskUtil?.getProject(projectName)?.getVersion();
  57. 						},
  58. 						options: {
  59. 						}
  60. 					}).then((manifest) => {
  61. 						if (manifest) {
  62. 							return workspace.write(manifest);
  63. 						}
  64. 					});
  65. 				} else {
  66. 					log.verbose(`Could not determine library namespace from file "${libraryIndicatorPath}" ` +
  67. 						`for project ${projectName}. Skipping library manifest generation.`);
  68. 					return Promise.resolve();
  69. 				}
  70. 			}));
  71. 		});
  72. 	});
  73. }