Package Health Score

75 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.1.2	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.5	\|	05/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.1	\|	12/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.1	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (14,584)

GitHub Stars: 41
Forks: 4
Contributors: 6

Direct Usage Popularity

The npm package @jgoz/esbuild-plugin-livereload receives a total of 14,584 downloads a week. As such, we scored @jgoz/esbuild-plugin-livereload popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @jgoz/esbuild-plugin-livereload, we found that it has been starred 41 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @jgoz/esbuild-plugin-livereload is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 5
Open PR: 10
Last Release: 29 days ago
Last Commit: 29 days ago

Further analysis of the maintenance status of @jgoz/esbuild-plugin-livereload based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @jgoz/esbuild-plugin-livereload demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 0 Direct
Versions: 14
Install Size: 485 kB
Dist-tags: 1
# of Files: 32
Maintainers: 1
TS Typings: No

@jgoz/esbuild-plugin-livereload has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@jgoz/esbuild-plugin-livereload

An esbuild plugin that reloads the browser window after you make changes. CSS-only changes are hot reloaded (i.e., without a full page refresh) by default.

Features

Reloads the browser window when new JS assets are emitted
Hot-reloads CSS files (configurable) without flashes of unstyled content
Adds a dismissable error/warning overlay for esbuild output
- Can be used by other plugins by importing the notify function

How is this different from esbuild's built-in livereload (0.17.0+)?

Doesn't require use of esbuild's serve() API
Doesn't require any extra code — client script is injected into the bundle
Includes an overlay for displaying error messages in the browser

Install

$ npm i @jgoz/esbuild-plugin-livereload

Usage

Add it to your esbuild plugins:

const esbuild = require('esbuild');
const { livereloadPlugin } = require('@jgoz/esbuild-plugin-livereload');

await esbuild.build({
  // ...
  plugins: [livereloadPlugin()],
});

Note that this will have no effect for Node programs.

Plugin API

`function livereloadPlugin(options?: LivereloadPluginOptions): Plugin`

Plugin options:

Name	Type	Default	Description
fullReloadOnCssUpdates	`boolean`	`false`	Instead of hot-reloading CSS files, trigger a full page reload when CSS is updated.
host	`string`	`127.0.0.1`	Host that the livereload server will run on. Setting this value to '0.0.0.0' will allow external connections, e.g., when running the livereload server on a different system from the connecting web browser. This setup likely requires setting `urlHostname` to the either the IP address or local DNS name of the livereload system.
port	`number`	`53099`	Port that the livereload server will run on.
urlHostname	`string`	-	Hostname to use when connecting to the livereload server. This option might be useful when running the livereload server on a different system from the connecting web browser. Defaults to the value specified in `host`.

Notification API

If you are implementing an esbuild plugin that can emit its own errors or warnings, you may add this package as an optional peerDependency and use the notify function to send those messages to the error overlay.

`function notify(errorSource: string, msg: ClientMessage): void`

Notifies connected clients that errors or warnings occurred from a given source. If there are no errors and the notification originates from esbuild, the page will be sent a reload request.

Name	Type	Default	Description
errorSource (*)	`string`	-	Key to use when identifying these errors and warnings. Previous results will be overwritten for the same `errorSource`.
msg (*)	`ClientMessage`	-	Object containing errors and warnings from the given source
connectedClients	`Set>`	`clients`	Set of long-lived server responses representing clients currently connected to the livereload server. Only required if you are implementing your own livereload server.

`ClientMessage`

Name	Type	Default	Description
added (*)	`readonly string[]`	-	Output files that were added since the last build.
removed (*)	`readonly string[]`	-	Output files that were removed since the last build.
updated (*)	`readonly string[]`	-	Output files that were changed since the last build.
errors	`readonly Message[]`	-	Error messages.
forceReload	`boolean`	-	Reload the page even if a hot update is possible.
warnings	`readonly Message[]`	-	Warning messages.

@jgoz/esbuild-plugin-livereload development dependencies

@playwright/test @types/node esbuild esbuild-svelte get-port open-editor prettier svelte svelte-check svelte-preprocess tslib typescript @jgoz/esbuild-overlay

FAQs

What is @jgoz/esbuild-plugin-livereload?

Livereload plugin for esbuild. Visit Snyk Advisor to see a full health score report for @jgoz/esbuild-plugin-livereload, including popularity, security, maintenance & community analysis.

Is @jgoz/esbuild-plugin-livereload popular?

The npm package @jgoz/esbuild-plugin-livereload receives a total of 14,584 weekly downloads. As such, @jgoz/esbuild-plugin-livereload popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @jgoz/esbuild-plugin-livereload well maintained?

We found that @jgoz/esbuild-plugin-livereload demonstrated a healthy version release cadence and project activity. It has a community of 6 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @jgoz/esbuild-plugin-livereload safe to use?

The npm package @jgoz/esbuild-plugin-livereload was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 November-2024, at 18:07 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP