project/lib/graph/providers/DependencyTree.js

  1. /**
  2.  * Tree node
  3.  *
  4.  * @public
  5.  * @class
  6.  * @typedef {object} @ui5/project/graph/providers/DependencyTree~TreeNode
  7.  * @property {string} node.id Unique ID for the project
  8.  * @property {string} node.version Version of the project
  9.  * @property {string} node.path File System path to access the projects resources
  10.  * @property {object|object[]} [node.configuration]
  11.  *	Configuration object or array of objects to use instead of reading from a configuration file
  12.  * @property {string} [node.configPath] Configuration file to use instead the default ui5.yaml
  13.  * @property {@ui5/project/graph/providers/DependencyTree~TreeNode[]} dependencies
  14.  */
  16. /**
  17.  * Helper module to create a [@ui5/project/graph/ProjectGraph]{@link @ui5/project/graph/ProjectGraph}
  18.  * from a dependency tree as returned by translators.
  19.  *
  20.  * @public
  21.  * @class
  22.  * @alias @ui5/project/graph/providers/DependencyTree
  23.  */
  24. class DependencyTree {
  25. 	/**
  26. 	 * @param {object} options
  27. 	 * @param {@ui5/project/graph/providers/DependencyTree~TreeNode} options.dependencyTree
  28.  	 * 		Dependency tree as returned by a translator
  29. 	 * @param {object} [options.rootConfiguration]
  30. 	 *		Configuration object to use for the root module instead of reading from a configuration file
  31. 	 * @param {string} [options.rootConfigPath]
  32. 	 *		Configuration file to use for the root module instead the default ui5.yaml
  33. 	 */
  34. 	constructor({dependencyTree, rootConfiguration, rootConfigPath}) {
  35. 		if (!dependencyTree) {
  36. 			throw new Error(`Failed to instantiate DependencyTree provider: Missing parameter 'dependencyTree'`);
  37. 		}
  38. 		this._tree = dependencyTree;
  39. 		if (rootConfiguration) {
  40. 			this._tree.configuration = rootConfiguration;
  41. 		}
  42. 		if (rootConfigPath) {
  43. 			this._tree.configPath = rootConfigPath;
  44. 		}
  45. 	}
  47. 	async getRootNode() {
  48. 		return this._tree;
  49. 	}
  51. 	async getDependencies(node) {
  52. 		if (node.deduped || !node.dependencies) {
  53. 			return [];
  54. 		}
  55. 		return node.dependencies;
  56. 	}
  57. }
  59. export default DependencyTree;