Add devtron via preload script (sindresorhus#82)

JanMalch · sindresorhus · web-flow · commit b8dc0cf4fb27 · 2020-12-21T20:01:07.000+07:00
Co-authored-by: Sindre Sorhus &lt;sindresorhus@gmail.com&gt;
diff --git a/index.d.ts b/index.d.ts
@@ -68,6 +68,13 @@ declare const electronDebug: {
 	@param window - Default: `BrowserWindow.getFocusedWindow()`
 	*/
 	openDevTools(window?: BrowserWindow): void;
+
+	/**
+	The absolute path to a preload script to use in [`session#setPreloads()`](https://www.electronjs.org/docs/api/session#sessetpreloadspreloads).
+
+	Use it to enable `devtron` even when [`nodeIntegration`](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions) is turned off.
+	*/
+	preloadScriptPath: string;
 };
 
 export = electronDebug;
diff --git a/index.js b/index.js
@@ -1,5 +1,6 @@
 'use strict';
 const {app, BrowserWindow, session} = require('electron');
+const path = require('path');
 const localShortcut = require('electron-localshortcut');
 const isDev = require('electron-is-dev');
 
@@ -120,3 +121,4 @@ module.exports = options => {
 module.exports.refresh = refresh;
 module.exports.devTools = devTools;
 module.exports.openDevTools = openDevTools;
+module.exports.preloadScriptPath = path.join(__dirname, 'preload.js');
diff --git a/preload.js b/preload.js
@@ -0,0 +1 @@
+window.__devtron = {require, process};
diff --git a/readme.md b/readme.md
@@ -33,6 +33,7 @@ Open DevTools and focus the Element Inspector tool.
 Just install any of these extension and they'll be activated for you:
 
 - [devtron](https://electronjs.org/devtron) - The official Electron DevTools extension
+	- You need to use [`preloadScriptPath`](#preloadScriptPath) if the `BrowserWindow`'s `nodeIntegration` is off.
 - [electron-react-devtools](https://github.com/firejune/electron-react-devtools) - React DevTools extension for Electron
 
 ## Install
@@ -116,6 +117,14 @@ Open DevTools for the specified `BrowserWindow` instance or the focused one.
 Type: `BrowserWindow`\
 Default: The focused `BrowserWindow`
 
+### preloadScriptPath
+
+Type: `string`
+
+The absolute path to a preload script to use in [`session#setPreloads()`](https://www.electronjs.org/docs/api/session#sessetpreloadspreloads).
+
+Use it to enable `devtron` even when [`nodeIntegration`](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions) is turned off.
+
 ## Related
 
 - [electron-util](https://github.com/sindresorhus/electron-util) - Useful utilities for developing Electron apps and modules
