Skip to content

Automatically restart Electron app when the main process files are changed.

License

Notifications You must be signed in to change notification settings

IceEnd/electron-watch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

electron-watch

Automatically restart Electron app when the main process file is changed.

npm MIT License

Installation

npm install electron-watch

Usage

For example,

package.json:

{
  //...
  "scripts": {
    "dev:electron-main": "cross-env NODE_ENV='development' electron -r babel-register ./app/renderer/",
  },
  //...
}

Adding code block to the main process file:

index.js:

import electron from 'electron';
import path from 'path';

if (process.env.NODE_ENV === 'development') {
  require('electron-watch')(
    __dirname,
    'dev:electron-main',             // npm scripts, means: npm run dev:electron-main
    path.join(__dirname, './'),      // cwd
    2000,                            // debounce delay
  );
}

OPTIONS

field type description
path string Paths to files, dirs to be watched recursively, or glob patterns.
command string npm script name, use this to start electron main process
cwd string Current working directory of the child process.
delay Number Delay (in ms) arguments of debounce, default is 3000ms

LICENSE

MIT @ Alchemy

About

Automatically restart Electron app when the main process files are changed.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published