GeneratorGeneratortypeCreates a project, a component or configuration once, when you run it, rather than taking part in every build.See every one →What this type is →independently maintainedindependently maintainedoriginPublished by one person or a small company outside SAP. Says nothing about quality; the readings say that.See every one →
generator-ui5-library-af-deploy
A 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.
Run it in a library project and it reads ui5.yaml and src/, detects the namespace from library.ts/library.js, then writes mta.yaml, ui5-deploy.yaml with ui5-task-zipperui5-task-zipperbuild-toolA build task for the UI5 tooling that packages the UI5 build result, the webapp, as a zip archive at the end of the build.community org, ui5 configured for a library build, xs-app.json and xs-security.json, and adds the build and deploy scripts to package.json. It is the deployment half of a library that UI5 Tooling leaves to you.
Build and dev-server toolingUI5Build and dev-server toolingcapabilityServing an app locally and building it for deployment — proxying a backend, transpiling, bundling, and shaping the result for whatever will host it.
Mio YasutakeMio YasutakePersonMaintains this In the atlas: maintains 47, contributes to 47, wrote 10@miyasutamaintainer
Before choosing this
crawled
Conditions
PracticalFunctional boundary
It targets the Application Frontend service only — not the HTML5 application repository — fixes authentication to IAS, and always creates new service instances, so reusing existing ones means editing the generated mta.yaml afterwards. Version 0.1.0 is the only release.
What it declares
Every artifact
Type
Generator
Origin
Independently maintained
Runtime
build time
declared
Runs on
Cloud Foundry
declared
As a generator
Generates
Configuration
declared, What it creates when you run it., read Creates the following deploy configuration files: — generator-ui5-library-af-deploy — README, 2026-10-18
Run with
Yeoman
declared, How you run it, as its documentation says., read yo ui5-library-af-deploy — generator-ui5-library-af-deploy — README, 2026-10-18
Distributed through
npm
declared, How the generator is installed, as its documentation says., read npm install -g yo generator-ui5-library-af-deploy — generator-ui5-library-af-deploy — README, 2026-10-18
Connections2
Group by
NodeRelationConditionBasis
Functional1
Build and dev-server toolingBuild and dev-server toolingcapabilityServing an app locally and building it for deploymentSAP and community, narrow by design
→provides
Scaffolds the deployment side of a UI5 library build — the zipper task, the MTA descriptor and the routing and security descriptors that Application Frontend expects.
provides Build and dev-server tooling
Functional, stated
For
Scaffolds the deployment side of a UI5 library build — the zipper task, the MTA descriptor and the routing and security descriptors that Application Frontend expects.
Basis
“Yeoman generator that adds SAP BTP Application Frontend deployment configuration to a UI5 library project.”generator-ui5-library-af-deploy — README, checked
stated
provides Build and dev-server tooling
Functional, stated
For
Scaffolds the deployment side of a UI5 library build — the zipper task, the MTA descriptor and the routing and security descriptors that Application Frontend expects.
Basis
“Yeoman generator that adds SAP BTP Application Frontend deployment configuration to a UI5 library project.”generator-ui5-library-af-deploy — README, checked
Serving an app locally and building it for deployment
Derived from the package name. No recipe recorded; the README has the configuration.
Learn more1
Readings
UI Composition with Application Frontend ServiceUI Composition with Application Frontend ServiceblogWhy shared UI code is hard, and what Application Frontend changes about it. The piece first lays out the three usual answers and what each costs — copying files at development time and repatching every consumer, publishing an npm package and rebuilding every consumer, or hosting the code separately and paying for it in CORS and session handling, or in an extra network hop through a server-side proxy. It then shows a fourth that only this service can do: runtime server-side composition without the hop, configured through routes in the consuming application's xs-app.json, across three cases — a reusable application embedded in a consumer, and two further composition shapes. Read alongside the generator, which scaffolds the mta.yaml, xs-app.json and zipper configuration this model needs.Vadim Tomnikov, published 2026-05-18Vadim Tomnikov, SAP Community
Yeoman generator that adds SAP BTP Application Frontend deployment configuration to a UI5 library project.
Installation
npm install -g yo generator-ui5-library-af-deploy
Usage
cd path/to/your-ui5-libraryyo ui5-library-af-deploy
What it does
The generator reads ui5.yaml and the src/ directory structure of the current project, then:
Detects the library namespace from src/<path>/library.{ts,js}.
If metadata.name in ui5.yaml does not match the detected namespace, asks for confirmation and rewrites the line for you (answering "no" aborts the generator).
Creates the following deploy configuration files:
mta.yaml — MTA module + resources for Application Frontend + XSUAA
ui5-deploy.yaml — UI5 build config with ui5-task-zipper configured for library builds
xs-app.json — Routing config with app-front service and IAS authentication
xs-security.json — XSUAA xsappname (matches the archive name)
Updates package.json:
Adds build:cf, build:mta, deploy scripts
Adds ui5-task-zipper, mbt, rimraf to devDependencies
Requirements
UI5 library project (type: library in ui5.yaml)
A single src/<namespace-path>/library.{ts,js} entry point
framework.version and framework.libraries set in ui5.yaml
After running
npm installnpm run build:cfnpm run build:mtanpm run deploy
Limitations (MVP)
Targets Application Frontend service only (not the classic HTML5 App Repo)
Authentication type is fixed to ias
Always creates new service instances. If you want to reuse existing instances, adjust mta.yaml after running the generator.
Build and dev-server toolingBuild and dev-server toolingcapabilityServing an app locally and building it for deployment — proxying a backend, transpiling, bundling, and shaping the result for whatever will host it.SAP and community, narrow by design
UI5 ToolsUI5 Toolside-extensionA 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 projects
ui5-middleware-route-proxyui5-middleware-route-proxybuild-toolA 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 backend
ui5-task-cachebuster-indexingui5-task-cachebuster-indexingbuild-toolA 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 cachebuster
ui5-task-transpile-genui5-task-transpile-genbuild-toolA 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 Babel
ui5-middleware-odata-recorderui5-middleware-odata-recorderbuild-toolA 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 datasets
ui5-plugin-loaderui5-plugin-loaderbuild-toolA 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 extensions
ui5-deployerui5-deployercliA 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 systems
ui5-task-dts-generatorui5-task-dts-generatorbuild-toolA 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 declarations
ui5-task-minifierui5-task-minifierbuild-toolA 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 files
ui5-middleware-oidcui5-middleware-oidcbuild-toolA 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 login
ui5-middleware-destinationui5-middleware-destinationbuild-toolA 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 routes
ui5-task-check-eocpui5-task-check-eocpbuild-toolA 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 EOCP
@ui5/cli@ui5/clicliThe 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 build
ui5-task-btp-manifestui5-task-btp-manifestbuild-toolA 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 manifest
ui5-middleware-approuterui5-middleware-approuterbuild-toolA 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/approuter
ui5-middleware-capui5-middleware-capbuild-toolA 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 server
ui5-middleware-hmrui5-middleware-hmrbuild-toolAn 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 replacement
ui5-middleware-iasyncui5-middleware-iasyncbuild-toolA 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 websocket
ui5-middleware-indexui5-middleware-indexbuild-toolA 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 path
ui5-middleware-livereloadui5-middleware-livereloadbuild-toolA 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 server
ui5-middleware-oneloginui5-middleware-oneloginbuild-toolA 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 session
ui5-middleware-serveframeworkui5-middleware-serveframeworkbuild-toolA 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 framework
ui5-middleware-servestaticui5-middleware-servestaticbuild-toolA 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 package
ui5-middleware-simpleproxyui5-middleware-simpleproxybuild-toolA 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 system
ui5-middleware-ui5ui5-middleware-ui5build-toolA 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 another
ui5-middleware-webjarsui5-middleware-webjarsbuild-toolA 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)
ui5-middleware-websocketui5-middleware-websocketbuild-toolUI5 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's
ui5-task-cachebusterui5-task-cachebusterbuild-toolA 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 applications
ui5-task-copyrightui5-task-copyrightbuild-toolA 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 files
ui5-task-flatten-libraryui5-task-flatten-librarybuild-toolA 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 NetWeaver
ui5-task-i18ncheckui5-task-i18ncheckbuild-toolA 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 texts
ui5-task-minify-xmlui5-task-minify-xmlbuild-toolA 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 fragments
ui5-task-pwa-enablerui5-task-pwa-enablerbuild-toolA 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 app
ui5-task-zipperui5-task-zipperbuild-toolA build task for the UI5 tooling that packages the UI5 build result, the webapp, as a zip archive at the end of the build.community org, ui5Build task packaging the UI5 build result as a zip archive
ui5-tooling-lessui5-tooling-lessbuild-toolA 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 CSS
ui5-tooling-modulesui5-tooling-modulesbuild-toolA 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 modules
ui5-tooling-stringreplaceui5-tooling-stringreplacebuild-toolA 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 build
ui5-tooling-transpileui5-tooling-transpilebuild-toolA 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 build
@ui5/logger@ui5/loggerpackageUI5 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 CLI
@ui5/middleware-code-coverage@ui5/middleware-code-coveragebuild-toolUI5 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 coverage
@ui5/tooling-webc@ui5/tooling-webcbuild-toolDeprecated 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 wrappers
