builder/lib/tasks/buildThemes.js

  1. const path = require("path");
  2. const themeBuilder = require("../processors/themeBuilder");
  3. const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
  4. const fsInterface = require("@ui5/fs").fsInterface;
  5. const log = require("@ui5/logger").getLogger("builder:tasks:buildThemes");
  7. /**
  8.  * Task to build a library theme.
  9.  *
  10.  * @public
  11.  * @alias module:@ui5/builder.tasks.buildThemes
  12.  * @param {object} parameters Parameters
  13.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  14.  * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  15.  * @param {object} parameters.options Options
  16.  * @param {string} parameters.options.projectName Project name
  17.  * @param {string} parameters.options.inputPattern Search pattern for *.less files to be built
  18.  * @param {string} [parameters.options.librariesPattern] Search pattern for .library files
  19.  * @param {string} [parameters.options.themesPattern] Search pattern for sap.ui.core theme folders
  20.  * @param {boolean} [parameters.options.compress=true]
  21.  * @param {boolean} [parameters.options.cssVariables=false]
  22.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  23.  */
  24. module.exports = async function({
  25. 	workspace, dependencies,
  26. 	options: {
  27. 		projectName, inputPattern, librariesPattern, themesPattern, compress, cssVariables
  28. 	}
  29. }) {
  30. 	const combo = new ReaderCollectionPrioritized({
  31. 		name: `theme - prioritize workspace over dependencies: ${projectName}`,
  32. 		readers: [workspace, dependencies]
  33. 	});
  35. 	compress = compress === undefined ? true : compress;
  37. 	const pAllResources = workspace.byGlob(inputPattern);
  38. 	let pAvailableLibraries;
  39. 	let pAvailableThemes;
  40. 	if (librariesPattern) {
  41. 		// If a librariesPattern is given
  42. 		//	we will use it to reduce the set of libraries a theme will be built for
  43. 		pAvailableLibraries = combo.byGlob(librariesPattern);
  44. 	}
  45. 	if (themesPattern) {
  46. 		// If a themesPattern is given
  47. 		//	we will use it to reduce the set of themes that will be built
  48. 		pAvailableThemes = combo.byGlob(themesPattern, {nodir: false});
  49. 	}
  51. 	/* Don't try to build themes for libraries that are not available
  52. 	(maybe replace this with something more aware of which dependencies are optional and therefore
  53. 		legitimately missing and which not (fault case))
  54. 		*/
  55. 	let availableLibraries;
  56. 	if (pAvailableLibraries) {
  57. 		availableLibraries = [];
  58. 		(await pAvailableLibraries).forEach((resource) => {
  59. 			const library = path.dirname(resource.getPath());
  60. 			if (!availableLibraries.includes(library)) {
  61. 				availableLibraries.push(library);
  62. 			}
  63. 		});
  64. 	}
  65. 	let availableThemes;
  66. 	if (pAvailableThemes) {
  67. 		availableThemes = (await pAvailableThemes)
  68. 			.filter((resource) => resource.getStatInfo().isDirectory())
  69. 			.map((resource) => {
  70. 				return path.basename(resource.getPath());
  71. 			});
  72. 	}
  74. 	let allResources = await pAllResources;
  76. 	const isAvailable = function(resource) {
  77. 		let libraryAvailable = false;
  78. 		let themeAvailable = false;
  79. 		const resourcePath = resource.getPath();
  80. 		const themeName = path.basename(path.dirname(resourcePath));
  82. 		if (!availableLibraries || availableLibraries.length === 0) {
  83. 			libraryAvailable = true; // If no libraries are found, build themes for all libraries
  84. 		} else {
  85. 			for (let i = availableLibraries.length - 1; i >= 0; i--) {
  86. 				if (resourcePath.startsWith(availableLibraries[i])) {
  87. 					libraryAvailable = true;
  88. 				}
  89. 			}
  90. 		}
  92. 		if (!availableThemes || availableThemes.length === 0) {
  93. 			themeAvailable = true; // If no themes are found, build all themes
  94. 		} else {
  95. 			themeAvailable = availableThemes.includes(themeName);
  96. 		}
  98. 		if (log.isLevelEnabled("verbose")) {
  99. 			if (!libraryAvailable) {
  100. 				log.verbose(`Skipping ${resourcePath}: Library is not available`);
  101. 			}
  102. 			if (!themeAvailable) {
  103. 				log.verbose(`Skipping ${resourcePath}: sap.ui.core theme '${themeName}' is not available. ` +
  104. 				"If you experience missing themes, check whether you have added the corresponding theme " +
  105. 				"library to your projects dependencies and make sure that your custom themes contain " +
  106. 				"resources for the sap.ui.core namespace.");
  107. 			}
  108. 		}
  110. 		// Only build if library and theme are available
  111. 		return libraryAvailable && themeAvailable;
  112. 	};
  114. 	if (availableLibraries || availableThemes) {
  115. 		if (log.isLevelEnabled("verbose")) {
  116. 			log.verbose("Filtering themes to be built:");
  117. 			if (availableLibraries) {
  118. 				log.verbose(`Available libraries: ${availableLibraries.join(", ")}`);
  119. 			}
  120. 			if (availableThemes) {
  121. 				log.verbose(`Available sap.ui.core themes: ${availableThemes.join(", ")}`);
  122. 			}
  123. 		}
  124. 		allResources = allResources.filter(isAvailable);
  125. 	}
  127. 	const processedResources = await themeBuilder({
  128. 		resources: allResources,
  129. 		fs: fsInterface(combo),
  130. 		options: {
  131. 			compress,
  132. 			cssVariables: !!cssVariables
  133. 		}
  134. 	});
  136. 	await Promise.all(processedResources.map((resource) => {
  137. 		return workspace.write(resource);
  138. 	}));
  139. };