npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

electron-reload

v2.0.0-alpha.1

Published

Simplest way to reload an electron app on file changes!

Downloads

68,365

Readme

electron reload

This is (hopefully) the simplest way to load contents of all active BrowserWindows within electron when the source files are changed.

Build Status neutron npm Code Climate Known Vulnerabilities license

Installation

npm install electron-reload

Usage

Just initialize this module with desired glob or file path to watch and let it refresh electron browser windows as targets are changed:

'use strict';

const {app, BrowserWindow} = require('electron');

const electronReload = require('electron-reload')

// Standard stuff
app.on('ready', () => {
  let mainWindow = new BrowserWindow({width: 800, height: 600});

  mainWindow.loadUrl(`file://${__dirname}/index.html`);
  // the rest...
});

Note that the above code only refreshes WebContents of all BrowserWindows. So if you want to have a hard reset (starting a new electron process) you can just pass the path to the electron executable in the options object:

const path = require('path')

require('electron-reload')(__dirname, {
  electron: path.join(__dirname, 'node_modules', '.bin', 'electron')
});

If your app overrides some of the default quit or close actions (e.g. closing the last app window hides the window instead of quitting the app) then the default electron-reload hard restart could leave you with multiple instances of your app running. In these cases you can change the default hard restart action from app.quit() to app.exit() by specifying the hard reset method in the electron-reload options:

const path = require('path')

require('electron-reload')(__dirname, {
  electron: path.join(__dirname, 'node_modules', '.bin', 'electron'),
  hardResetMethod: 'exit'
});

API

electron_reload(paths, options)

  • paths: a file, directory or glob pattern to watch

  • options (optional) containing:

    • chokidar options
    • electron property pointing to electron executables.
    • electronArgv string array with command line options passed to the Electron executable. Only used when hard resetting.
    • appArgv: string array with command line options passed to the Electron app. Only used when hard resetting.
    • forceHardReset: enables hard reset for every file change and not only the main file

    options will default to {ignored: /node_modules|[\/\\]\./, argv: []}.

Why this module?

Simply put, I was tired and confused by all other available modules which are so complicated* for such an uncomplicated task!

* e.g. start a local HTTP server, publish change events through a WebSocket, etc.!

Even more!

If you want to have least effort when developing electron packages, take a look at neutron!

Changelog

  • 2.0.0-alpha.1:
    • Update outdated dependencies.
    • Fix #35: throw error instead of logging to console.
    • Fix #65: add TypeScript definitions.
    • Fix #78: minor README fixes.
    • Fix #87: enable passing arguments to the app itself.
  • 1.5.0:
    • Upgrade chokidar from v2 to v3 (lighter/faster installation)
    • Add friendly linting in dev mode (node run lint) and fix CI linting issues (see #62)
  • 1.4.1: Fix two minor bugs
    • Wrong globbing when doing hard reset (#58)
    • Issues with locating main file in specific project structures (#57)
  • 1.4.0: Enable hard reset for all changes (and not only the main file)
  • 1.3.0: Allow passing arguments to electron executable upon hard resets
  • 1.2.5: Upgrade dependencies (fix vulnerabilities)
  • 1.2.4: Use index.js as fallback if main is not defined in package.json
  • 1.2.3: Fix multiple instances on restart
  • 1.2.2: Fix browserWindows[] indexing
  • 1.2.1: Remove logging from production code (d'oh)
  • 1.2.0: Allow hard reset in multiple browser windows
  • 1.1.0: Add app.exit() in addition to app.quit() for hard resets
  • 1.0.3: Fix hard reset bug
  • 1.0.2: Detach child so that killing parent doesn't kill it (on windows)
  • 1.0.1: Replace extend with Object.assign
  • 1.0.0: Adapt to Electron 1.0 new API
  • 0.3.0: Use new method of accessing app (e.g. require(electron).app)
  • 0.2.0: Use new electrons (> v0.32.3) browser-window-created event