@electron/rebuild

What is @electron/rebuild?

@electron/rebuild is a tool designed to help developers rebuild native Node.js modules against the current Electron version. This is particularly useful when working with native modules that need to be compatible with Electron's version of Node.js.

What are @electron/rebuild's main functionalities?

Rebuild Native Modules

This feature allows you to rebuild native Node.js modules to be compatible with a specific version of Electron. The code sample demonstrates how to use the `rebuild` function to rebuild modules in the current directory for Electron version 13.1.7.

const { rebuild } = require('@electron/rebuild');

rebuild({
  buildPath: __dirname,
  electronVersion: '13.1.7'
}).then(() => {
  console.log('Rebuild complete!');
}).catch((err) => {
  console.error('Rebuild failed:', err);
});

CLI Usage

You can also use @electron/rebuild from the command line to rebuild native modules. This command rebuilds the modules for Electron version 13.1.7.

npx electron-rebuild -v 13.1.7

Rebuild Specific Modules

This feature allows you to rebuild specific native modules rather than all modules in the project. The code sample demonstrates how to rebuild only the 'native-module' for Electron version 13.1.7.

const { rebuild } = require('@electron/rebuild');

rebuild({
  buildPath: __dirname,
  electronVersion: '13.1.7',
  onlyModules: ['native-module']
}).then(() => {
  console.log('Rebuild complete!');
}).catch((err) => {
  console.error('Rebuild failed:', err);
});

Other packages similar to @electron/rebuild

electron-builder

electron-builder is a complete solution to package and build a ready-for-distribution Electron app. It includes support for rebuilding native modules, but also offers a wide range of other features such as auto-updates, code signing, and multi-platform builds. Compared to @electron/rebuild, electron-builder is more comprehensive but also more complex.

node-gyp

node-gyp is a cross-platform command-line tool written in Node.js for compiling native addon modules for Node.js. While it can be used to rebuild native modules, it does not specifically target Electron and lacks the convenience features of @electron/rebuild. It requires more manual configuration and is generally used as a lower-level tool.

README

The README file is missing