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] docs/pages/Builder.md: Explain bundling of files requiring top level scope #975

Merged
merged 3 commits into from
Jul 15, 2024

Conversation

flovogt
Copy link
Member

@flovogt flovogt commented Jul 4, 2024

Add a section about old (specVersion < 4) and new (specVersion <= 4) behavior when bundling files requiring top level scope.

JIRA: CPOUI5FOUNDATION-794

docs/pages/Builder.md Outdated Show resolved Hide resolved
@flovogt flovogt requested a review from KlattG July 9, 2024 06:39
Copy link
Member

@RandomByte RandomByte left a comment

Choose a reason for hiding this comment

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

LGTM

docs/pages/Builder.md Outdated Show resolved Hide resolved
docs/pages/Builder.md Outdated Show resolved Hide resolved
docs/pages/Builder.md Outdated Show resolved Hide resolved
@flovogt flovogt requested review from KlattG and RandomByte July 9, 2024 11:30
Copy link
Contributor

@KlattG KlattG left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@codeworrior codeworrior left a comment

Choose a reason for hiding this comment

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

LGTM.

There are more solution variants that could be mentioned, but I like the limitation to these two as they are the future-proof ones.

Others:

  • add a filter to exclude the module from bundling
  • (already marked as "not recommended" in the BLI) use the requiresTopLevelScope and ignoredGlobals config in the .library

RandomByte
RandomByte previously approved these changes Jul 9, 2024
Copy link
Member

@matz3 matz3 left a comment

Choose a reason for hiding this comment

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

Maybe include the actual error message text somewhere so that people will find it via search engines when running into this issue?
People will mainly come across this documentation after they see the error in the log (also see my comment in the implementation PR)

@flovogt flovogt merged commit 0edcc8d into main Jul 15, 2024
7 checks passed
@flovogt flovogt deleted the builder-bundle-docu branch July 15, 2024 06:25
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