github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat: add env variable to skip binary download on npm install (backport) (#20438)

Browse Source 
* feat: add env variable to skip binary download on npm install

* docs: add "Skip binary download" section to install tutorial
This commit is contained in:
Joshua Westerheide
2019-10-07 19:04:00 +02:00
committed by John Kleinschmidt
parent 15e611a0ff
commit 28eb7b0532
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/tutorial/installation.md
View File

@@ -97,6 +97,17 @@ a text file. A typical cache might look like this:
├── SHASUMS256.txt-1.8.2-beta.3
```
## Skip binary download
When installing the `electron` NPM package, it automatically downloads the electron binary.
This can sometimes be unnecessary, e.g. in a CI environment, when testing another component.
To prevent the binary from being downloaded when you install all npm dependencies you can set the environment variable `ELECTRON_SKIP_BINARY_DOWNLOAD`.
E.g.:
```sh
ELECTRON_SKIP_BINARY_DOWNLOAD=1 npm install
```
## Troubleshooting
When running `npm install electron`, some users occasionally encounter

4
npm/install.js
View File

@@ -15,6 +15,10 @@ try {
// do nothing
}
if (process.env.ELECTRON_SKIP_BINARY_DOWNLOAD) {
process.exit(0)
}
var platformPath = getPlatformPath()
var electronPath = process.env.ELECTRON_OVERRIDE_DIST_PATH || path.join(__dirname, 'dist', platformPath)