UI5 / UI5/cli

Provide and document options to reduce content of build result

Open
#361 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

module/ui5-builder
Dominant language
JavaScript
Stars
511
Forks
83
Avg merge
1d 5h
Merged PRs (30d)
55

Description

Expected Behavior

When executing a build, a lot of files are written to the dist folder that might not be required at runtime, such as:

  • All locale/language-specific files (CLDR, messagebundle_*.properties)
  • All themes (incl. RTL-variants)
  • Individual JS files that are part of a bundle (e.g. sap-ui-custom.js / library-preload.js / Component-preload.js)

This is relevant when packaging the app e.g. with Cordova, as the application bundle can become quite large. It also speeds up deployment e.g. when uploading the files to a server.

It would be helpful if a project could declare/define which locales/languages/themes should be supported. By default all variants should be used.

Current Behavior

It is currently only possible to exclude -dbg.js files

  • via API excludedTasks: ["createDebugFiles"]
  • or via CLI option --exclude-task=createDebugFiles

Context

  • UI5 Module Version (output of ui5 --version when using the CLI): 0.2.6

Affected components (if known)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the ui5-builder and ui5-cli components, including the existing createDebugFiles API and --exclude-task=createDebugFiles CLI option. Trace how build output is selected and documented, then define the supported configuration for locales, themes, and bundle-related files. Done means projects can reduce the dist contents while retaining the default of all variants, with the options documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.