Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INTERNAL] Configuration: Document default for bundle definition "aync" flag #969

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

RandomByte
Copy link
Member

No description provided.

@RandomByte RandomByte requested a review from a team June 25, 2024 20:16
@RandomByte RandomByte merged commit b1e2613 into main Jun 26, 2024
7 checks passed
@RandomByte RandomByte deleted the bundle-def-async-default branch June 26, 2024 07:41
@@ -702,7 +702,7 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt
- `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`
- `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`
Copy link
Member

@codeworrior codeworrior Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not related to this change, but when reviewing the file as a whole I noticed that the nesting doesn't seem to be right. "sections" should be on the same level as "defaultFileTypes", shouldn't it? Strangely, it looks still okay in the V4 documentation 1, but not when previewing the MD file in the code section of the Github WebUI 2

Footnotes

  1. https://sap.github.io/ui5-tooling/v4/pages/Configuration/#custom-bundling

  2. https://github.com/SAP/ui5-tooling/blob/main/docs/pages/Configuration.md

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @codeworrior !

Indeed, there was indentation before the "sections" item and GH treats this as subitem.
I fixed it with #970

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants