Registry / devops / ui5-middleware-livereload

ui5-middleware-livereload

library3.3.0jsnpmunverified

Middleware for the UI5 server that triggers a live reload in the browser when files inside the webapp directory change (e.g., on save). Version 3.3.0 requires @ui5/cli >= 3.0.0 with specVersion '3.0'. Community-maintained by the UI5 ecosystem showcase. Key differentiators: customisable watch paths, polling for WSL2, and inclusion of framework/application dependencies.

devops web-framework

npm install ui5-middleware-livereload

github ↗package ↗

INSTALL

IMPORT

SIG · UI5-MIDDLEWARE-LIV

ui5-middleware-livereload

devopsjavascriptv3.3.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ui5-middleware-livereload

✓ npm install ui5-middleware-livereload --save-dev

✗ npm install ui5-middleware-livereload --save

Install as devDependency; no direct import - configured in ui5.yaml

Shows installation and configuration of the live reload middleware in ui5.yaml.

# Install the middleware as a devDependency npm install ui5-middleware-livereload --save-dev # In ui5.yaml, add the middleware configuration: # server: # customMiddleware: # - name: ui5-middleware-livereload # afterMiddleware: compression # configuration: # debug: true # port: 35729 # extraExts: "xml,json,properties" # watchPath: "webapp" # Start the UI5 server as usual (e.g., ui5 serve)

Debug

Known issues

gotchaThe middleware uses port 35729 by default; ensure it is not already used by another livereload service.

fix

Configure a custom 'port' in the configuration section of ui5.yaml.

affects: >=1.0.0

gotchaWatch path 'path' alias was deprecated in v3 in favor of 'watchPath'. Both still work but 'path' may be removed in a future release.

fix

Use 'watchPath' instead of 'path' in the configuration.

affects: >=3.0.0

gotchaBrowser must manually be refreshed if the middleware fails to detect changes (e.g., due to file exclusion patterns or missing extensions in 'extraExts').

fix

Check the console logs for errors; increase debug level by setting 'debug: true'.

affects: >=1.0.0

breakingMajor version 3 requires @ui5/cli >= 3.0.0 and specVersion '3.0' in ui5.yaml. Older versions of UI5 CLI are incompatible.

fix

Update @ui5/cli to version 3.0.0 or later and set specVersion: '3.0' in ui5.yaml.

affects: >=3.0.0

gotchaThe 'usePolling' option may cause high CPU usage on some systems; only enable if necessary (e.g., WSL2).

fix

Add configuration: { usePolling: true } only when needed.

affects: >=1.0.0

Errors

Common errors & fixes

Error: listen EADDRINUSE :::35729

Another process is already using port 35729 (default livereload port).

fix

Change the port in ui5.yaml configuration (e.g., port: 35730).

The spec version "2.0" is not supported by "ui5-middleware-livereload" v3.x

The package requires specVersion '3.0' in ui5.yaml.

fix

Update ui5.yaml to include 'specVersion: "3.0"' at the top level.

Cannot find module 'ui5-middleware-livereload'

The package is not installed or not in devDependencies.

fix

Run 'npm install ui5-middleware-livereload --save-dev' in your project.

TypeError: Cannot set properties of undefined (setting 'debug')

The configuration object is malformed or missing the 'configuration' key.

fix

Ensure the YAML has a 'configuration' block under the middleware definition.

Upgrade

Version history

3.3.0latest on npm

Audit

Dependencies

@ui5/serverrequiredpeer dependency - requires the UI5 server middleware interface

Agent activity

7 hits · last 30 days

node

Resources

githubhttps://github.com/ui5-community/ui5-ecosystem-showcase ↗

packagehttps://www.npmjs.com/package/ui5-middleware-livereload ↗