Skip to content

Commit dd64ff5

Browse files
SabineLossRandomByte
authored andcommitted
[INTERNAL] UA Review README.md
1 parent 97e96f3 commit dd64ff5

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/master/docs/images/UI5_logo_wide.png)
22

33
# ui5-project
4-
> Modules for building a UI5 projects dependency tree, including configuration
4+
> Modules for building a UI5 projects dependency tree, including configuration.
55
> Part of the [UI5 Build and Development Tooling](https://github.com/SAP/ui5-tooling)
66
77
[![Travis CI Build Status](https://travis-ci.org/SAP/ui5-project.svg?branch=master)](https://travis-ci.org/SAP/ui5-project)
@@ -16,15 +16,15 @@
1616
## Normalizer
1717
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)).
1818

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.
2020

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)).
2222

2323
## 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 tree structure.
2525

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):
2828

2929
````json
3030
{
@@ -58,14 +58,14 @@ The following dependency tree is the expected input structure of the [Project Pr
5858
````
5959

6060
### 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.
6262

6363
### Static Translator
6464
*This translator is currently intended for testing purposes only.*
6565

6666
Can be used to supply the full dependency information of a project in a single structured file.
6767

68-
Usage example: `ui5 serve -b static:/path/to/projectDependencies.yaml`
68+
Example: `ui5 serve -b static:/path/to/projectDependencies.yaml`
6969
`projectDependencies.yaml` contains something like:
7070
````yaml
7171
---
@@ -85,7 +85,7 @@ dependencies:
8585
## Project Preprocessor
8686
Enhances a given dependency tree based on a projects [configuration](#configuration).
8787

88-
### Enhanced dependency tree structure returned by the Project Preprocessor
88+
### Enhanced Dependency Tree Structure Returned by the Project Preprocessor
8989
````json
9090
{
9191
"id": "projectA",
@@ -183,8 +183,8 @@ Enhances a given dependency tree based on a projects [configuration](#configurat
183183
````
184184

185185
## 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.
188188

189189
#### Structure
190190
##### YAML
@@ -230,10 +230,10 @@ server:
230230
#### Properties
231231
##### \<root\>
232232
- `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.
234234

235235
##### metadata
236-
Some general information
236+
Some general information:
237237
- `name`: Name of the application/library/resource
238238
- `copyright` (optional): String to be used for replacement of copyright placeholders in the project
239239

@@ -242,17 +242,17 @@ Some general information
242242
- `paths`: Mapping between virtual and physical paths
243243
+ For type `application` there can be a setting for mapping the virtual path `webapp` to a physical path within the project
244244
+ 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.
246246

247247
##### 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
252252

253253
##### server (optional)
254254
- `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
256256

257257
## Contributing
258258
Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)