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?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?