Skip to content

Commit 598d41f

Browse files
committed
Add documentation about Build Extensibility
1 parent 8873135 commit 598d41f

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

README.md

Lines changed: 10 additions & 10 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)
@@ -10,7 +10,7 @@
1010
[![Dependency Status](https://david-dm.org/SAP/ui5-project/master.svg)](https://david-dm.org/SAP/ui5-project/master)
1111
[![devDependency Status](https://david-dm.org/SAP/ui5-project/master/dev-status.svg)](https://david-dm.org/SAP/ui5-project/master#info=devDependencies)
1212

13-
**This is an alpha release!**
13+
**This is an alpha release!**
1414
**The UI5 Build and Development Tooling described here is not intended for productive use yet. Breaking changes are to be expected.**
1515

1616
## Normalizer
@@ -65,7 +65,7 @@ The npm translator is currently the default translator and looks for dependencie
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+
Usage example: `ui5 serve -b static:/path/to/projectDependencies.yaml`
6969
`projectDependencies.yaml` contains something like:
7070
````yaml
7171
---
@@ -214,14 +214,14 @@ resources:
214214
"src": "source"
215215
builder:
216216
customTasks:
217-
- name: <custom-task-name-1>
218-
beforeTask: <standard-task-name>
217+
- name: custom-task-name-1
218+
beforeTask: standard-task-name
219219
configuration:
220-
color: blue
221-
- name: <custom-task-name-2>
222-
afterTask: <custom-task-name-1>
220+
configuration-key: value
221+
- name: custom-task-name-2
222+
afterTask: custom-task-name-1
223223
configuration:
224-
color: red
224+
configuration-key: value
225225
server:
226226
settings:
227227
port: 8099
@@ -246,7 +246,7 @@ Some general information
246246

247247
##### builder (optional)
248248

249-
- `customTasks` (optional, list): in this block you can define additional custom build tasks. Please see (here) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options:
249+
- `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:
250250
- `name` (mandatory): the name of the custom task
251251
- `afterTask` or `beforeTask` (only one, mandatory): the name of the build task after or before which your custom task will be executed.
252252
- `configuration` (optional): additional configuration for your custom build task

docs/BuildExtensibility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ builder:
2727
color: blue
2828
````
2929

30-
In the above example, when building the library `my.library` the `babel` task will be executed before the standard task `generateComponentPreload`. Another custom task called `generateMarkdownFiles` is then executed immediatly after the standard task `ugilfy`.
30+
In the above example, when building the library `my.library` the `babel` task will be executed before the standard task `generateComponentPreload`. Another custom task called `generateMarkdownFiles` is then executed immediatly after the standard task `uglify`.
3131

3232
### Example: Connect multiple custom tasks
3333

34-
You can also connect multiple custom task with eachother. If you do, please be aware that the order of your definitions is important. You have to make sure that the task is defined before you set it as `beforeTask` or `afterTask`.
34+
You can also connect multiple custom task with each other. If you do, please be aware that the order of your definitions is important. You have to make sure that the task is defined before you set it as `beforeTask` or `afterTask`.
3535

3636
````yaml
3737
---

0 commit comments

Comments
 (0)