You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Modules for building a UI5 projects dependency tree, including configuration
4
+
> Modules for building a UI5 projects dependency tree, including configuration.
5
5
> Part of the [UI5 Build and Development Tooling](https://github.com/SAP/ui5-tooling)
6
6
7
7
[](https://travis-ci.org/SAP/ui5-project)
@@ -16,15 +16,15 @@
16
16
## Normalizer
17
17
The purpose of the normalizer is to collect dependency information and to enrich it with project configuration ([generateProjectTree](https://github.com/pages/SAP/ui5-tooling/module-normalizer_normalizer.html#~generateProjectTree)).
18
18
19
-
[Translators](#translators) are used to collect dependency information. The [Project Preprocessor](#project-preprocessor) enriches this dependency information with project configuration. Typically from a `ui5.yaml` file. A development server and build process can use this information to locate project- and dependency resources.
19
+
[Translators](#translators) are used to collect dependency information. The [Project Preprocessor](#project-preprocessor) enriches this dependency information with project configuration, typically from a `ui5.yaml` file. A development server and build process can use this information to locate project and dependency resources.
20
20
21
-
To only retrieve the project dependency graph, please use ([generateDependencyTree](https://github.com/pages/SAP/ui5-tooling/module-normalizer_normalizer.html#~generateDependencyTree)).
21
+
If you want to retrieve the project dependency graph only, use ([generateDependencyTree](https://github.com/pages/SAP/ui5-tooling/module-normalizer_normalizer.html#~generateDependencyTree)).
22
22
23
23
## Translators
24
-
Translators collect recursively all dependencies on a package manager specific layer and return information about them in a well-defined tree-structure.
24
+
Translators collect recursively all dependencies on a package manager specific layer and return information about them in a well-defined treestructure.
25
25
26
-
### Tree structure returned by a translator
27
-
The following dependency tree is the expected input structure of the [Project Preprocessor](#project-preprocessor).
26
+
### Tree Structure Returned by a Translator
27
+
The following dependency tree is the expected input structure of the [Project Preprocessor](#project-preprocessor):
28
28
29
29
````json
30
30
{
@@ -58,14 +58,14 @@ The following dependency tree is the expected input structure of the [Project Pr
58
58
````
59
59
60
60
### npm Translator
61
-
The npm translator is currently the default translator and looks for dependencies defined in the `package.json` file of a certain project. `dependencies`, `devDepedencies` and [napa dependencies](https://github.com/shama/napa) (Git repositories which don't have a `package.json` file) are located via the Node.js module resolution logic.
61
+
The npm translator is currently the default translator and looks for dependencies defined in the `package.json` file of a certain project. `dependencies`, `devDepedencies`, and [napa dependencies](https://github.com/shama/napa) (Git repositories which don't have a `package.json` file) are located via the Node.js module resolution logic.
62
62
63
63
### Static Translator
64
64
*This translator is currently intended for testing purposes only.*
65
65
66
66
Can be used to supply the full dependency information of a project in a single structured file.
Enhances a given dependency tree based on a projects [configuration](#configuration).
87
87
88
-
### Enhanced dependency tree structure returned by the Project Preprocessor
88
+
### Enhanced Dependency Tree Structure Returned by the Project Preprocessor
89
89
````json
90
90
{
91
91
"id": "projectA",
@@ -183,8 +183,8 @@ Enhances a given dependency tree based on a projects [configuration](#configurat
183
183
````
184
184
185
185
## Configuration
186
-
### Project configuration
187
-
Typically located in a per-project `ui5.yaml` file.
186
+
### Project Configuration
187
+
Typically located in a `ui5.yaml` file per project.
188
188
189
189
#### Structure
190
190
##### YAML
@@ -230,10 +230,10 @@ server:
230
230
#### Properties
231
231
##### \<root\>
232
232
- `specVersion`: Version of the specification
233
-
- `type`: Either `application`, `library` or `custom` (custom not yet implemented). Defines default path mappings and build steps. Custom doesn't define any specific defaults
233
+
- `type`: Either `application`, `library` or `custom` (custom not yet implemented); defines the default path mappings and build steps. Custom doesn't define any specific defaults.
234
234
235
235
##### metadata
236
-
Some general information
236
+
Some general information:
237
237
- `name`: Name of the application/library/resource
238
238
- `copyright` (optional): String to be used for replacement of copyright placeholders in the project
239
239
@@ -242,17 +242,17 @@ Some general information
242
242
- `paths`: Mapping between virtual and physical paths
243
243
+ For type `application` there can be a setting for mapping the virtual path `webapp` to a physical path within the project
244
244
+ For type `library` there can be a setting for mapping the virtual paths `src` and `test` to physical paths within the project
245
-
- `shims`: Can be used to define, extend or override UI5 configs of dependencies. Inner structure equals the general structure. It is a key-value map where the key equals the project ID as supplied by the translator.
245
+
- `shims`: Can be used to define, extend, or override UI5 configs of dependencies. Inner structure equals the general structure. It is a key-value map where the key equals the project ID as supplied by the translator.
246
246
247
247
##### builder (optional)
248
-
- `customTasks` (optional, list): in this block you can define additional custom build tasks. Please see [here](docs/BuildExtensibility.md) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options:
249
-
- `name` (mandatory): the name of the custom task
250
-
- `afterTask` or `beforeTask` (only one, mandatory): the name of the build task after or before which your custom task will be executed.
251
-
- `configuration` (optional): additional configuration that will be passed to the custom build task
248
+
- `customTasks` (optional, list): In this block, you define additional custom build tasks, see [here](docs/BuildExtensibility.md) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options:
249
+
- `name` (mandatory): The name of the custom task
250
+
- `afterTask` or `beforeTask` (only one, mandatory): The name of the build task after or before which your custom task will be executed.
251
+
- `configuration` (optional): Additional configuration that is passed to the custom build task
252
252
253
253
##### server (optional)
254
254
- `settings`(not yet implemented)
255
-
- `port`: Project default server port. Can be overwritten via CLI parameters.
255
+
- `port`: Project default server port; can be overwritten via CLI parameters
0 commit comments