ui5-task-zipper
A build task for the UI5 tooling that packages the UI5 build result, the webapp, as a zip archive at the end of the build.
Task for the UI5 tooling to zip the webapp.
Facts
Where it sits
Who is behind it
In the atlas: maintains 69@ui5-communitymaintainerAdrian BobevContributes to this
In the atlas: contributes to 10@adrian-bobevAttila BorosContributes to this
In the atlas: contributes to 6@attila-borosBenjamin ReimContributes to this
In the atlas: contributes to 9@BenReimChristian GeorgiContributes to this
In the atlas: maintains 1, contributes to 53@chgeoFrank WeigelContributes to this
In the atlas: contributes to 10@codeworriorDavid SooterContributes to this
In the atlas: contributes to 9@d-sooterYavor IvanovContributes to this
In the atlas: contributes to 17@d3xter666Austin DevineContributes to this
In the atlas: maintains 7, contributes to 25@devineaDimitar FenerskiContributes to this
In the atlas: contributes to 23@dfenerskiDominik FeiningerContributes to this
In the atlas: contributes to 11@dominikfeininger58 contributors
What it declares
Every artifact
- Type
- Build tool
- Origin
- By a community org
- Runtime
- Node.js
As a build tool
- Distributed through
- npm
Connections
Serving an app locally and building it for deployment
UI5 library of eight composite controls under the ui5x namespace
Download
Install
npm add ui5-task-zipperDerived from the package name. No recipe recorded; the README has the configuration.
README
quoted from ui5-community/ui5-ecosystem-showcase under Apache-2.0, readUI5 task for zipping all project resources
👋 This is an open‑source, community‑driven project, developed and actively monitored by members of the UI5 community. You are welcome to use it, report issues, contribute enhancements, and support others in the community.
Task for ui5-builder, enabling zipping.
Prerequisites
- Requires at least
@ui5/cli@3.0.0(to supportspecVersion: "3.0")
⚠️ UI5 CLI Compatibility All releases of this UI5 CLI extension using the major version
3require UI5 CLI V3. Any previous releases below major version3(if available) also support older versions of the UI5 CLI. But the usage of the latest UI5 CLI is strongly recommended!
Install
npm install ui5-task-zipper --save-devConfiguration options (in $yourapp/ui5.yaml)
-
debug:
true|falseVerbose logging -
archiveName:
StringDesired name for the.ziparchive. Default value:<app-id.zip> -
additionalFiles:
String<Array>orObject<Array>List of files to be included in the ZIP archive relative to the project root or Map of of files to be included in the ZIP archive relative to the project root and target path in the ZIP archive. -
includes:
String<Array>(old alias:includePatterns) List of glob patterns matched against the archive-relative resource paths. When provided, only build resources matching at least one pattern are added to the archive (allow-list), e.g.Component.js,manifest.json,css/**. -
excludes:
String<Array>(old alias:excludePatterns) List of glob patterns matched against the archive-relative resource paths. Build resources matching any pattern are omitted from the archive, e.g.**/*.map,**/*-dbg.js. Unlike the nativebuilder.resources.excludesinui5.yaml(which only filters source files), this also removes files generated during the build such as source maps and debug bundles. TheadditionalFilesare not affected by these patterns. -
onlyZip:
true|falseSet this totrueto omit the resources contained in the ZIP from the build result (typically in thedistfolder). By default, the build result contains all resources and the ZIP. -
includeDependencies:
true|falseorString<Array>Set this totrueif you also want to include the dependencies (UI5 libraries) in the zip archive. Otherwise, it will only include the workspace files (controller, views, etc). In order to select only specific dependencies to be included in the final zip you just need to specify the list of dependencies (value ofui5.yaml:metadata > name). -
relativePaths
true|falseSet this totrueif you want to turn absolute data source paths in themanifest.jsoninto relative paths, e.g."uri": "/backend/"will be turned into"uri": "backend/"upon ZIP creation. This is useful when deploying the ZIP to the HTML Application Repository on SAP BTP, Cloud Foundry environment to later consume it in SAP Build Work Zone, standard edition, which only supports relative paths.
NOTE: Starting with release 3.0.5, the ui5-task-zipper includes the generated workspace resources such as the self-contained bundles (sap-ui-custom.* files). To do so, it is important that the ui5-task-zipper is running as last task in the build.
Usage
- Define the dependency in
$yourapp/package.json:
"devDependencies": {
// ...
"ui5-task-zipper": "*"
// ...
}- configure it in
$yourapp/ui5.yaml:
builder:
customTasks:
- name: ui5-task-zipper
afterTask: generateVersionInfo
configuration:
archiveName: "webapp"
additionalFiles:
"app/foo/xs-app.json": # source path will be used as target path
"path/to/foo.js": "foo.js" # file will be placed in root of ZIP file
"path/to/files/bar.js": "some/custom/dir/bar.js"Select the dependencies to include
With the configuration option includeDependencies you can also specifiy a list of dependencies to be included in the zip file. To do so, specify a list of dependencies using their ui5.yaml: metadata > name property:
builder:
customTasks:
- name: ui5-task-zipper
afterTask: generateVersionInfo
configuration:
includeDependencies:
- sap.ui.table
- ui5.ecosystem.demo.libInclude or exclude files from the archive
Use the excludes option to strip files from the archive that are generated during the build but not needed for a production deployment, such as source maps (.map) and debug bundles (-dbg.js). Use the includes option to restrict the archive to an allow-list of resources. Both options accept an array of glob patterns (matched against the archive-relative resource paths):
builder:
customTasks:
- name: ui5-task-zipper
afterTask: generateVersionInfo
configuration:
archiveName: "my-app-deployment"
# exclude generated artifacts from the archive
excludes:
- "**/*.map"
- "**/*-dbg.js"
# or: only include these resources in the archive
includes:
- "Component.js"
- "manifest.json"
- "css/**"
- "i18n/**"If a resource matches both an includes and an excludes pattern, excludes wins.
How it works
The task can be used to zip all project resources in an archive.
License
This work is licensed under Apache 2.0.
Built with care (and a lot of caffeine). If this helped you build, test, or ship, the next coffee — or drink — is on you when you bump into a contributor.
History
Features 1
Notes
Minor Changes
-
#1429
da06786Thanks @petermuessig! - feat(ui5-task-zipper): addincludes/excludesglob filtering for the archiveThe native
builder.resources.excludesinui5.yamlonly filters source files and cannot remove artifacts created during the build (source maps,-dbg.jsdebug bundles). Two new configuration options let you shape the archive contents directly:excludes: glob patterns for build resources to omit from the archive, e.g.**/*.map,**/*-dbg.js— keeping production deployment archives lightweight.includes: glob patterns restricting the archive to an allow-list of resources, e.g.Component.js,manifest.json,css/**.
Patterns are matched via
minimatch. Both options acceptincludePatterns/excludePatternsas backward-compatible aliases (following the ui5-tooling-transpile naming convention).excludeswins overincludes, andadditionalFilesare not affected by the patterns.
All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Breaking 1, Features 2, Fixes 1
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Breaking 26, Features 1
Notes
Features
BREAKING CHANGES
-
new package manager
-
refactor: updated tests to pass with pnpm
-
refactor: iasync still failing
-
feat(ui5-tooling-modules): support pnpm / node_modules symlinks
-
fix(ui5-app): make Karma work with pnpm
-
chore(ui5-app): remove uiveri5 from sample
-
chore(ui5-app): add updated wdio.conf
-
fix: make prettier and eslint work with pnpm
-
fix: fix cf_dest tests
restructured tests and added node_modules as symlink
-
fix(ui5-app): adding eslint for wdio and mocha
-
chore(ui5-middleware-cfdestination): cleanup
-
feat(ui5-tooling-modules): add bundling support for AMD
-
chore(ui5-tooling-modules): cleanup
-
chore: fix code style
-
fix(ui5-task-flatten-library): support files without extensions
-
refactor: updated tests to pass with pnpm
-
feat(ui5-tooling-modules): support pnpm / node_modules symlinks
-
fix: make prettier and eslint work with pnpm
-
fix: update actions, lerna, vscode for pnpm
-
chore: only run test on tooling extensions
-
chore: use sequential tests for ava
-
chore: add @ui5/cli dev dependency for ava tests
-
chore: enable support for local act GH action tests
-
chore: add docu for local GitHub action execution
-
chore: docu cleanup
-
chore: re-add ncu scripts
Co-authored-by: Peter Muessig peter.muessig@sap.com
-
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Notes
Note: Version bump only for package ui5-task-zipper
Others providing
Compare all 42 on the Build and dev-server tooling page →- UI5 ToolsUI5 ToolsA VS Code extension for UI5 developers that serves, proxies, builds and deploys UI5 projects from one workspace-wide configuration, with live reload, a Gateway deployer and a BSP importer.independent, ui5VS Code extension to serve, proxy, build and deploy UI5 projectsfrom UI5
- ui5-middleware-route-proxyui5-middleware-route-proxyA UI5 server middleware that forwards requests matching a route prefix to a backend host, configured per route in ui5.yaml, with credentials read from a .env file rather than the yaml.independent, ui5UI5 server middleware proxying route prefixes to a backendfrom UI5
- ui5-task-cachebuster-indexingui5-task-cachebuster-indexingA UI5 builder task that copies the build output into a timestamped folder inside dist so the UI5 cachebuster can resolve it; it supports timestamps only, not the hash mode.independent, ui5UI5 builder task preparing build output for the cachebusterfrom UI5
- ui5-task-transpile-genui5-task-transpile-genA UI5 builder task that transpiles ES6 to ES5, including async/await, with Babel at build time, registered in ui5.yaml with a bundle definition that includes the regenerator runtime.independent, ui5UI5 builder task transpiling ES6 to ES5 with Babelfrom UI5
- ui5-middleware-odata-recorderui5-middleware-odata-recorderA UI5 server middleware that records the OData traffic a running app makes against a real backend and writes entity JSON files and metadata.xml that the Fiori elements mock server can replay.independent, ui5UI5 middleware recording OData traffic as mock server datasetsfrom UI5
- ui5-plugin-loaderui5-plugin-loaderA UI5 Tooling v4 extension that registers a project's other extensions itself: one entry in ui5.yaml, and every dependency carrying a ui5-plugin-loader.json manifest is mounted as middleware and as a build task.independent, ui5UI5 Tooling v4 extension that registers other extensionsfrom UI5
- ui5-deployerui5-deployerA custom module for UI5 Tooling that deploys Fiori/UI5 apps to SAP NetWeaver ABAP, SAP Cloud Platform Neo or Cloud Foundry, configured in a deployer section of ui5.yaml.independent, ui5UI5 Tooling module deploying Fiori/UI5 apps to SAP systemsfrom UI5
- ui5-task-dts-generatorui5-task-dts-generatorA UI5 builder task that generates d.ts files, TypeScript type declarations, during the build of a UI5 library written in JavaScript, by wrapping @ui5/dts-generator.independent, ui5UI5 builder task generating d.ts type declarationsfrom UI5
- ui5-task-minifierui5-task-minifierA UI5 builder task that minifies the HTML, CSS and JSON files the UI5 builder leaves as they are, with one switch per file type, using html-minifier-terser and clean-css.independent, ui5UI5 builder task minifying HTML, CSS and JSON filesfrom UI5
- ui5-middleware-oidcui5-middleware-oidcA UI5 Tooling server middleware that puts an OpenID Connect login in front of the UI5 dev server, built on express-openid-connect, which receives its configuration block as written.independent, ui5UI5 dev server middleware adding an OpenID Connect loginfrom UI5
- generator-ui5-library-af-deploygenerator-ui5-library-af-deployA Yeoman generator that writes the SAP BTP Application Frontend deployment configuration, mta.yaml, ui5-deploy.yaml, xs-app.json and xs-security.json, into an existing UI5 library project.independent, ui5Yeoman generator for Application Frontend config in UI5 librariesfrom UI5
- ui5-middleware-destinationui5-middleware-destinationA UI5 Tooling server middleware that proxies requests to backends named in WebIDE-style destination files and serves the routes of a neo-app.json, with Basic Authentication only.independent, ui5UI5 Tooling middleware proxying destinations and neo-app.json routesfrom UI5
- ui5-task-check-eocpui5-task-check-eocpA UI5 builder task that matches the UI5 version in ui5.yaml against the versions retrieved from ui5.sap.com and warns during the build once that version's End of Cloud Provisioning quarter has been reached.independent, ui5UI5 build task warning when the app's UI5 version reaches EOCPfrom UI5
- @ui5/cli@ui5/cliThe UI5 Tooling command line for project setup, the local dev server and the build, which defines a UI5 project's shape and its two extension points, custom middleware and custom tasks.sap official, ui5UI5 Tooling command line for project setup, dev server and buildfrom UI5
- ui5-task-btp-manifestui5-task-btp-manifestA UI5 Tooling custom task that writes the surrounding app's sap.cloud service name into the bundled Spreadsheet Importer's manifest at build time, so the two match on SAP BTP.community org, ui5UI5 Tooling task writing the service name into the importer manifestfrom UI5
- ui5-middleware-approuterui5-middleware-approuterA UI5 CLI middleware that puts @sap/approuter in front of the UI5 dev server, proxying it to Cloud Foundry or XS Advanced destinations during development.community org, ui5UI5 CLI middleware proxying the dev server through @sap/approuterfrom UI5
- ui5-middleware-capui5-middleware-capA UI5 CLI middleware that runs a CDS server inside the UI5 dev server, mounted at a path the UI5 project configures, so one command serves the app and its CAP services.community org, ui5UI5 CLI middleware running a CDS server inside the UI5 dev serverfrom UI5
- ui5-middleware-hmrui5-middleware-hmrAn experimental UI5 middleware for hot module replacement, swapping a changed module in during development instead of reloading the whole page.community org, ui5Experimental UI5 middleware for hot module replacementfrom UI5
- ui5-middleware-iasyncui5-middleware-iasyncA UI5 dev-server middleware built on browsersync.io that syncs user interactions across connected browsers over a websocket, replaying an action from one browser in the others for manual testing.community org, ui5UI5 middleware syncing interactions across browsers over websocketfrom UI5
- ui5-middleware-indexui5-middleware-indexA UI5 dev-server middleware that delivers a configured welcome page, index.html by default, for the root path instead of the ui5-server directory listing.community org, ui5UI5 middleware serving a chosen welcome page at the root pathfrom UI5
- ui5-middleware-livereloadui5-middleware-livereloadA dev-server middleware that adds live reload to the UI5 dev server, reloading the page when the sources in the app's webapp folder change.community org, ui5Live reload middleware for the UI5 dev serverfrom UI5
- ui5-middleware-oneloginui5-middleware-oneloginA UI5 dev-server middleware that logs into a system such as SAP Gateway with headless Playwright on the first request and reuses the session cookie for every later request.community org, ui5UI5 middleware logging in with Playwright and reusing the sessionfrom UI5
- ui5-middleware-serveframeworkui5-middleware-serveframeworkA UI5 middleware that serves a UI5 framework built on the local machine to the dev server, in place of a framework version resolved another way.community org, ui5UI5 middleware serving a locally built UI5 frameworkfrom UI5
- ui5-middleware-servestaticui5-middleware-servestaticA UI5 dev-server middleware that serves static resources from a filesystem path or an installed npm package path, built on serve-static, with either path settable through an environment variable.community org, ui5UI5 middleware serving static resources from a path or npm packagefrom UI5
- ui5-middleware-simpleproxyui5-middleware-simpleproxyA UI5 dev-server middleware that proxies requests from the local dev server to a backend system, so the app can reach the backend's services during development.community org, ui5Dev-server middleware proxying requests to a backend systemfrom UI5
- ui5-middleware-ui5ui5-middleware-ui5A UI5 middleware that lets one UI5 application be included as a dependency of another and served through that application's dev server.community org, ui5UI5 middleware including one UI5 application in anotherfrom UI5
- ui5-middleware-webjarsui5-middleware-webjarsA UI5 dev-server middleware that loads JAR files from a configured path and serves the static resources bundled inside them, following the WebJars convention of META-INF/resources/.community org, ui5UI5 middleware serving static resources from JAR files (WebJars)from UI5
- ui5-middleware-websocketui5-middleware-websocketUI5 middleware utilities that add WebSocket support to Express-based dev servers such as the UI5 server, which has no WebSocket channel of its own.community org, ui5WebSocket support for Express-based dev servers such as UI5'sfrom UI5
- ui5-task-cachebusterui5-task-cachebusterA UI5 builder task that cachebusts a standalone UI5 application by moving its build output into a timestamped subfolder and pointing index.html's resource roots at it.community org, ui5UI5 builder task cachebusting standalone UI5 applicationsfrom UI5
- ui5-task-copyrightui5-task-copyrightA UI5 builder task that appends copyright headers to TypeScript, JavaScript and XML files on every build, so the header is not added to each source file by hand.community org, ui5UI5 builder task appending copyright headers to source filesfrom UI5
- ui5-task-flatten-libraryui5-task-flatten-libraryA UI5 builder task that flattens a library's build output, removing the project namespace and resources folder for deployment to SAP NetWeaver, now also offered by the UI5 CLI itself.community org, ui5UI5 builder task flattening library output for SAP NetWeaverfrom UI5
- ui5-task-i18ncheckui5-task-i18ncheckA UI5 builder task that cross-checks every XML view against the app's i18n properties files and logs a warning where a translation is missing; views created in JavaScript are not checked.community org, ui5UI5 builder task checking XML views for missing i18n textsfrom UI5
- ui5-task-minify-xmlui5-task-minify-xmlA UI5 builder task that minifies XML resources such as views and fragments, which a plain UI5 build otherwise ships unminified.community org, ui5UI5 builder task minifying XML views and fragmentsfrom UI5
- ui5-task-pwa-enablerui5-task-pwa-enablerA UI5 builder task that turns a UI5 application into a progressive web app by generating a web manifest and a service worker under one of five caching strategies.community org, ui5UI5 builder task turning a UI5 app into a progressive web appfrom UI5
- ui5-tooling-lessui5-tooling-lessA UI5 CLI extension, a build task and a dev-server middleware, that compiles an app's Less files into CSS at build time and live while the UI5 server runs.community org, ui5UI5 CLI extension compiling Less files into CSSfrom UI5
- ui5-tooling-modulesui5-tooling-modulesA set of UI5 tooling extensions that load and convert plain npm packages into UI5 AMD-like modules, so the UI5 module loader can consume them.community org, ui5UI5 tooling extensions loading npm packages as UI5 modulesfrom UI5
- ui5-tooling-stringreplaceui5-tooling-stringreplaceA UI5 CLI extension for string replacement during the build, for placeholders or tokens in source files that have to be replaced at build time.community org, ui5UI5 CLI extension for string replacement during the buildfrom UI5
- ui5-tooling-transpileui5-tooling-transpileA UI5 CLI extension that transpiles modern JavaScript or TypeScript during the UI5 build, with a transformJSX option that handles JSX and TSX in the same step.community org, ui5UI5 CLI extension transpiling code during the UI5 buildfrom UI5
- @ui5/logger@ui5/loggerUI5 CLI's internal logger, described by its own readme as internal — it appears here because other UI5 tooling depends on it.sap official, ui5Internal logger of the UI5 CLIfrom UI5
- @ui5/middleware-code-coverage@ui5/middleware-code-coverageUI5 CLI server middleware that instruments a project's JavaScript files with Istanbul as the dev server sends them, and generates the coverage report from the records the OpenUI5 QUnit tests send back.sap official, ui5UI5 CLI middleware for Istanbul code coveragefrom UI5
- @ui5/tooling-webc@ui5/tooling-webcDeprecated UI5 Tooling extensions that generate UI5 library wrapper projects for UI5 Web Components and serve them during development; the README points to ui5-tooling-modules instead.sap official, ui5Deprecated UI5 Tooling extensions for UI5 Web Components wrappersfrom UI5
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Flavors
“Otherwise, it will only include the workspace files (controller, views, etc).” — ui5-community/ui5-ecosystem-showcase — README (packages/ui5-task-zipper)
Contributors
Show 34 more
History in the atlas
- First seen.
For your agent
- Ref
artifact:ui5-community-ui5-task-zipper- JSON
- /artifacts/ui5-community-ui5-task-zipper.json
- MCP
- Connecting an agent