builder/lib/tasks/generateLibraryManifest.js

  1. "use strict";
  3. const log = require("@ui5/logger").getLogger("builder:tasks:generateLibraryManifest");
  4. const manifestCreator = require("../processors/manifestCreator");
  5. const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
  8. /**
  9.  * Task for creating a library manifest.json from its .library file.
  10.  *
  11.  * @public
  12.  * @alias module:@ui5/builder.tasks.generateLibraryManifest
  13.  * @param {object} parameters Parameters
  14.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  15.  * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  16.  * @param {object} parameters.options Options
  17.  * @param {string} parameters.options.projectName Project name
  18.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  19.  */
  20. module.exports = function({workspace, dependencies, options: {projectName}}) {
  21. 	const combo = new ReaderCollectionPrioritized({
  22. 		name: `libraryManifestGenerator - prioritize workspace over dependencies: ${projectName}`,
  23. 		readers: [workspace, dependencies]
  24. 	});
  25. 	// Note:
  26. 	// *.library files are needed to identify libraries
  27. 	// *.json files are needed to avoid overwriting them
  28. 	// *.js files are needed to identify nested components
  29. 	// *.less, *.css, *.theming and *.theme files are needed to identify supported themes
  30. 	// *.properties to identify existence of i18n bundles (e.g. messagebundle.properties)
  31. 	return combo.byGlob("/**/*.{js,json,library,less,css,theming,theme,properties}").then((resources) => {
  32. 		// Find all libraries and create a manifest.json file
  33. 		return workspace.byGlob("/resources/**/.library").then((libraryIndicatorResources) => {
  34. 			if (libraryIndicatorResources.length < 1) {
  35. 				// No library found - nothing to do
  36. 				log.verbose(`Could not find a ".library" file for project ${projectName}. ` +
  37. 					`Skipping library manifest generation.`);
  38. 				return;
  39. 			}
  41. 			return Promise.all(libraryIndicatorResources.map((libraryIndicatorResource) => {
  42. 				// Determine library namespace from library indicator file path
  43. 				// ending with ".library"
  44. 				// e.g. /resources/sap/foo/.library => sap/foo
  45. 				const libraryNamespacePattern = /^\/resources\/(.*)\/\.library$/;
  46. 				const libraryIndicatorPath = libraryIndicatorResource.getPath();
  47. 				const libraryNamespaceMatch = libraryIndicatorPath.match(libraryNamespacePattern);
  48. 				if (libraryNamespaceMatch && libraryNamespaceMatch[1]) {
  49. 					const libraryNamespace = libraryNamespaceMatch[1];
  50. 					return manifestCreator({
  51. 						libraryResource: libraryIndicatorResource,
  52. 						namespace: libraryNamespace,
  53. 						resources,
  54. 						options: {
  55. 						}
  56. 					}).then((manifest) => {
  57. 						if (manifest) {
  58. 							return workspace.write(manifest);
  59. 						}
  60. 					});
  61. 				} else {
  62. 					log.verbose(`Could not determine library namespace from file "${libraryIndicatorPath}" ` +
  63. 						`for project ${projectName}. Skipping library manifest generation.`);
  64. 					return Promise.resolve();
  65. 				}
  66. 			}));
  67. 		});
  68. 	});
  69. };