Split the showDevTools option into two options

sindresorhus · sindresorhus · commit 2ce802357648 · 2018-05-29T01:10:36.000+07:00
You now set the mode to open DevTools in separately. The default also changed to being `undocked` as that makes the most sense for Electron apps.
diff --git a/index.js b/index.js
@@ -6,20 +6,34 @@ const isDev = require('electron-is-dev');
 const {app, BrowserWindow} = electron;
 const isMacOS = process.platform === 'darwin';
 
+const devToolsOptions = {};
+
+function toggleDevTools(win) {
+	win = win || BrowserWindow.getFocusedWindow();
+
+	if (win) {
+		const contents = win.webContents;
+		if (contents.isDevToolsOpened()) {
+			contents.closeDevTools();
+		} else {
+			contents.openDevTools(devToolsOptions);
+		}
+	}
+}
+
 function devTools(win) {
 	win = win || BrowserWindow.getFocusedWindow();
 
 	if (win) {
-		win.toggleDevTools();
+		toggleDevTools(win);
 	}
 }
 
-function openDevTools(win, showDevTools) {
+function openDevTools(win) {
 	win = win || BrowserWindow.getFocusedWindow();
 
 	if (win) {
-		const mode = showDevTools === true ? undefined : showDevTools;
-		win.webContents.openDevTools({mode});
+		win.webContents.openDevTools(devToolsOptions);
 	}
 }
 
@@ -41,7 +55,7 @@ function inspectElements() {
 		if (win.webContents.isDevToolsOpened()) {
 			inspect();
 		} else {
-			win.webContents.on('devtools-opened', inspect);
+			win.webContents.once('devtools-opened', inspect);
 			win.openDevTools();
 		}
 	}
@@ -63,13 +77,18 @@ const addExtensionIfInstalled = (name, getPath) => {
 module.exports = opts => {
 	opts = Object.assign({
 		enabled: null,
-		showDevTools: false
+		showDevTools: false,
+		devToolsMode: 'undocked'
 	}, opts);
 
 	if (opts.enabled === false || (opts.enabled === null && !isDev)) {
 		return;
 	}
 
+	if (opts.devToolsMode !== 'previous') {
+		devToolsOptions.mode = opts.devToolsMode;
+	}
+
 	app.on('browser-window-created', (event, win) => {
 		if (opts.showDevTools) {
 			win.webContents.once('devtools-opened', () => {
diff --git a/readme.md b/readme.md
@@ -77,12 +77,19 @@ Type: `boolean`
 
 ##### showDevTools
 
-Type: `boolean` `string`<br>
-Default: `false`<br>
-Values: `'right'` `'bottom'` `'undocked'` `false` `true` *(Last dock state)*
+Type: `boolean`<br>
+Default: `false`
 
 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])
 
 Toggle DevTools for the specified `BrowserWindow` instance or the focused one.
@@ -101,7 +108,7 @@ Reload the specified `BrowserWindow` instance or the focused one.
 Type: `BrowserWindow`<br>
 Default: The focused `BrowserWindow`
 
-### openDevTools([window], [showDevTools])
+### openDevTools([window])
 
 Open DevTools for the specified `BrowserWindow` instance or the focused one.
 
@@ -110,14 +117,6 @@ Open DevTools for the specified `BrowserWindow` instance or the focused one.
 Type: `BrowserWindow`<br>
 Default: The focused `BrowserWindow`
 
-#### showDevTools
-
-Type: `boolean` `string`<br>
-Default: `false`<br>
-Values: `'right'` `'bottom'` `'undocked'` `false` `true` *(last dock state)*
-
-Show DevTools on each created `BrowserWindow`.
-
 
 ## Related
 
