@ui5/project/graph

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

Methods

(static) graphFromObject(options) → {Promise.<@ui5/project/graph/ProjectGraph>}

Description:
Source:
Parameters:
Name Type Description
options object
Properties
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
Returns:
Promise resolving to a Project Graph instance
Type
Promise.<@ui5/project/graph/ProjectGraph>

(static) graphFromPackageDependencies(optionsopt) → {Promise.<@ui5/project/graph/ProjectGraph>}

Description:
Source:
Parameters:
Name Type Attributes Description
options object <optional>
Properties
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 <optional>
Name of the workspace configuration that should be used if any is 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
Returns:
Promise resolving to a Project Graph instance
Type
Promise.<@ui5/project/graph/ProjectGraph>

(static) graphFromStaticFile(options) → {Promise.<@ui5/project/graph/ProjectGraph>}

Description:
Source:
Parameters:
Name Type Description
options object
Properties
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
Returns:
Promise resolving to a Project Graph instance
Type
Promise.<@ui5/project/graph/ProjectGraph>