electron-inspector v0.1.4
electron-inspector
Debugger UI for the main Electron process
Overview
This package wraps node-inspector, which can be used to debug JavaScript
code running in the main Electron process. Getting node-inspector running can require somewhere
between a little and a lot of effort depending on the Electron
version you wish to debug. The goal of electron-inspector is to get node-inspector running
with minimum effort on your part.
Prerequisites
- NPM v3
- NodeJS v4.5 (or later)
electron, orelectron-prebuilt, orelectron-prebuilt-compileelectron-rebuild(optional)
Quick Start
electron-inspector should be installed as a local dev dependency of your Electron app:
npm install electron-inspector --save-devThe easiest way to run the inspector in a cross-platform manner is to add an NPM script to your
package.json, for example:
"scripts": {
"inspect-main": "electron-inspector"
}Then run the inspect-main script on the command line with:
npm run inspect-mainAlternatively, if you don't want to mess with your package.json you can directly execute
electron-inspector (macOS / Linux), or .\\node_modules\\.bin\\electron-inspector (Windows).
On startup electron-inspector will check for compatibility of the native modules in
node-inspector with the Electron version you wish to debug, if the compatibility check
fails and electron-rebuild is installed then the native modules will be automatically
rebuilt. You can disable auto-rebuild using the --no-auto-rebuild command line option.
When electron-inspector finally gets node-inspector running you will see a URL printed to the
console window. For example:
Visit http://127.0.0.1:8080/?port=5858 to start debugging.You can then start Electron in debug mode and open the given URL in your browser.
Configuration
node-inspector can be configured in multiple ways, electron-inspector
will pass through most of the supported command line options.
Command Line Options
electron-inspector accepts most of the commandline options node-inspector does:
License
MIT