@ui5/project/specifications/ComponentProject
@ui5/project/specifications/ComponentProject
Subclass for projects potentially containing Components
Extends
Methods
getCustomConfiguration() → {object}
Description: Get the project's customConfiguration
Source: project/lib/specifications/Project.js, line 74
Overrides: @ui5/project/specifications/Project#getCustomConfiguration
Returns:
Custom Configuration
Type: object
getFrameworkDependencies() → {Array<@ui5/project/specifications/Project~FrameworkDependency>}
Description: Get the project's framework dependencies configuration
Source: project/lib/specifications/Project.js, line 128
Overrides: @ui5/project/specifications/Project#getFrameworkDependencies
Returns:
Framework dependencies configuration
Type: Array<@ui5/project/specifications/Project~FrameworkDependency>
getFrameworkName() → {string}
Description: Get the project's framework name configuration
Source: project/lib/specifications/Project.js, line 96
Overrides: @ui5/project/specifications/Project#getFrameworkName
Returns:
Framework name configuration, either OpenUI5 or SAPUI5
Type: string
getFrameworkVersion() → {string}
Description: Get the project's framework version configuration
Source: project/lib/specifications/Project.js, line 106
Overrides: @ui5/project/specifications/Project#getFrameworkVersion
Returns:
Framework version configuration, e.g 1.110.0
Type: string
getId() → {string}
Description: Gets the ID of this specification.
Note: Only to be used for special occasions as it is specific to the provider that was used and does not necessarily represent something defined by the project.
For general purposes of a unique identifier use getName instead.
Source: project/lib/specifications/Specification.js, line 176
Overrides: @ui5/project/specifications/Project#getId
Returns:
Specification ID
Type: string
getKind() → {string}
Description: Gets the kind of this specification, for example project or extension
Source: project/lib/specifications/Specification.js, line 196
Overrides: @ui5/project/specifications/Project#getKind
Returns:
Specification kind
Type: string
getName() → {string}
Description: Gets the name of this specification. Represents a unique identifier.
Source: project/lib/specifications/Specification.js, line 186
Overrides: @ui5/project/specifications/Project#getName
Returns:
Specification name
Type: string
getNamespace() → {string}
Description: Get the project namespace
Source: project/lib/specifications/ComponentProject.js, line 34
Overrides: @ui5/project/specifications/Project#getNamespace
Returns:
Project namespace in slash notation (e.g. my/project/name)
Type: string
getReader(optionsopt) → {@ui5/fs/ReaderCollection}
Description: Get a ReaderCollection for accessing all resources of the project in the specified "style":
- buildtime: Resource paths are always prefixed with
/resources/or/test-resources/followed by the project's namespace. Any configured build-excludes are applied - dist: Resource paths always match with what the UI5 runtime expects. This means that paths generally depend on the project type. Applications for example use a "flat"-like structure, while libraries use a "buildtime"-like structure. Any configured build-excludes are applied
- runtime: Resource paths always match with what the UI5 runtime expects. This means that paths generally depend on the project type. Applications for example use a "flat"-like structure, while libraries use a "buildtime"-like structure. This style is typically used for serving resources directly. Therefore, build-excludes are not applied
- flat: Resource paths are never prefixed and namespaces are omitted if possible. Note that project types like "theme-library", which can have multiple namespaces, can't omit them. Any configured build-excludes are applied
If project resources have been changed through the means of a workspace, those changes are reflected in the provided reader too.
Resource readers always use POSIX-style paths.
Source: project/lib/specifications/ComponentProject.js, line 126
Overrides: @ui5/project/specifications/Project#getReader
Parameters:
| Name | Type | Attributes | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | object | optional | Properties:
|
Returns:
A reader collection instance
Type: @ui5/fs/ReaderCollection
getRootPath() → {string}
Description: Gets the specification's file system path. This might not be POSIX-style on some platforms
Source: project/lib/specifications/Specification.js, line 238
Overrides: @ui5/project/specifications/Project#getRootPath
Returns:
Project root path
Type: string
getRootReader(parametersopt) → {@ui5/fs/ReaderCollection}
Description: Gets a ReaderCollection for the root directory of the specification. Resource readers always use POSIX-style
Source: project/lib/specifications/Specification.js, line 253
Overrides: @ui5/project/specifications/Project#getRootReader
Parameters:
| Name | Type | Attributes | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
parameters | object | optional | Parameters Properties:
|
Returns:
Reader collection
Type: @ui5/fs/ReaderCollection
getSourcePath() → {string}
Description: Get the path of the project's source directory. This might not be POSIX-style on some platforms. Projects with multiple source paths will throw an error. For example Modules.
Source: project/lib/specifications/Project.js, line 86
Overrides: @ui5/project/specifications/Project#getSourcePath
Throws:
In case a project has multiple source directories
Type: Error
Returns:
Absolute path to the source directory of the project
Type: string
getSpecVersion() → {@ui5/project/specifications/SpecificationVersion}
Description: Returns an instance of a helper class representing a Specification Version
Source: project/lib/specifications/Specification.js, line 218
Overrides: @ui5/project/specifications/Project#getSpecVersion
Returns:
Type: @ui5/project/specifications/SpecificationVersion
getType() → {string}
Description: Gets the type of this specification, for example application or library in case of projects, and task or server-middleware in case of extensions
Source: project/lib/specifications/Specification.js, line 208
Overrides: @ui5/project/specifications/Project#getType
Returns:
Specification type
Type: string
getVersion() → {string}
Description: Gets the specification's generic version, as typically defined in a package.json
Source: project/lib/specifications/Specification.js, line 228
Overrides: @ui5/project/specifications/Project#getVersion
Returns:
Project version
Type: string
getWorkspace() → {@ui5/fs/ReaderCollection}
Description: Get a resource reader/writer for accessing and modifying a project's resources
Source: project/lib/specifications/ComponentProject.js, line 192
Overrides: @ui5/project/specifications/Project#getWorkspace
Returns:
A reader collection instance
Type: @ui5/fs/ReaderCollection
isFrameworkProject() → {boolean}
Description: Check whether the project is a UI5-Framework project
Source: project/lib/specifications/Project.js, line 63
Overrides: @ui5/project/specifications/Project#isFrameworkProject
Returns:
True if the project is a framework project
Type: boolean