This executable rebuilds native Node.js modules against the version of Node.js that your Electron project is using. This allows you to use native Node.js modules in Electron apps without your system version of Node.js matching exactly (which is often not the case, and sometimes not even possible).
How does it work?
Install the package with
npm install --save-dev electron-rebuild
Then, whenever you install a new npm package, rerun electron-rebuild:
Or if you're on Windows:
If you have a good node-gyp config but you see an error about a missing element on Windows like
Could not load the Visual C++ component "VCBuild.exe", try to launch electron-rebuild in an npm script:
npm run rebuild
What are the requirements?
Node v6.0.0 or higher is required. Building the extensions use
refer to the link for its installation:runtime requirements.
Usage: electron-rebuild --version [version] --module-dir [path] Options: -h, --help Show help [boolean] -v, --version The version of Electron to build against -f, --force Force rebuilding modules, even if we would skip it otherwise -a, --arch Override the target architecture to something other than your system's -m, --module-dir The path to the app directory to rebuild -w, --which-module A specific module to build, or comma separated list of modules -e, --electron-prebuilt-dir The path to electron-prebuilt -d, --dist-url Custom header tarball URL -t, --types The types of dependencies to rebuild. Comma separated list of "prod", "dev" and "optional". Default is "prod,optional" -p, --parallel Rebuild in parallel, this is enabled by default on macOS and Linux -s, --sequential Rebuild modules sequentially, this is enabled by default on Windows -o, --only Only build specified module, or comma separated list of modules. All others are ignored. -b, --debug Build debug version of modules Copyright 2016
This package is automatically used with Electron Forge when packaging an Electron app.
electron-rebuild provides a function compatible with the
for Electron Packager. For example:
If your module uses prebuild for creating prebuilt binaries it also uses prebuild-install to download them. If this is the case then
electron-rebuild will run
prebuild-install to download the correct binaries from github instead of rebuilding them.
How can I integrate this into Grunt / Gulp / Whatever?
electron-rebuild is also a library that you can just require into your app or build process. It has a very simple API:
;// Public: Rebuilds a node_modules directory with the given Electron version.//// options: Object with the following properties// buildPath - An absolute path to your app's directory. (The directory that contains your node_modules)// electronVersion - The version of Electron to rebuild for// arch (optional) - Default: process.arch - The arch to rebuild for// extraModules (optional) - Default:  - An array of modules to rebuild as well as the detected modules// onlyModules (optional) - Default: null - An array of modules to rebuild, ONLY these module names will be rebuilt.// The "types" property will be ignored if this option is set.// force (optional) - Default: false - Force a rebuild of modules regardless of their current build state// headerURL (optional) - Default: atom.io/download/electron - The URL to download Electron header files from// types (optional) - Default: ['prod', 'optional'] - The types of modules to rebuild// mode (optional) - The rebuild mode, either 'sequential' or 'parallel' - Default varies per platform (probably shouldn't mess with this one)// Returns a Promise indicating whether the operation succeeded or not
A full build process might look something like:
let childProcess = ;let pathToElectron = ;;
- require-rebuild patches
require()to rebuild native node modules on the fly