English | 中文
Install Chrome extension for Electron, support
cjs
/esm
.
This library is based on Samuel Attard's electron-devtools-installer and JonLuca De Caro's electron-extension-installer, with some modifications and added small features. It provides support for esm
and cjs
to support for Electron v28+
.
For Chrome DevTools installation, please visit the Official Documentation.
cjs
/esm
Electron v28+
to use esm
# pnpm
pnpm add @tomjs/electron-devtools-installer
# yarn
yarn add @tomjs/electron-devtools-installer
# npm
npm add @tomjs/electron-devtools-installer
import { app } from 'electron';
import { installExtension, VUEJS_DEVTOOLS } from '@tomjs/electron-devtools-installer';
// Install Vue.js DevTools
app.whenReady().then(() => {
installExtension(VUEJS_DEVTOOLS) // equals to installExtension("nhdogjmejiglipccpnnnanhbledajbpd")
.then(ext => console.log(`Added Extension: ${ext.name}`))
.catch(err => console.log('An error occurred: ', err));
});
const { app } = require('electron');
const { installExtension, VUEJS_DEVTOOLS } = require('@tomjs/electron-devtools-installer');
// Install Vue.js DevTools
app.whenReady().then(() => {
installExtension(VUEJS_DEVTOOLS)
.then(ext => console.log(`Added Extension: ${ext.name}`))
.catch(err => console.log('An error occurred: ', err));
});
The following is a list of preset Chrome extensions ID:
ID | Name |
---|---|
ANGULAR_DEVTOOLS |
Angular DevTools |
APOLLO_CLIENT_TOOLS |
Apollo Client Devtools |
BACKBONE_DEBUGGER |
Backbone Debugger |
EMBER_INSPECTOR |
Ember Inspector |
JQUERY_DEBUGGER |
jQuery Debugger |
MOBX_DEVTOOLS |
MobX DevTools |
REACT_DEVELOPER_TOOLS |
React Developer Tools |
REDUX_DEVTOOLS |
Redux DevTools |
VUEJS_DEVTOOLS |
Vue.js DevTools |
VUEJS_DEVTOOLS_BETA |
Vue.js devtools (beta) |
install chrome extension for electron
string | string[]
- Chrome extension idboolean
- Force to download the extension even if it's already installed, default is false
'chrome' | 'unpkg' | 'jsdelivr' | 'npmmirror'
- Download url source. When the OS language is zh_CN
, the default value is npmmirror
, otherwise it is chrome
.'string' | 'Electron.Session'
- The target session on which the extension shall be installed, default is session.defaultSession
.Returns Promise<Electron.Extension | Electron.Extension[]>
- extension name/version, etc.
download chrome extension for electron
string
- Chrome extension idboolean
- Force to download the extension even if it's already installed, default is false
boolean
- Whether to unzip the downloaded file, default is true
number
- Number of attempts to download the extension, default is 5
string
- The path to save the downloaded extension, default is path.join(app.getPath('userData'), 'extensions')
'chrome' | 'unpkg' | 'jsdelivr' | 'npmmirror'
- Download url source. When the OS language is zh_CN
, the default value is npmmirror
, otherwise it is chrome
.Returns Promise<{ filePath: string; unzipPath?: string }>
pnpm jest --verbose false