@ui5/project/graph

Helper module to create a @ui5/project/graph/ProjectGraph from a directory

Description:

Source:

Description:

Source:

Name Type Description

options

object

Name	Type	Attributes	Default	Description
`dependencyTree`	@ui5/project/graph/providers/DependencyTree~TreeNode
`cwd`	string	<optional>	`process.cwd()`	Directory to resolve relative paths to
`rootConfiguration`	object	<optional>		Configuration object to use for the root module instead of reading from a configuration file
`rootConfigPath`	string	<optional>		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to `cwd` or an absolute path. In both case, platform-specific path segment separators must be used.
`versionOverride`	string	<optional>		Framework version to use instead of the one defined in the root project
`cacheMode`	module:@ui5/project/ui5Framework/maven/CacheMode	<optional>		Cache mode to use when consuming SNAPSHOT versions of a framework
`resolveFrameworkDependencies`	string	<optional>	`true`	Whether framework dependencies should be added to the graph

Promise resolving to a Project Graph instance

Description:

Generates a @ui5/project/graph/ProjectGraph by resolving dependencies from package.json files and configuring projects from ui5.yaml files

Source:

Name Type Attributes Description

options

object

Name	Type	Attributes	Default	Description
`cwd`	string	<optional>	`process.cwd()`	Directory to start searching for the root module
`rootConfiguration`	object	<optional>		Configuration object to use for the root module instead of reading from a configuration file
`rootConfigPath`	string	<optional>		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to `cwd` or an absolute path. In both case, platform-specific path segment separators must be used.
`versionOverride`	string	<optional>		Framework version to use instead of the one defined in the root project
`resolveFrameworkDependencies`	string	<optional>	`true`	Whether framework dependencies should be added to the graph
`workspaceName`	string \| null	<optional>	`default`	Name of the workspace configuration that should be used. "default" if not provided.
`cacheMode`	module:@ui5/project/ui5Framework/maven/CacheMode	<optional>		Cache mode to use when consuming SNAPSHOT versions of a framework
`workspaceConfigPath`	string	<optional>	`ui5-workspace.yaml`	Workspace configuration file to use if no object has been provided
`workspaceConfiguration`	@ui5/project/graph/Workspace~Configuration	<optional>		Workspace configuration object to use instead of reading from a configuration file. Parameter `workspaceName` can either be omitted or has to match with the given configuration name

Promise resolving to a Project Graph instance

Description:

Source:

Name Type Description

options

object

Name	Type	Attributes	Default	Description
`filePath`	object	<optional>	`projectDependencies.yaml`	Path to the dependency configuration file
`cwd`	string	<optional>	`process.cwd()`	Directory to resolve relative paths to
`rootConfiguration`	object	<optional>		Configuration object to use for the root module instead of reading from a configuration file
`rootConfigPath`	string	<optional>		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to `cwd` or an absolute path. In both case, platform-specific path segment separators must be used.
`versionOverride`	string	<optional>		Framework version to use instead of the one defined in the root project
`cacheMode`	module:@ui5/project/ui5Framework/maven/CacheMode	<optional>		Cache mode to use when consuming SNAPSHOT versions of a framework
`resolveFrameworkDependencies`	string	<optional>	`true`	Whether framework dependencies should be added to the graph

Promise resolving to a Project Graph instance