electron-reloader

Simple auto-reloading for Electron apps during development

Github stars Tracking Chart

electron-reloader Build Status

Simple auto-reloading for Electron apps during development

It just works. When files used in the main process are changed, the app is restarted, and when files used in the browser window are changed, the page is reloaded.

Note that it will not work correctly if you transpile the main process JS files of your app, but it doesn't make sense to do that anyway.

Install

$ npm install --save-dev electron-reloader

Requires Electron 5 or later.

Usage

The following must be included in the app entry file, usually named index.js:

try {
	require('electron-reloader')(module);
} catch (_) {}

You have to pass the module object so we can read the module graph and figure out which files belong to the main process.

The try/catch is needed so it doesn't throw Cannot find module 'electron-reloader' in production.

API

reloader(module, options?)

module

Type: object

The global module object.

options

Type: object

debug

Type: boolean
Default: false

Prints watched paths and when files change. Can be useful to make sure you set it up correctly.

ignore

Type: Array<string, RegExp>

Ignore patterns passed to chokidar. By default, files/directories starting with a ., .map files, and node_modules directories are ignored. This option is additive to those.

watchRenderer

Type: boolean
Default: true

Watch files used in the renderer process and reload the window when they change.

Setting this to false can be useful if you use a different reload strategy in the rendererer process, like HMR.

Tip

Using it with Webpack watch mode

Just add the source directory to the ignore option. The dist directory is already watched, so when a source file changes, webpack will build it and output it to the dist directory, which this module will detect.

Main metrics

Overview
Name With Ownersindresorhus/electron-reloader
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 3)
Platform
License:MIT License
所有者活动
Created At2018-01-04 15:15:10
Pushed At2023-03-27 03:00:36
Last Commit At
Release Count10
Last Release Namev1.2.3 (Posted on 2022-02-22 12:52:01)
First Release Namev0.1.0 (Posted on 2018-01-04 16:24:56)
用户参与
Stargazers Count582
Watchers Count4
Fork Count31
Commits Count29
Has Issues Enabled
Issues Count19
Issue Open Count11
Pull Requests Count5
Pull Requests Open Count0
Pull Requests Close Count6
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private