mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: update references to @electron/rebuild (#37757)

Browse source
This commit is contained in:
Erick Zhao 2023-03-31 02:36:59 -07:00 • committed by GitHub
parent 3fa03977c7
commit 4ca6fb3c4e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/tutorial/using-native-node-modules.md
View file

@ -21,17 +21,17 @@ There are several different ways to install native modules:
### Installing modules and rebuilding for Electron ### Installing modules and rebuilding for Electron
You can install modules like other Node projects, and then rebuild the modules You can install modules like other Node projects, and then rebuild the modules
for Electron with the [`electron-rebuild`][electron-rebuild] package. This for Electron with the [`@electron/rebuild`][@electron/rebuild] package. This
module can automatically determine the version of Electron and handle the module can automatically determine the version of Electron and handle the
manual steps of downloading headers and rebuilding native modules for your app. manual steps of downloading headers and rebuilding native modules for your app.
If you are using [Electron Forge][electron-forge], this tool is used automatically If you are using [Electron Forge][electron-forge], this tool is used automatically
in both development mode and when making distributables. in both development mode and when making distributables.
For example, to install the standalone `electron-rebuild` tool and then rebuild For example, to install the standalone `@electron/rebuild` tool and then rebuild
modules with it via the command line: modules with it via the command line:
```sh ```sh
npm install --save-dev electron-rebuild npm install --save-dev @electron/rebuild
# Every time you run "npm install", run this: # Every time you run "npm install", run this:
./node_modules/.bin/electron-rebuild ./node_modules/.bin/electron-rebuild
@ -53,8 +53,7 @@ For example, to install all dependencies for Electron:
```sh ```sh
# Electron's version. # Electron's version.
export npm_config_target=1.2.3 export npm_config_target=1.2.3
# The architecture of Electron, see https://electronjs.org/docs/tutorial/support#supported-platforms # The architecture of your machine
# for supported architectures.
export npm_config_arch=x64 export npm_config_arch=x64
export npm_config_target_arch=x64 export npm_config_target_arch=x64
# Download headers for Electron. # Download headers for Electron.
@ -98,7 +97,7 @@ npm rebuild --nodedir=/path/to/src/out/Default/gen/node_headers
If you installed a native module and found it was not working, you need to check If you installed a native module and found it was not working, you need to check
the following things: the following things:
* When in doubt, run `electron-rebuild` first. * When in doubt, run `@electron/rebuild` first.
* Make sure the native module is compatible with the target platform and * Make sure the native module is compatible with the target platform and
architecture for your Electron app. architecture for your Electron app.
* Make sure `win_delay_load_hook` is not set to `false` in the module's `binding.gyp`. * Make sure `win_delay_load_hook` is not set to `false` in the module's `binding.gyp`.
@ -161,14 +160,14 @@ modules with prebuilt binaries, and many popular modules are using it.
Sometimes those modules work fine under Electron, but when there are no Sometimes those modules work fine under Electron, but when there are no
Electron-specific binaries available, you'll need to build from source. Electron-specific binaries available, you'll need to build from source.
Because of this, it is recommended to use `electron-rebuild` for these modules. Because of this, it is recommended to use `@electron/rebuild` for these modules.
If you are following the `npm` way of installing modules, you'll need to pass If you are following the `npm` way of installing modules, you'll need to pass
`--build-from-source` to `npm`, or set the `npm_config_build_from_source` `--build-from-source` to `npm`, or set the `npm_config_build_from_source`
environment variable. environment variable.
[abi]: https://en.wikipedia.org/wiki/Application_binary_interface [abi]: https://en.wikipedia.org/wiki/Application_binary_interface
[electron-rebuild]: https://github.com/electron/electron-rebuild [@electron/rebuild]: https://github.com/electron/rebuild
[electron-forge]: https://electronforge.io/ [electron-forge]: https://electronforge.io/
[electron-packager]: https://github.com/electron/electron-packager [electron-packager]: https://github.com/electron/electron-packager
[node-pre-gyp]: https://github.com/mapbox/node-pre-gyp [node-pre-gyp]: https://github.com/mapbox/node-pre-gyp