builder/lib/tasks/replaceCopyright.js

  1. const stringReplacer = require("../processors/stringReplacer");
  3. /**
  4.  * Task to to replace the copyright.
  5.  *
  6.  * The following placeholders are replaced with corresponding values:
  7.  * <ul>
  8.  * 	<li>${copyright}</li>
  9.  * 	<li>@copyright@</li>
  10.  * </ul>
  11.  *
  12.  * If the copyright string contains the optional placeholder ${currentYear}
  13.  * it will be replaced with the current year.
  14.  * If no copyright string is given, no replacement is being done.
  15.  *
  16.  * @public
  17.  * @alias module:@ui5/builder.tasks.replaceCopyright
  18.  * @param {object} parameters Parameters
  19.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  20.  * @param {object} parameters.options Options
  21.  * @param {string} parameters.options.copyright Replacement copyright
  22.  * @param {string} parameters.options.pattern Pattern to locate the files to be processed
  23.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  24.  */
  25. module.exports = function({workspace, options: {copyright, pattern}}) {
  26. 	if (!copyright) {
  27. 		return Promise.resolve();
  28. 	}
  30. 	// Replace optional placeholder ${currentYear} with the current year
  31. 	copyright = copyright.replace(/(?:\$\{currentYear\})/, new Date().getFullYear());
  33. 	return workspace.byGlob(pattern)
  34. 		.then((processedResources) => {
  35. 			return stringReplacer({
  36. 				resources: processedResources,
  37. 				options: {
  38. 					pattern: /(?:\$\{copyright\}|@copyright@)/g,
  39. 					replacement: copyright
  40. 				}
  41. 			});
  42. 		})
  43. 		.then((processedResources) => {
  44. 			return Promise.all(processedResources.map((resource) => {
  45. 				return workspace.write(resource);
  46. 			}));
  47. 		});
  48. };