builder/lib/tasks/replaceCopyright.js

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