electron-debug - npm Package Compare versions

Comparing version 1.5.0 to 2.0.0

index.js

@@ -6,26 +6,31 @@ 'use strict';
 
-const app = electron.app;
-const BrowserWindow = electron.BrowserWindow;
+const {app, BrowserWindow} = electron;
 const isMacOS = process.platform === 'darwin';
 
-function devTools(win) {
-	win = win || BrowserWindow.getFocusedWindow();
+const devToolsOptions = {};
 
+function toggleDevTools(win = BrowserWindow.getFocusedWindow()) {
 	if (win) {
-		win.toggleDevTools();
+		const {webContents} = win;
+		if (webContents.isDevToolsOpened()) {
+			webContents.closeDevTools();
+		} else {
+			webContents.openDevTools(devToolsOptions);
+		}
 	}
 }
 
-function openDevTools(win, showDevTools) {
-	win = win || BrowserWindow.getFocusedWindow();
+function devTools(win = BrowserWindow.getFocusedWindow()) {
+	if (win) {
+		toggleDevTools(win);
+	}
+}
 
+function openDevTools(win = BrowserWindow.getFocusedWindow()) {
 	if (win) {
-		const mode = showDevTools === true ? undefined : showDevTools;
-		win.webContents.openDevTools({mode});
+		win.webContents.openDevTools(devToolsOptions);
 	}
 }
 
-function refresh(win) {
-	win = win || BrowserWindow.getFocusedWindow();
-
+function refresh(win = BrowserWindow.getFocusedWindow()) {
 	if (win) {
@@ -46,3 +51,3 @@ win.webContents.reloadIgnoringCache();
 		} else {
-			win.webContents.on('devtools-opened', inspect);
+			win.webContents.once('devtools-opened', inspect);
 			win.openDevTools();
@@ -63,3 +68,3 @@ }
 		}
-	} catch (err) {}
+	} catch (_) {}
 };
@@ -70,3 +75,4 @@
 		enabled: null,
-		showDevTools: false
+		showDevTools: true,
+		devToolsMode: 'undocked'
 	}, opts);
@@ -78,5 +84,19 @@
 
-	app.on('browser-window-created', (e, win) => {
+	if (opts.devToolsMode !== 'previous') {
+		devToolsOptions.mode = opts.devToolsMode;
+	}
+
+	app.on('browser-window-created', (event, win) => {
 		if (opts.showDevTools) {
-			openDevTools(win, opts.showDevTools);
+			win.webContents.once('devtools-opened', () => {
+				// Workaround for https://github.com/electron/electron/issues/13095
+				setImmediate(() => {
+					win.focus();
+				});
+			});
+
+			/// Workaround for https://github.com/electron/electron/issues/12438
+			win.webContents.once('dom-ready', () => {
+				openDevTools(win, opts.showDevTools);
+			});
 		}
@@ -87,5 +107,3 @@ });
 		addExtensionIfInstalled('devtron', name => require(name).path);
-		// TODO: Use this when https://github.com/firejune/electron-react-devtools/pull/6 is out
-		// addExtensionIfInstalled('electron-react-devtools', name => require(name).path);
-		addExtensionIfInstalled('electron-react-devtools', name => require('path').dirname(require.resolve(name)));
+		addExtensionIfInstalled('electron-react-devtools', name => require(name).path);
 
@@ -92,0 +110,0 @@ localShortcut.register('CmdOrCtrl+Shift+C', inspectElements);

package.json

 {
 	"name": "electron-debug",
-	"version": "1.5.0",
+	"version": "2.0.0",
 	"description": "Adds useful debug features to your Electron app",
@@ -34,4 +34,4 @@ "license": "MIT",
 		"devtron": "^1.1.0",
-		"electron": "^1.6.12",
-		"electron-react-devtools": "^0.5.2",
+		"electron": "^2.0.2",
+		"electron-react-devtools": "^0.5.3",
 		"xo": "*"
@@ -38,0 +38,0 @@ },

readme.md

@@ -5,5 +5,3 @@ # electron-debug
 
-Ideas for more debug features [welcome!](https://github.com/sindresorhus/electron-debug/issues/new)
 
-
 ## Features
@@ -49,3 +47,5 @@
 
+*Requires Electron 2.0.0 or later.*
 
+
 ## Usage
@@ -56,3 +56,3 @@
 
-require('electron-debug')({showDevTools: true});
+require('electron-debug')();
 
@@ -83,8 +83,15 @@ let win;
 
-Type: `boolean` `string`<br>
-Default: `false`<br>
-Values: `'right'` `'bottom'` `'undocked'` `false` `true` *(Last dock state)*
+Type: `boolean`<br>
+Default: `true`
 
 Show DevTools on each created `BrowserWindow`.
 
+##### devToolsMode
+
+Type: `string`<br>
+Default: `undocked`<br>
+Values: `undocked` `right` `bottom` `previous`
+
+The dock state to open DevTools in.
+
 ### devTools([window])
@@ -108,3 +115,3 @@
 
-### openDevTools([window], [showDevTools])
+### openDevTools([window])
 
@@ -118,11 +125,3 @@ Open DevTools for the specified `BrowserWindow` instance or the focused one.
 
-#### showDevTools
 
-Type: `boolean` `string`<br>
-Default: `false`<br>
-Values: `'right'` `'bottom'` `'undocked'` `false` `true` *(last dock state)*
-
-Show DevTools on each created `BrowserWindow`.
-
-
 ## Related
@@ -129,0 +128,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8047

increased by1.42%

Lines of code

96

increased by21.52%

Worsened metrics

Number of lines in readme file

134

decreased by-0.74%

No dependency changes