iceend / electron-watch

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

electron-watch

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

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

electron-watch's Issues

Error (should we have some sort of babel setup?)

Uncaught Exception:
Error: Cannot find module 'babel-register'
    at Module._resolveFilename (internal/modules/cjs/loader.js:584:15)
    at Function.Module._resolveFilename (/Users/tyler/jolt/code/blackjack/node_modules/electron/dist/Electron.app/Contents/Resources/electron.asar/common/reset-search-paths.js:43:12)
    at Function.Module._load (internal/modules/cjs/loader.js:510:25)
    at Module.require (internal/modules/cjs/loader.js:640:17)
    at Function.Module._preloadModules (internal/modules/cjs/loader.js:809:12)
    at Object.<anonymous> (/Users/tyler/jolt/code/blackjack/node_modules/electron/dist/Electron.app/Contents/Resources/default_app.asar/main.js:74:10)
    at Object.<anonymous> (/Users/tyler/jolt/code/blackjack/node_modules/electron/dist/Electron.app/Contents/Resources/default_app.asar/main.js:204:3)
    at Module._compile (internal/modules/cjs/loader.js:693:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:704:10)
    at Module.load (internal/modules/cjs/loader.js:602:32)

NPM warned me about "low severity vulnerability" when I installed electron-watch

Problem couldn't be resolved with "npm audit fix"
My os: {"os":"win32","arch":"x64"}

                   === npm audit security report ===                         
                                                              
                             Manual Review                                  
         Some vulnerabilities require your attention to resolve             
                                                                            
      Visit https://go.npm.me/audit-guide for additional guidance           

Low Regular Expression Denial of Service

Package braces

Patched in >=2.3.1

Dependency of electron-watch [dev]

Path electron-watch > chokidar > anymatch > micromatch > braces

More info https://npmjs.com/advisories/786

found 1 low severity vulnerability in 1583 scanned packages
1 vulnerability requires manual review. See the full report for details.