ui5-middleware-livereload
A 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.
UI5 middleware for live reloading webapp sources on change
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
Download
Install
npm add ui5-middleware-livereloadDerived 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 middleware for live reloading webapp sources on change
👋 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.
Middleware for ui5-server, doing a live reload when files inside $yourapp change, e.g. on save.
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-middleware-livereload --save-devConfiguration options (in $yourapp/ui5.yaml)
- debug: true|false verbose logging
- extraExts:
string, default:jsx,ts,tsx,xml,json,propertiesfile extensions other thanjs,htmlandcssto monitor for changes - port:
integer, default: an free port choosen from35729onwards port the live reload server is started on - watchPath|path:
string, default: all paths from app and non framework dependencies path inside$yourappthe reload server monitors for changes - exclusions: one or many
regex. By default, this includes.git/,.svn/, and.hg/ - usePolling: true|false, default:
falseEnables chokidar polling to support virtualised filesystems(eg. WSL2.0). - includeFwkDeps: true|false, default:
falseIncludes the framework dependencies into thewatchPath - includeAppDeps: true|false, default:
falseIncludes the application dependencies into thewatchPath - host:
string, default:localhost - force: true|false, default: unset
force-enable (
true) or force-disable (false) the middleware, overriding the automatic UI5 Tooling V5+ auto-disable (see UI5 Tooling V5 below)
UI5 Tooling V5
UI5 Tooling V5 provides a built-in Live Reload. Per the official docs, combining a custom live-reload middleware with the built-in feature can make the page "refresh more often than necessary." To avoid that, this middleware automatically disables itself when running under UI5 Tooling V5 or higher (detected via the @ui5/server major version).
- To keep using this middleware under V5, set
configuration.force: trueand disable the built-in Live Reload via the--no-live-reloadCLI flag or theserver.settings.liveReloadconfiguration option (otherwise both run and the page double-reloads). - To disable this middleware on any tooling version, set
configuration.force: false.
See the UI5 CLI v5 migration guide for details on the built-in Live Reload and other V5 changes.
Usage
- Define the dependency in
$yourapp/package.json:
"devDependencies": {
// ...
"ui5-middleware-livereload": "*"
// ...
}- configure it in
$yourapp/ui5.yaml:
server:
customMiddleware:
- name: ui5-middleware-livereload
afterMiddleware: compressionUsing the configuration properties:
server:
customMiddleware:
- name: ui5-middleware-livereload
afterMiddleware: compression
configuration:
debug: true
extraExts: "xml,json,properties"
port: 35729
watchPath: "webapp"or with path instead of watchPath:
server:
customMiddleware:
- name: ui5-middleware-livereload
afterMiddleware: compression
configuration:
debug: true
extraExts: "xml,json,properties"
port: 35729
path: "webapp"Reload from multiple paths:
server:
customMiddleware:
- name: ui5-middleware-livereload
afterMiddleware: compression
configuration:
debug: true
extraExts: "xml,json,properties"
port: 35729
path:
- "webapp"
- "../my.reuse.library/src/my/reuse/library"Use polling to watch files:
server:
customMiddleware:
- name: ui5-middleware-livereload
afterMiddleware: compression
configuration:
debug: true
extraExts: "xml,json,properties"
port: 35729
usePolling: trueExclude single subpath from paths/ watchPaths:
server:
customMiddleware:
- name: ui5-middleware-livereload
afterMiddleware: compression
configuration:
debug: true
extraExts: "xml,json,properties"
port: 35729
watchPath: "webapp"
exclusions:
- "wdi5/"Exclude multiple subpaths from paths/ watchPaths:
server:
customMiddleware:
- name: ui5-middleware-livereload
afterMiddleware: compression
configuration:
debug: true
extraExts: "xml,json,properties"
port: 35729
watchPath: "webapp"
exclusions:
- "wdi5/"
- "integration/"How it works
The middleware launches a livereload-server on the specified port, listening to changes in the app and any of the non framework dependencies or alternativly the specified path or watchPath inside your application directory.
When changes are detected, a reload is triggered to all connected clients - so all browsers having $yourapp will reload the application. The reload is #-aware, meaning the current displayed route in your single-page UI5 app is kept steady.
HTTP/2 support
The middleware supports HTTP/2 automatically, when the UI5 server is started with the --h2 option. It uses the same SSL key and certificate, either set using the --key and --cert options, or using the default ~/.ui5/server/server.key and ~/.ui5/server/server.crt.
Misc/FAQ
yep, cross-browser, cross-platform.
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
-
#1422
288001eThanks @petermuessig! - feat(ui5-middleware-livereload): auto-disable under UI5 Tooling V5+ with aforceoverrideUI5 Tooling V5 ships a built-in Live Reload; running this middleware alongside it makes the page reload more often than necessary. The middleware now detects UI5 Tooling V5 or higher (via the running
@ui5/servermajor version) and auto-disables itself there to avoid double reloads.A new
configuration.forceoption overrides the automatic behavior in both directions:force: truekeeps the middleware active under V5+ (disable the built-in Live Reload via--no-live-reloadorserver.settings.liveReloadto avoid a double reload)force: falsedisables the middleware on any tooling version
When the tooling version cannot be detected, the middleware fails open (stays enabled) so existing setups keep working.
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-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Breaking 26, Other 2
Notes
- Typedefs (#635) (841c6e4), closes #635 #617 #606
- adding Typedefs to packages (#634) (19a5b72), closes #634 #617 #606
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
-
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
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-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
Notes
Note: Version bump only for package ui5-middleware-livereload
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 projects
- 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 backend
- 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 cachebuster
- 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 Babel
- 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 datasets
- 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 extensions
- 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 systems
- 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 declarations
- 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 files
- 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 login
- 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 libraries
- 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 routes
- 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 EOCP
- @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 build
- 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 manifest
- 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/approuter
- 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 server
- 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 replacement
- 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 websocket
- 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 path
- 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 session
- 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 framework
- 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 package
- 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 system
- 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 another
- 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)
- 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's
- 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 applications
- 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 files
- 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 NetWeaver
- 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 texts
- 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 fragments
- 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 app
- ui5-task-zipperui5-task-zipperA 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-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 CSS
- 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 modules
- 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 build
- 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 build
- @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 CLI
- @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 coverage
- @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 wrappers
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
“The reload is `#`-aware, meaning the current displayed route in your single-page UI5 app is kept steady.” — ui5-community/ui5-ecosystem-showcase — README (packages/ui5-middleware-livereload)
“The reload is `#`-aware, meaning the current displayed route in your single-page UI5 app is kept steady.” — ui5-community/ui5-ecosystem-showcase — README (packages/ui5-middleware-livereload)
Contributors
Show 34 more
History in the atlas
- First seen.
For your agent
- Ref
artifact:ui5-community-ui5-middleware-livereload- JSON
- /artifacts/ui5-community-ui5-middleware-livereload.json
- MCP
- Connecting an agent