electron-reloader

Simple auto-reloading for Electron apps during development

Github星跟踪图

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.

主要指标

概览
名称与所有者sindresorhus/electron-reloader
主编程语言JavaScript
编程语言JavaScript (语言数: 3)
平台
许可证MIT License
所有者活动
创建于2018-01-04 15:15:10
推送于2023-03-27 03:00:36
最后一次提交
发布数10
最新版本名称v1.2.3 (发布于 2022-02-22 12:52:01)
第一版名称v0.1.0 (发布于 2018-01-04 16:24:56)
用户参与
星数582
关注者数4
派生数31
提交数29
已启用问题?
问题数19
打开的问题数11
拉请求数5
打开的拉请求数0
关闭的拉请求数6
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?