@electron/rebuild 0.0.0 → 3.2.10

package/README.md

@@ -0,0 +1,158 @@
+## Electron Rebuild
+
+[![CircleCI](https://circleci.com/gh/electron/rebuild.svg?style=svg)](https://circleci.com/gh/electron/rebuild)
+[![NPM](https://img.shields.io/npm/v/@electron/rebuild.svg?style=flat)](https://npm.im/@electron/rebuild)
+[![Coverage Status](https://codecov.io/gh/electron/rebuild/branch/main/graph/badge.svg)](https://codecov.io/gh/electron/rebuild)
+
+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 `--save-dev`:
+
+```sh
+npm install --save-dev @electron/rebuild
+```
+
+Then, whenever you install a new npm package, rerun electron-rebuild:
+
+```sh
+$(npm bin)/electron-rebuild
+```
+
+Or if you're on Windows:
+
+```sh
+.\node_modules\.bin\electron-rebuild.cmd
+```
+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:
+
+```json
+"scripts": {
+  "rebuild": "electron-rebuild -f -w yourmodule"
+}
+```
+
+and then
+
+```sh
+npm run rebuild
+```
+
+### What are the requirements?
+
+Node v12.13.0 or higher is required. Building native modules from source uses
+[`node-gyp`](https://github.com/nodejs/node-gyp#installation), refer to the link for its
+installation/runtime requirements.
+
+### CLI Arguments
+
+```
+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. Modules will only be rebuilt if they
+                               also match the types of dependencies being rebuilt
+                               (see --types).
+  -e, --electron-prebuilt-dir  The path to the prebuilt electron module
+  -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
+  --prebuild-tag-prefix        GitHub tag prefix passed to prebuild-install.
+                               Default is "v"
+
+Copyright 2016
+```
+
+### How can I use this with [Electron Forge](https://github.com/electron/forge)?
+
+This package is automatically used with Electron Forge when packaging an Electron app.
+
+### How can I integrate this into [Electron Packager](https://github.com/electron/electron-packager)?
+
+electron-rebuild provides a function compatible with the [`afterCopy` hook](https://electron.github.io/electron-packager/main/interfaces/electronpackager.options.html#aftercopy)
+for Electron Packager. For example:
+
+```javascript
+import packager from 'electron-packager';
+import rebuild from '@electron/rebuild';
+
+packager({
+  // … other options
+  afterCopy: [(buildPath, electronVersion, platform, arch, callback) => {
+    rebuild({ buildPath, electronVersion, arch })
+      .then(() => callback())
+      .catch((error) => callback(error));
+  }],
+  // … other options
+});
+```
+
+### How can I integrate this with [prebuild](https://github.com/prebuild/prebuild)?
+
+If your module uses [prebuild](https://github.com/prebuild/prebuild) for creating prebuilt binaries,
+it also uses [prebuild-install](https://github.com/prebuild/prebuild-install) to download them. If
+this is the case, then `electron-rebuild` will run `prebuild-install` to download the correct
+binaries from the project's GitHub Releases instead of rebuilding them.
+
+### How can I integrate this into Grunt / Gulp / Whatever?
+
+electron-rebuild is also a library that you can require into your app or
+build process. It has a very simple API:
+
+```javascript
+import rebuild from '@electron/rebuild';
+
+// 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: https://www.electronjs.org/headers - 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)
+//     useElectronClang (optional) - Whether to use the clang executable that Electron used when building its binary. This will guarantee compiler compatibility
+
+// Returns a Promise indicating whether the operation succeeded or not
+```
+
+A full build process might look something like:
+
+```javascript
+const childProcess = require('child_process');
+const pathToElectron = require('electron');
+
+  rebuild({
+    buildPath: __dirname,
+    electronVersion: '1.4.12'
+  })
+    .then(() => console.info('Rebuild Successful'))
+    .catch((e) => {
+      console.error("Building modules didn't work!");
+      console.error(e);
+    });
+```

package/lib/src/arch.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Runs the `uname` command and returns the trimmed output.
+ *
+ * Copied from `@electron/get`.
+ */
+export declare function uname(): string;
+export declare type ConfigVariables = {
+    arm_version?: string;
+};
+/**
+ * Generates an architecture name that would be used in an Electron or Node.js
+ * download file name.
+ *
+ * Copied from `@electron/get`.
+ */
+export declare function getNodeArch(arch: string, configVariables: ConfigVariables): string;

package/lib/src/arch.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNodeArch = exports.uname = void 0;
+const child_process_1 = require("child_process");
+/**
+ * Runs the `uname` command and returns the trimmed output.
+ *
+ * Copied from `@electron/get`.
+ */
+function uname() {
+    return (0, child_process_1.execSync)('uname -m')
+        .toString()
+        .trim();
+}
+exports.uname = uname;
+/**
+ * Generates an architecture name that would be used in an Electron or Node.js
+ * download file name.
+ *
+ * Copied from `@electron/get`.
+ */
+function getNodeArch(arch, configVariables) {
+    if (arch === 'arm') {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        switch (configVariables.arm_version) {
+            case '6':
+                return uname();
+            case '7':
+            default:
+                return 'armv7l';
+        }
+    }
+    return arch;
+}
+exports.getNodeArch = getNodeArch;
+//# sourceMappingURL=arch.js.map

package/lib/src/arch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arch.js","sourceRoot":"","sources":["../../src/arch.ts"],"names":[],"mappings":";;;AAAA,iDAAyC;AAEzC;;;;GAIG;AACH,SAAgB,KAAK;IACnB,OAAO,IAAA,wBAAQ,EAAC,UAAU,CAAC;SACxB,QAAQ,EAAE;SACV,IAAI,EAAE,CAAC;AACZ,CAAC;AAJD,sBAIC;AAMD;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,IAAY,EAAE,eAAgC;IACxE,IAAI,IAAI,KAAK,KAAK,EAAE;QAClB,8DAA8D;QAC9D,QAAQ,eAAe,CAAC,WAAW,EAAE;YACnC,KAAK,GAAG;gBACN,OAAO,KAAK,EAAE,CAAC;YACjB,KAAK,GAAG,CAAC;YACT;gBACE,OAAO,QAAQ,CAAC;SACnB;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAbD,kCAaC"}

package/lib/src/cache.d.ts

@@ -0,0 +1,13 @@
+declare type CacheOptions = {
+    ABI: string;
+    arch: string;
+    debug: boolean;
+    electronVersion: string;
+    headerURL: string;
+    modulePath: string;
+};
+export declare const cacheModuleState: (dir: string, cachePath: string, key: string) => Promise<void>;
+declare type ApplyDiffFunction = (dir: string) => Promise<void>;
+export declare const lookupModuleState: (cachePath: string, key: string) => Promise<ApplyDiffFunction | boolean>;
+export declare function generateCacheKey(opts: CacheOptions): Promise<string>;
+export {};

package/lib/src/cache.js

@@ -0,0 +1,153 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateCacheKey = exports.lookupModuleState = exports.cacheModuleState = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const debug_1 = __importDefault(require("debug"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const zlib_1 = __importDefault(require("zlib"));
+const d = (0, debug_1.default)('electron-rebuild');
+// Update this number if you change the caching logic to ensure no bad cache hits
+const ELECTRON_REBUILD_CACHE_ID = 1;
+class Snap {
+    constructor(hash, data) {
+        this.hash = hash;
+        this.data = data;
+    }
+}
+const takeSnapshot = async (dir, relativeTo = dir) => {
+    const snap = {};
+    await Promise.all((await fs_extra_1.default.readdir(dir)).map(async (child) => {
+        if (child === 'node_modules')
+            return;
+        const childPath = path_1.default.resolve(dir, child);
+        const relative = path_1.default.relative(relativeTo, childPath);
+        if ((await fs_extra_1.default.stat(childPath)).isDirectory()) {
+            snap[relative] = await takeSnapshot(childPath, relativeTo);
+        }
+        else {
+            const data = await fs_extra_1.default.readFile(childPath);
+            snap[relative] = new Snap(crypto_1.default.createHash('SHA256').update(data).digest('hex'), data);
+        }
+    }));
+    return snap;
+};
+const writeSnapshot = async (diff, dir) => {
+    for (const key in diff) {
+        if (diff[key] instanceof Snap) {
+            await fs_extra_1.default.mkdirp(path_1.default.dirname(path_1.default.resolve(dir, key)));
+            await fs_extra_1.default.writeFile(path_1.default.resolve(dir, key), diff[key].data);
+        }
+        else {
+            await fs_extra_1.default.mkdirp(path_1.default.resolve(dir, key));
+            await writeSnapshot(diff[key], dir);
+        }
+    }
+};
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const serialize = (snap) => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const jsonReady = {};
+    for (const key in snap) {
+        if (snap[key] instanceof Snap) {
+            const s = snap[key];
+            jsonReady[key] = {
+                __isSnap: true,
+                hash: s.hash,
+                data: s.data.toString('base64')
+            };
+        }
+        else {
+            jsonReady[key] = serialize(snap[key]);
+        }
+    }
+    return jsonReady;
+};
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const unserialize = (jsonReady) => {
+    const snap = {};
+    for (const key in jsonReady) {
+        if (jsonReady[key].__isSnap) {
+            snap[key] = new Snap(jsonReady[key].hash, Buffer.from(jsonReady[key].data, 'base64'));
+        }
+        else {
+            snap[key] = unserialize(jsonReady[key]);
+        }
+    }
+    return snap;
+};
+const cacheModuleState = async (dir, cachePath, key) => {
+    const snap = await takeSnapshot(dir);
+    const moduleBuffer = Buffer.from(JSON.stringify(serialize(snap)));
+    const zipped = await new Promise(resolve => zlib_1.default.gzip(moduleBuffer, (_, result) => resolve(result)));
+    await fs_extra_1.default.mkdirp(cachePath);
+    await fs_extra_1.default.writeFile(path_1.default.resolve(cachePath, key), zipped);
+};
+exports.cacheModuleState = cacheModuleState;
+const lookupModuleState = async (cachePath, key) => {
+    if (await fs_extra_1.default.pathExists(path_1.default.resolve(cachePath, key))) {
+        return async function applyDiff(dir) {
+            const zipped = await fs_extra_1.default.readFile(path_1.default.resolve(cachePath, key));
+            const unzipped = await new Promise(resolve => { zlib_1.default.gunzip(zipped, (_, result) => resolve(result)); });
+            const diff = unserialize(JSON.parse(unzipped.toString()));
+            await writeSnapshot(diff, dir);
+        };
+    }
+    return false;
+};
+exports.lookupModuleState = lookupModuleState;
+function dHashTree(tree, hash) {
+    for (const key of Object.keys(tree).sort()) {
+        hash.update(key);
+        if (typeof tree[key] === 'string') {
+            hash.update(tree[key]);
+        }
+        else {
+            dHashTree(tree[key], hash);
+        }
+    }
+}
+async function hashDirectory(dir, relativeTo) {
+    relativeTo !== null && relativeTo !== void 0 ? relativeTo : (relativeTo = dir);
+    d('hashing dir', dir);
+    const dirTree = {};
+    await Promise.all((await fs_extra_1.default.readdir(dir)).map(async (child) => {
+        d('found child', child, 'in dir', dir);
+        // Ignore output directories
+        if (dir === relativeTo && (child === 'build' || child === 'bin'))
+            return;
+        // Don't hash nested node_modules
+        if (child === 'node_modules')
+            return;
+        const childPath = path_1.default.resolve(dir, child);
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const relative = path_1.default.relative(relativeTo, childPath);
+        if ((await fs_extra_1.default.stat(childPath)).isDirectory()) {
+            dirTree[relative] = await hashDirectory(childPath, relativeTo);
+        }
+        else {
+            dirTree[relative] = crypto_1.default.createHash('SHA256').update(await fs_extra_1.default.readFile(childPath)).digest('hex');
+        }
+    }));
+    return dirTree;
+}
+async function generateCacheKey(opts) {
+    const tree = await hashDirectory(opts.modulePath);
+    const hasher = crypto_1.default.createHash('SHA256')
+        .update(`${ELECTRON_REBUILD_CACHE_ID}`)
+        .update(path_1.default.basename(opts.modulePath))
+        .update(opts.ABI)
+        .update(opts.arch)
+        .update(opts.debug ? 'debug' : 'not debug')
+        .update(opts.headerURL)
+        .update(opts.electronVersion);
+    dHashTree(tree, hasher);
+    const hash = hasher.digest('hex');
+    d('calculated hash of', opts.modulePath, 'to be', hash);
+    return hash;
+}
+exports.generateCacheKey = generateCacheKey;
+//# sourceMappingURL=cache.js.map

package/lib/src/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/cache.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,kDAA0B;AAC1B,wDAA0B;AAC1B,gDAAwB;AACxB,gDAAwB;AAExB,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,kBAAkB,CAAC,CAAC;AAEpC,iFAAiF;AACjF,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAEpC,MAAM,IAAI;IACR,YAAmB,IAAY,EAAS,IAAY;QAAjC,SAAI,GAAJ,IAAI,CAAQ;QAAS,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;CACzD;AAiBD,MAAM,YAAY,GAAG,KAAK,EAAE,GAAW,EAAE,UAAU,GAAG,GAAG,EAAqB,EAAE;IAC9E,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,kBAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC5D,IAAI,KAAK,KAAK,cAAc;YAAE,OAAO;QACrC,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,kBAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5C,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SAC5D;aAAM;YACL,MAAM,IAAI,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAC1C,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,CACvB,gBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EACtD,IAAI,CACL,CAAC;SACH;IACH,CAAC,CAAC,CAAC,CAAC;IACJ,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,KAAK,EAAE,IAAc,EAAE,GAAW,EAAiB,EAAE;IACzE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE;YAC7B,MAAM,kBAAE,CAAC,MAAM,CAAC,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;YACtD,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAG,IAAI,CAAC,GAAG,CAAU,CAAC,IAAI,CAAC,CAAC;SACtE;aAAM;YACL,MAAM,kBAAE,CAAC,MAAM,CAAC,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YACxC,MAAM,aAAa,CAAC,IAAI,CAAC,GAAG,CAAa,EAAE,GAAG,CAAC,CAAC;SACjD;KACF;AACH,CAAC,CAAC;AAEF,8DAA8D;AAC9D,MAAM,SAAS,GAAG,CAAC,IAAc,EAAO,EAAE;IACxC,8DAA8D;IAC9D,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE;YAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAS,CAAC;YAC5B,SAAS,CAAC,GAAG,CAAC,GAAG;gBACf,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;aAChC,CAAC;SACH;aAAM;YACL,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAa,CAAC,CAAC;SACnD;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,8DAA8D;AAC9D,MAAM,WAAW,GAAG,CAAC,SAAc,EAAY,EAAE;IAC/C,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE;QAC3B,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;YAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,CAClB,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EACnB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAC3C,CAAC;SACH;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEK,MAAM,gBAAgB,GAAG,KAAK,EAAE,GAAW,EAAE,SAAiB,EAAE,GAAW,EAAiB,EAAE;IACnG,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;IAErC,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrG,MAAM,kBAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3B,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B;AAIK,MAAM,iBAAiB,GAAG,KAAK,EAAE,SAAiB,EAAE,GAAW,EAAwC,EAAE;IAC9G,IAAI,MAAM,kBAAE,CAAC,UAAU,CAAC,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,EAAE;QACrD,OAAO,KAAK,UAAU,SAAS,CAAC,GAAW;YACzC,MAAM,MAAM,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAW,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,cAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChH,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC1D,MAAM,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC;KACH;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAVW,QAAA,iBAAiB,qBAU5B;AAEF,SAAS,SAAS,CAAC,IAAc,EAAE,IAAiB;IAClD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;YACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAW,CAAC,CAAC;SAClC;aAAM;YACL,SAAS,CAAC,IAAI,CAAC,GAAG,CAAa,EAAE,IAAI,CAAC,CAAC;SACxC;KACF;AACH,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAW,EAAE,UAAmB;IAC3D,UAAU,aAAV,UAAU,cAAV,UAAU,IAAV,UAAU,GAAK,GAAG,EAAC;IACnB,CAAC,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;IACtB,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,kBAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC5D,CAAC,CAAC,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QACvC,4BAA4B;QAC5B,IAAI,GAAG,KAAK,UAAU,IAAI,CAAC,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,KAAK,CAAC;YAAE,OAAO;QACzE,iCAAiC;QACjC,IAAI,KAAK,KAAK,cAAc;YAAE,OAAO;QAErC,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3C,oEAAoE;QACpE,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,UAAW,EAAE,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,kBAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5C,OAAO,CAAC,QAAQ,CAAC,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SAChE;aAAM;YACL,OAAO,CAAC,QAAQ,CAAC,GAAG,gBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACpG;IACH,CAAC,CAAC,CAAC,CAAC;IAEJ,OAAO,OAAO,CAAC;AACjB,CAAC;AAEM,KAAK,UAAU,gBAAgB,CAAC,IAAkB;IACvD,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,gBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;SACvC,MAAM,CAAC,GAAG,yBAAyB,EAAE,CAAC;SACtC,MAAM,CAAC,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACtC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;SAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;SACjB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC;SAC1C,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;SACtB,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAChC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,oBAAoB,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACxD,OAAO,IAAI,CAAC;AACd,CAAC;AAdD,4CAcC"}

package/lib/src/clang-fetcher.d.ts

@@ -0,0 +1,4 @@
+export declare function getClangEnvironmentVars(electronVersion: string, targetArch: string): Promise<{
+    env: Record<string, string>;
+    args: string[];
+}>;

package/lib/src/clang-fetcher.js

@@ -0,0 +1,145 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClangEnvironmentVars = void 0;
+const cp = __importStar(require("child_process"));
+const debug_1 = __importDefault(require("debug"));
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const semver_1 = __importDefault(require("semver"));
+const tar = __importStar(require("tar"));
+const zlib = __importStar(require("zlib"));
+const constants_1 = require("./constants");
+const fetcher_1 = require("./fetcher");
+const sysroot_fetcher_1 = require("./sysroot-fetcher");
+const d = (0, debug_1.default)('electron-rebuild');
+const CDS_URL = 'https://commondatastorage.googleapis.com/chromium-browser-clang';
+function getPlatformUrlPrefix(hostOS) {
+    const prefixMap = {
+        'linux': 'Linux_x64',
+        'darwin': 'Mac',
+        'win32': 'Win',
+    };
+    return CDS_URL + '/' + prefixMap[hostOS] + '/';
+}
+function getClangDownloadURL(packageFile, packageVersion, hostOS) {
+    const cdsFile = `${packageFile}-${packageVersion}.tgz`;
+    return getPlatformUrlPrefix(hostOS) + cdsFile;
+}
+function getSDKRoot() {
+    if (process.env.SDKROOT)
+        return process.env.SDKROOT;
+    const output = cp.execFileSync('xcrun', ['--sdk', 'macosx', '--show-sdk-path']);
+    return output.toString().trim();
+}
+async function getClangEnvironmentVars(electronVersion, targetArch) {
+    const clangDownloadDir = await downloadClangVersion(electronVersion);
+    const clangDir = path.resolve(clangDownloadDir, 'bin');
+    const cxxflags = [];
+    const clangArgs = [];
+    if (process.platform === 'darwin') {
+        clangArgs.push('-isysroot', getSDKRoot());
+    }
+    if (semver_1.default.major(electronVersion) >= 20) {
+        cxxflags.push('-std=c++17');
+    }
+    const gypArgs = [];
+    if (process.platform === 'win32') {
+        console.log(fs.readdirSync(clangDir));
+        gypArgs.push(`/p:CLToolExe=clang-cl.exe`, `/p:CLToolPath=${clangDir}`);
+    }
+    if (process.platform === 'linux') {
+        const sysrootPath = await (0, sysroot_fetcher_1.downloadLinuxSysroot)(electronVersion, targetArch);
+        clangArgs.push('--sysroot', sysrootPath);
+    }
+    return {
+        env: {
+            CC: `"${path.resolve(clangDir, 'clang')}" ${clangArgs.join(' ')}`,
+            CXX: `"${path.resolve(clangDir, 'clang++')}" ${clangArgs.join(' ')}`,
+            CFLAGS: `${cxxflags.join(' ')}`,
+            CXXFLAGS: `${cxxflags.join(' ')}`
+        },
+        args: gypArgs,
+    };
+}
+exports.getClangEnvironmentVars = getClangEnvironmentVars;
+function clangVersionFromRevision(update) {
+    const regex = /CLANG_REVISION = '([^']+)'\nCLANG_SUB_REVISION = (\d+)\n/g;
+    const clangVersionMatch = regex.exec(update);
+    if (!clangVersionMatch)
+        return null;
+    const [, clangVersion, clangSubRevision] = clangVersionMatch;
+    return `${clangVersion}-${clangSubRevision}`;
+}
+function clangVersionFromSVN(update) {
+    const regex = /CLANG_REVISION = '([^']+)'\nCLANG_SVN_REVISION = '([^']+)'\nCLANG_SUB_REVISION = (\d+)\n/g;
+    const clangVersionMatch = regex.exec(update);
+    if (!clangVersionMatch)
+        return null;
+    const [, clangVersion, clangSvn, clangSubRevision] = clangVersionMatch;
+    return `${clangSvn}-${clangVersion.substr(0, 8)}-${clangSubRevision}`;
+}
+async function downloadClangVersion(electronVersion) {
+    d('fetching clang for Electron:', electronVersion);
+    const clangDirPath = path.resolve(constants_1.ELECTRON_GYP_DIR, `${electronVersion}-clang`);
+    if (await fs.pathExists(path.resolve(clangDirPath, 'bin', 'clang')))
+        return clangDirPath;
+    if (!await fs.pathExists(constants_1.ELECTRON_GYP_DIR))
+        await fs.mkdirp(constants_1.ELECTRON_GYP_DIR);
+    const electronDeps = await (0, fetcher_1.fetch)(`https://raw.githubusercontent.com/electron/electron/v${electronVersion}/DEPS`, 'text');
+    const chromiumRevisionExtractor = /'chromium_version':\n\s+'([^']+)/g;
+    const chromiumRevisionMatch = chromiumRevisionExtractor.exec(electronDeps);
+    if (!chromiumRevisionMatch)
+        throw new Error('Failed to determine Chromium revision for given Electron version');
+    const chromiumRevision = chromiumRevisionMatch[1];
+    d('fetching clang for Chromium:', chromiumRevision);
+    const base64ClangUpdate = await (0, fetcher_1.fetch)(`https://chromium.googlesource.com/chromium/src.git/+/${chromiumRevision}/tools/clang/scripts/update.py?format=TEXT`, 'text');
+    const clangUpdate = Buffer.from(base64ClangUpdate, 'base64').toString('utf8');
+    const clangVersionString = clangVersionFromRevision(clangUpdate) || clangVersionFromSVN(clangUpdate);
+    if (!clangVersionString)
+        throw new Error('Failed to determine Clang revision from Electron version');
+    d('fetching clang:', clangVersionString);
+    const clangDownloadURL = getClangDownloadURL('clang', clangVersionString, process.platform);
+    const contents = await (0, fetcher_1.fetch)(clangDownloadURL, 'buffer');
+    d('deflating clang');
+    zlib.deflateSync(contents);
+    const tarPath = path.resolve(constants_1.ELECTRON_GYP_DIR, `${electronVersion}-clang.tar`);
+    if (await fs.pathExists(tarPath))
+        await fs.remove(tarPath);
+    await fs.writeFile(tarPath, Buffer.from(contents));
+    await fs.mkdirp(clangDirPath);
+    d('tar running on clang');
+    await tar.x({
+        file: tarPath,
+        cwd: clangDirPath,
+    });
+    await fs.remove(tarPath);
+    d('cleaning up clang tar file');
+    return clangDirPath;
+}
+//# sourceMappingURL=clang-fetcher.js.map

package/lib/src/clang-fetcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clang-fetcher.js","sourceRoot":"","sources":["../../src/clang-fetcher.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAoC;AACpC,kDAA0B;AAC1B,6CAA+B;AAC/B,2CAA6B;AAC7B,oDAA4B;AAC5B,yCAA2B;AAC3B,2CAA6B;AAC7B,2CAA+C;AAC/C,uCAAkC;AAClC,uDAAyD;AAEzD,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,kBAAkB,CAAC,CAAC;AAEpC,MAAM,OAAO,GAAG,iEAAiE,CAAC;AAElF,SAAS,oBAAoB,CAAC,MAAc;IAC1C,MAAM,SAAS,GAAG;QACd,OAAO,EAAE,WAAW;QACpB,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;KACjB,CAAA;IACD,OAAO,OAAO,GAAG,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,GAAG,CAAA;AAChD,CAAC;AAED,SAAS,mBAAmB,CAAC,WAAmB,EAAE,cAAsB,EAAE,MAAc;IACtF,MAAM,OAAO,GAAG,GAAG,WAAW,IAAI,cAAc,MAAM,CAAC;IACvD,OAAO,oBAAoB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;AAChD,CAAC;AAED,SAAS,UAAU;IACjB,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IACpD,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAChF,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;AAClC,CAAC;AAEM,KAAK,UAAU,uBAAuB,CAAC,eAAuB,EAAE,UAAkB;IACvF,MAAM,gBAAgB,GAAG,MAAM,oBAAoB,CAAC,eAAe,CAAC,CAAC;IAErE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACjC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;KAC3C;IACD,IAAI,gBAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE;QACvC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC7B;IAED,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE;QAChC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,iBAAiB,QAAQ,EAAE,CAAC,CAAC;KACxE;IAED,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE;QAChC,MAAM,WAAW,GAAG,MAAM,IAAA,sCAAoB,EAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QAC5E,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;KAC1C;IAED,OAAO;QACL,GAAG,EAAE;YACH,EAAE,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACjE,GAAG,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACpE,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC/B,QAAQ,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;SAClC;QACD,IAAI,EAAE,OAAO;KACd,CAAA;AACH,CAAC;AAjCD,0DAiCC;AAED,SAAS,wBAAwB,CAAC,MAAc;IAC9C,MAAM,KAAK,GAAG,2DAA2D,CAAC;IAC1E,MAAM,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAI,CAAC,iBAAiB;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,CAAC,EAAC,YAAY,EAAE,gBAAgB,CAAC,GAAG,iBAAiB,CAAC;IAC5D,OAAO,GAAG,YAAY,IAAI,gBAAgB,EAAE,CAAC;AAC/C,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAc;IACzC,MAAM,KAAK,GAAG,2FAA2F,CAAC;IAC1G,MAAM,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAI,CAAC,iBAAiB;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,CAAC,EAAC,YAAY,EAAE,QAAQ,EAAE,gBAAgB,CAAC,GAAG,iBAAiB,CAAC;IACtE,OAAO,GAAG,QAAQ,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,gBAAgB,EAAE,CAAC;AACxE,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,eAAuB;IACzD,CAAC,CAAC,8BAA8B,EAAE,eAAe,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,4BAAgB,EAAE,GAAG,eAAe,QAAQ,CAAC,CAAC;IAChF,IAAI,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAAE,OAAO,YAAY,CAAC;IACzF,IAAI,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,4BAAgB,CAAC;QAAE,MAAM,EAAE,CAAC,MAAM,CAAC,4BAAgB,CAAC,CAAC;IAE9E,MAAM,YAAY,GAAG,MAAM,IAAA,eAAK,EAAC,wDAAwD,eAAe,OAAO,EAAE,MAAM,CAAC,CAAC;IACzH,MAAM,yBAAyB,GAAG,mCAAmC,CAAC;IACtE,MAAM,qBAAqB,GAAG,yBAAyB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,IAAI,CAAC,qBAAqB;QAAE,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;IAChH,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,8BAA8B,EAAE,gBAAgB,CAAC,CAAA;IAEnD,MAAM,iBAAiB,GAAG,MAAM,IAAA,eAAK,EAAC,wDAAwD,gBAAgB,4CAA4C,EAAE,MAAM,CAAC,CAAC;IACpK,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE9E,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,WAAW,CAAC,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACrG,IAAI,CAAC,kBAAkB;QAAE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IACrG,CAAC,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC;IAEzC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,OAAO,EAAE,kBAAkB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE5F,MAAM,QAAQ,GAAG,MAAM,IAAA,eAAK,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC,CAAC,iBAAiB,CAAC,CAAC;IACrB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,4BAAgB,EAAE,GAAG,eAAe,YAAY,CAAC,CAAC;IAC/E,IAAI,MAAM,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;QAAE,MAAM,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC1D,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnD,MAAM,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC9B,CAAC,CAAC,sBAAsB,CAAC,CAAC;IAC1B,MAAM,GAAG,CAAC,CAAC,CAAC;QACV,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,YAAY;KAClB,CAAC,CAAC;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC,CAAC,4BAA4B,CAAC,CAAC;IAChC,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/lib/src/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};