project/lib/normalizer.js

  1. const log = require("@ui5/logger").getLogger("normalizer:normalizer");
  2. const projectPreprocessor = require("./projectPreprocessor");
  5. /**
  6.  * Generate project and dependency trees via translators.
  7.  * Optionally configure all projects with the projectPreprocessor.
  8.  *
  9.  * @public
  10.  * @namespace
  11.  * @alias module:@ui5/project.normalizer
  12.  */
  13. const Normalizer = {
  14. 	/**
  15. 	 * Generates a project and dependency tree via translators and configures all projects via the projectPreprocessor
  16. 	 *
  17. 	 * @public
  18. 	 * @param {object} [options]
  19. 	 * @param {string} [options.cwd] Current working directory
  20. 	 * @param {string} [options.configPath] Path to configuration file
  21. 	 * @param {string} [options.translatorName] Translator to use
  22. 	 * @param {object} [options.translatorOptions] Options to pass to translator
  23. 	 * @param {object} [options.frameworkOptions] Options to pass to the framework installer
  24. 	 * @param {string} [options.frameworkOptions.versionOverride] Framework version to use instead of the root projects
  25. 	 * framework
  26. 	 * @returns {Promise<object>} Promise resolving to tree object
  27. 	 */
  28. 	generateProjectTree: async function(options = {}) {
  29. 		let tree = await Normalizer.generateDependencyTree(options);
  31. 		if (options.configPath) {
  32. 			tree.configPath = options.configPath;
  33. 		}
  34. 		tree = await projectPreprocessor.processTree(tree);
  36. 		if (tree.framework) {
  37. 			const ui5Framework = require("./translators/ui5Framework");
  38. 			log.verbose(`Root project ${tree.metadata.name} defines framework ` +
  39. 				`configuration. Installing UI5 dependencies...`);
  40. 			let frameworkTree = await ui5Framework.generateDependencyTree(tree, options.frameworkOptions);
  41. 			if (frameworkTree) {
  42. 				frameworkTree = await projectPreprocessor.processTree(frameworkTree);
  43. 				ui5Framework.mergeTrees(tree, frameworkTree);
  44. 			}
  45. 		}
  46. 		return tree;
  47. 	},
  49. 	/**
  50. 	 * Generates a project and dependency tree via translators
  51. 	 *
  52. 	 * @public
  53. 	 * @param {object} [options]
  54. 	 * @param {string} [options.cwd=.] Current working directory
  55. 	 * @param {string} [options.translatorName=npm] Translator to use
  56. 	 * @param {object} [options.translatorOptions] Options to pass to translator
  57. 	 * @returns {Promise<object>} Promise resolving to tree object
  58. 	 */
  59. 	generateDependencyTree: async function({cwd = ".", translatorName="npm", translatorOptions={}} = {}) {
  60. 		log.verbose("Building dependency tree...");
  62. 		let translatorParams = [];
  63. 		let translator = translatorName;
  64. 		if (translatorName.indexOf(":") !== -1) {
  65. 			translatorParams = translatorName.split(":");
  66. 			translator = translatorParams[0];
  67. 			translatorParams = translatorParams.slice(1);
  68. 		}
  70. 		let translatorModule;
  71. 		switch (translator) {
  72. 		case "static":
  73. 			translatorModule = require("./translators/static");
  74. 			break;
  75. 		case "npm":
  76. 			translatorModule = require("./translators/npm");
  77. 			break;
  78. 		default:
  79. 			return Promise.reject(new Error(`Unknown translator ${translator}`));
  80. 		}
  82. 		translatorOptions.parameters = translatorParams;
  83. 		return translatorModule.generateDependencyTree(cwd, translatorOptions);
  84. 	}
  85. };
  87. module.exports = Normalizer;