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
Copy file name to clipboardExpand all lines: packages/documentation/docs/pages/CodeAnalysis.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,19 +88,18 @@ The **XMLComposite** control is deprecated since version UI5 1.88. Nevertheless,
88
88
89
89
The [XML Composite Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/XMLCompositeAnalyzer.js) searches for the name of the configured fragment containing the **XMLComposite** control.
90
90
91
-
#### Name of the XMLComposite is equal to fragment name
92
91
93
-
```js
92
+
:::code-group
93
+
94
+
```js [Name of the XMLComposite is equal to fragment name]
Copy file name to clipboardExpand all lines: packages/documentation/docs/pages/Configuration.md
+44-59Lines changed: 44 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,32 +33,24 @@ In addition, a project must define a `type`. This can be either `application`, `
33
33
34
34
The type defines the default path mappings and build tasks. See [UI5 Builder: Types](./Builder.md#types) for details.
35
35
36
-
::: details Example
37
-
38
-
#### application
36
+
:::code-group Example
39
37
40
-
```yaml
38
+
```yaml [application]
41
39
specVersion: "4.0"
42
40
type: application
43
41
```
44
42
45
-
#### library
46
-
47
-
```yaml
43
+
```yaml [library]
48
44
specVersion: "4.0"
49
45
type: library
50
46
```
51
47
52
-
#### theme-library
53
-
54
-
```yaml
48
+
```yaml [theme-library]
55
49
specVersion: "4.0"
56
50
type: theme-library
57
51
```
58
52
59
-
#### module
60
-
61
-
```yaml
53
+
```yaml [module]
62
54
specVersion: "4.0"
63
55
type: module
64
56
```
@@ -124,7 +116,7 @@ Note that all configured paths must be written in POSIX (i.e. using only forward
124
116
#### Available Path Mappings
125
117
126
118
#### Applications
127
-
- `webapp`: Mapped to runtime path `/` (root)
119
+
- `webapp`: Mapped to runtime path `/` (root)
128
120
129
121
```yaml title="Default Configuration"
130
122
resources:
@@ -134,8 +126,8 @@ resources:
134
126
```
135
127
136
128
#### Libraries
137
-
- `src`: Mapped to runtime path `/resources`
138
-
- `test`: Mapped to runtime path `/test-resources`
129
+
- `src`: Mapped to runtime path `/resources`
130
+
- `test`: Mapped to runtime path `/test-resources`
139
131
140
132
```yaml title="Default Configuration"
141
133
resources:
@@ -184,18 +176,15 @@ resources:
184
176
::: info Info
185
177
This configuration is available since UI5 CLI [`v1.7.0`](https://github.com/SAP/ui5-cli/releases/tag/v1.7.0)
186
178
187
-
::: details Example
188
-
#### UTF-8
179
+
::: code-group Example
189
180
190
-
```yaml
181
+
```yaml [UTF-8]
191
182
resources:
192
183
configuration:
193
184
propertiesFileSourceEncoding: UTF-8
194
185
```
195
186
196
-
#### ISO-8859-1
197
-
198
-
```yaml
187
+
```yaml [ISO-8859-1]
199
188
resources:
200
189
configuration:
201
190
propertiesFileSourceEncoding: ISO-8859-1
@@ -253,19 +242,20 @@ Define your project's framework dependencies.
253
242
254
243
In your project's framework configuration you must define whether you want to use the OpenUI5 or the SAPUI5 framework and which version:
255
244
256
-
#### OpenUI5
257
-
```yaml
245
+
::: code-group
246
+
247
+
```yaml [OpenUI5]
258
248
framework:
259
249
name: OpenUI5
260
250
version: 1.82.0
261
251
```
262
252
263
-
#### SAPUI5
264
-
```yaml
253
+
```yaml [SAPUI5]
265
254
framework:
266
255
name: SAPUI5
267
256
version: 1.82.0
268
257
```
258
+
:::
269
259
270
260
If you are not sure which framework is right for you, see our [documentation on the differences between OpenUI5 and SAPUI5](./FAQ.md#whats-the-difference-between-openui5-and-sapui5).
271
261
@@ -283,9 +273,9 @@ Projects that use the OpenUI5 framework cannot depend on projects that use the S
283
273
284
274
### Dependencies
285
275
286
-
::: details Example
287
-
#### application
288
-
```yaml
276
+
::: code-group Example
277
+
278
+
```yaml [application]
289
279
specVersion: "4.0"
290
280
type: application
291
281
metadata:
@@ -300,8 +290,7 @@ framework:
300
290
- name: themelib_sap_fiori_3
301
291
```
302
292
303
-
#### library
304
-
```yaml
293
+
```yaml [library]
305
294
specVersion: "4.0"
306
295
type: library
307
296
metadata:
@@ -328,8 +317,9 @@ framework:
328
317
329
318
All libraries required by your project must be listed in the `libraries` section of the framework configuration:
330
319
331
-
#### OpenUI5
332
-
```yaml
320
+
::: code-group
321
+
322
+
```yaml [OpenUI5]
333
323
framework:
334
324
name: OpenUI5
335
325
version: 1.82.0
@@ -339,8 +329,7 @@ framework:
339
329
- name: sap.ui.table
340
330
```
341
331
342
-
#### SAPUI5
343
-
```yaml
332
+
```yaml [SAPUI5]
344
333
framework:
345
334
name: SAPUI5
346
335
version: 1.82.0
@@ -349,6 +338,7 @@ framework:
349
338
- name: sap.m
350
339
- name: sap.ui.comp
351
340
```
341
+
:::
352
342
353
343
#### Development Dependencies
354
344
Development dependencies are only installed if the project defining them is the current root project.
@@ -375,10 +365,9 @@ You can choose which theme library to use by the application that is consuming t
For projects of type `module`, this configuration is available since UI5 CLI [`v3.5.0`](https://github.com/SAP/ui5-cli/releases/tag/v3.5.0)
408
-
and applies only to projects defining [Specification Version](#specification-versions) 3.1 or higher.
409
-
410
-
```yaml
390
+
```yaml [module]
411
391
builder:
412
392
resources:
413
393
excludes:
@@ -418,21 +398,28 @@ builder:
418
398
```
419
399
:::
420
400
401
+
::: info
402
+
403
+
For projects of type `module`, this configuration is available since UI5 CLI [`v3.5.0`](https://github.com/SAP/ui5-cli/releases/tag/v3.5.0)
404
+
and applies only to projects defining [Specification Version](#specification-versions) 3.1 or higher.
405
+
406
+
:::
407
+
421
408
You can exclude a projects resources from the build process using a list of glob patterns. Matching resources will be ignored by the builder and all build tasks.
422
409
423
410
Patterns are applied to the **virtual resource paths** (i.e. the UI5 runtime paths). Exclude patterns are always applied after any includes.
424
411
425
412
### Cachebuster
426
413
427
-
::: details Example
428
-
#### time (default)
429
-
```yaml
414
+
::: code-group Example
415
+
416
+
```yaml [time (default)]
430
417
builder:
431
418
cachebuster:
432
419
signatureType: time
433
420
```
434
-
#### hash
435
-
```yaml
421
+
422
+
```yaml [hash]
436
423
builder:
437
424
cachebuster:
438
425
signatureType: hash
@@ -489,19 +476,17 @@ This configuration is available since UI5 CLI [`v2.10.0`](https://github.com/SAP
489
476
and applies only to projects defining [Specification Version](#specification-versions)
0 commit comments