Skip to content

Commit

Permalink
[INTERNAL] Enhance documentation (#970)
Browse files Browse the repository at this point in the history
- Add @ui5/builder as peer dependency to @ui5/project in migration guide
- Adjust Configuration.md

---------

Co-authored-by: Günter Klatt <[email protected]>
  • Loading branch information
d3xter666 and KlattG authored Jun 27, 2024
1 parent b1e2613 commit fc85f1b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/pages/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -694,15 +694,15 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt

- `name`: The module bundle name
- `defaultFileTypes`: List of default file types which should be included in the bundle. Defaults to: `.js`, `.control.xml`, `.fragment.html`, `.fragment.json`, `.fragment.xml`, `.view.html`, `.view.json` and `.view.xml`
- `sections`: A list of module bundle definition sections. Each section specifies an embedding technology (see [API-Reference](https://sap.github.io/ui5-tooling/v4/api/module-@ui5_builder_processors_bundlers_moduleBundler.html#~ModuleBundleDefinition)) and lists the resources that should be in- or excluded from the section.
- `mode`: The embedding technology (e.g. provided, raw, preload, bundleInfo, depCache)
- `sections`: A list of module bundle definition sections. Each section specifies an embedding technology (see [API-Reference](https://sap.github.io/ui5-tooling/v4/api/module-@ui5_builder_processors_bundlers_moduleBundler.html#~ModuleBundleDefinition)) and lists the resources that should be in- or excluded from the section.
- `mode`: The embedding technology (e.g. provided, raw, preload, bundleInfo, depCache, require)
- `filters`: List of modules declared as glob patterns (resource name patterns) that are in- or excluded. Similarly to the use of a single `*` or double `**` asterisk, a pattern ending with a slash `/` denotes an arbitrary number of characters or folder names. Excludes have to be marked with a leading exclamation mark `!`. The order of filters is relevant; a later inclusion overrides an earlier exclusion, and vice versa.
- `resolve`: Setting resolve to `true` will also include all (transitive) dependencies of the files
- `resolveConditional`: Whether conditional dependencies of modules should be resolved and added to the module set for this section. By default set to `false`
- `declareRawModules`: Whether raw modules should be declared after jQuery.sap.global became available. With the usage of the ui5loader, this flag should be set to 'false'. By default set to `false`
- `renderer`: Whether renderers for controls should be added to the module set. By default set to `false`
- `sort`: By default, modules are sorted by their dependencies. The sorting can be suppressed by setting the option to `false`
- `async`: Specifies whether the require section of the module should be asynchronous. When set to `true`, the modules will be loaded using sap.ui.require instead of sap.ui.requireSync. The latter API is not available in UI5 version 2.x. **Note:** This property is available only for `mode=require` and defaults to `true`
- `async`: Specifies whether the `require` section of the module should be asynchronous. When set to `true`, the modules will be loaded using `sap.ui.require` instead of `sap.ui.requireSync`. The latter API is not available in UI5 version 2.x. **Note:** This property is available only for `mode=require` and defaults to `true`

**bundleOptions**

Expand Down
4 changes: 4 additions & 0 deletions docs/updates/migrate-v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,7 @@ Non-public `DuplexCollection#byGlobSource` API has been removed.
cwd: process.cwd()
});
```

- **Dependencies**: The `@ui5/builder` is now an optional dependency to the `@ui5/project`

Consumers of the Node.js API that make use of the `ProjectGraph#build` method need to declare a dependency to `@ui5/builder` in their respective `package.json`. The package manager should ensure that the version fulfills the range specified in the `package.json` of `@ui5/project`.

0 comments on commit fc85f1b

Please sign in to comment.