Add options.windowSelector

Author: danikaze

index.d.ts

@@ -25,6 +25,17 @@ export type Options = {
 	| 'bottom'
 	| 'previous'
 	| 'detach';
+
+	/**
+	Allows to select windows to apply the debug options to.
+	Accepts a function to filter each window and returns:
+	- `true` to apply the given options
+	- `false` to skip the window (not apply debug)
+	- `Options` to override the global options
+
+	@default `() => true`
+	*/
+	windowSelector?: (window: Readonly<BrowserWindow>) => boolean | Partial<Options>;
 };
 
 /**

index.js

@@ -5,19 +5,58 @@ import isDev from 'electron-is-dev';
 
 const isMacOS = process.platform === 'darwin';
 
-const developmentToolsOptions = {};
+// A Map allows each window to have its own options
+const developmentToolsOptions = new Map();
 
 function toggleDevelopmentTools(win = BrowserWindow.getFocusedWindow()) {
 	if (win) {
 		const {webContents} = win;
 		if (webContents.isDevToolsOpened()) {
 			webContents.closeDevTools();
 		} else {
-			webContents.openDevTools(developmentToolsOptions);
+			webContents.openDevTools(developmentToolsOptions.get(win));
 		}
 	}
 }
 
+function shouldRun(options) {
+	return options && (options.isEnabled === true || (options.isEnabled === null && isDev));
+}
+
+function getOptionsForWindow(win, options) {
+	if (!options.windowSelector) {
+		return options;
+	}
+
+	const newOptions = options.windowSelector(win);
+
+	return newOptions === true
+		? options
+		: (newOptions === false
+			? {isEnabled: false}
+			: {...options, ...newOptions});
+}
+
+function registerAccelerators(win = BrowserWindow.getFocusedWindow()) {
+	(async () => {
+		await app.whenReady();
+
+		if (win) {
+			localShortcut.register(win, 'CommandOrControl+Shift+C', inspectElements);
+			localShortcut.register(win, isMacOS ? 'Command+Alt+I' : 'Control+Shift+I', devTools);
+			localShortcut.register(win, 'F12', devTools);
+			localShortcut.register(win, 'CommandOrControl+R', refresh);
+			localShortcut.register(win, 'F5', refresh);
+		} else {
+			localShortcut.register('CommandOrControl+Shift+C', inspectElements);
+			localShortcut.register(isMacOS ? 'Command+Alt+I' : 'Control+Shift+I', devTools);
+			localShortcut.register('F12', devTools);
+			localShortcut.register('CommandOrControl+R', refresh);
+			localShortcut.register('F5', refresh);
+		}
+	})();
+}
+
 // eslint-disable-next-line unicorn/prevent-abbreviations
 export function devTools(win = BrowserWindow.getFocusedWindow()) {
 	if (win) {
@@ -28,7 +67,7 @@ export function devTools(win = BrowserWindow.getFocusedWindow()) {
 // eslint-disable-next-line unicorn/prevent-abbreviations
 export function openDevTools(win = BrowserWindow.getFocusedWindow()) {
 	if (win) {
-		win.webContents.openDevTools(developmentToolsOptions);
+		win.webContents.openDevTools(developmentToolsOptions.get(win));
 	}
 }
 
@@ -62,30 +101,39 @@ export default function debug(options) {
 		...options,
 	};
 
-	if (options.isEnabled === false || (options.isEnabled === null && !isDev)) {
-		return;
-	}
+	if (!options.windowSelector) {
+		if (!shouldRun(options)) {
+			return;
+		}
 
-	if (options.devToolsMode !== 'previous') {
-		developmentToolsOptions.mode = options.devToolsMode;
+		// When there's no filter, accelerators are defined globally
+		registerAccelerators();
 	}
 
 	app.on('browser-window-created', (event, win) => {
-		if (options.showDevTools) {
-			/// Workaround for https://github.com/electron/electron/issues/12438
-			win.webContents.once('dom-ready', () => {
-				openDevTools(win, options.showDevTools, false);
-			});
-		}
-	});
+		/// Workaround for https://github.com/electron/electron/issues/12438
+		win.webContents.once('dom-ready', () => {
+			const winOptions = getOptionsForWindow(win, options);
 
-	(async () => {
-		await app.whenReady();
+			if (winOptions.devToolsMode !== 'previous') {
+				developmentToolsOptions.set(win, {
+					...developmentToolsOptions.get(win),
+					mode: winOptions.devToolsMode,
+				});
+			}
 
-		localShortcut.register('CommandOrControl+Shift+C', inspectElements);
-		localShortcut.register(isMacOS ? 'Command+Alt+I' : 'Control+Shift+I', devTools);
-		localShortcut.register('F12', devTools);
-		localShortcut.register('CommandOrControl+R', refresh);
-		localShortcut.register('F5', refresh);
-	})();
+			if (!shouldRun(winOptions)) {
+				return;
+			}
+
+			if (winOptions.windowSelector) {
+				// With filters, accelerators are defined for each window depending on their provided options
+				registerAccelerators(win);
+			}
+
+			if (winOptions.showDevTools) {
+				openDevTools(win);
+			}
+		});
+	});
 }

readme.md

@@ -109,6 +109,20 @@ Open DevTools for the specified `BrowserWindow` instance or the focused one.
 Type: `BrowserWindow`\
 Default: The focused `BrowserWindow`
 
+### windowSelector(filter)
+
+Allows to specify customized options for each window.
+
+#### filter
+
+Type: `(window: BrowserWindow) => boolean | Partial<Options>`\
+Default: `() => true` (Use the global options for every window).
+
+It can return:
+- `true`: Means `debug` is enabled for every window with the global options
+- `false`: Disable `debug` for the given window (maintain the global options for the rest)
+- `Partial<Options>`: Object to override the global options just for the given window
+
 ## Related
 
 - [electron-util](https://github.com/sindresorhus/electron-util) - Useful utilities for developing Electron apps and modules