@holochain/hc-spin 0.300.2 → 0.300.4

package/README.md

@@ -4,31 +4,23 @@ CLI to run Holochain apps in development mode.
 
 ## Installation
 
-To install the latest version compatible with **holochain 0.1.x**:
-
-⚠️ Requires `@holochain/client 0.12.6` or newer ⚠️
-
-```
-npm install --save-dev @holochain/hc-spin@">=0.100.0 <0.200.0"
-```
-
-To install the latest version compatible with **holochain 0.2.x**:
+To install the latest version compatible with **holochain 0.3.x**:
 
-⚠️ Requires `@holochain/client 0.16.2` or newer ⚠️
+⚠️ Requires `@holochain/client 0.17.0-dev.5` or newer ⚠️
 
 ```
-npm install --save-dev @holochain/hc-spin@">=0.200.0 <0.300.0"
+npm install --save-dev @holochain/hc-spin@">=0.300.0 <0.400.0"
 ```
 
-To install the latest version compatible with **holochain 0.3.x**:
+To install the latest version compatible with **holochain 0.4.x**:
 
-⚠️ Requires `@holochain/client 0.17.0-dev.5` or newer ⚠️
+⚠️ Requires `@holochain/client 0.18.0-rc.1` or newer ⚠️
 
 ```
-npm install --save-dev @holochain/hc-spin@">=0.300.0 <0.400.0"
+npm install --save-dev @holochain/hc-spin@">=0.400.0 <0.500.0"
 ```
 
-## Usage (holochain 0.2)
+## Usage (holochain 0.4)
 
 ```
 Usage: hc-spin [options] <path>
@@ -52,6 +44,7 @@ Options:
   --ui-port <number>         Port pointing to a localhost dev server that serves your UI assets.
   --signaling-url <url>      Url of the signaling server to use. By default, hc spin spins up a local development signaling server for you
                              but this argument allows you to specify a custom one.
+  --open-devtools            Automatically open the devtools on startup.
   -h, --help                 display help for command
 ```
 

package/cli/cli.js

@@ -1,18 +1,40 @@
 #!/usr/bin/env node
-const { spawn } = require('child_process');
+const { spawn, spawnSync } = require('child_process');
 const path = require('path');
 const fs = require('fs');
 
-let electronBinary;
-let pathStr = '../node_modules/.bin/electron';
-// recursively look for electron binary in node_modules folder
-for (let i = 0; i < 7; i++) {
-  const maybeElectronBinary = path.resolve(__dirname, pathStr);
-  if (fs.existsSync(maybeElectronBinary)) {
-    electronBinary = maybeElectronBinary;
-    break;
-  } else {
-    pathStr = '../' + pathStr;
+let electronBinary = process.env.ELECTRON_BINARY;
+
+if (!electronBinary) {
+  // Check whether electron is installed globally and compare with the expected version
+  const electronHandleTemp = spawnSync('electron', ['--version']);
+
+  if (electronHandleTemp.stdout) {
+    if (!electronHandleTemp.stdout.toString().startsWith('v###REPLACE_AT_BUILD_TIME###')) {
+      console.warn(
+        'WARNING: Found a globally installed electron version but it does not match the version requirements of hc-spin (v29.x). The electron binary from node_modules will be used instead.',
+      );
+    } else {
+      electronBinary = 'electron';
+    }
+  }
+
+  if (!electronBinary) {
+    let pathStr =
+      process.platform === 'win32'
+        ? '../node_modules/electron/dist/electron.exe'
+        : '../node_modules/.bin/electron';
+
+    // recursively look for electron binary in node_modules folder
+    for (let i = 0; i < 7; i++) {
+      const maybeElectronBinary = path.resolve(__dirname, pathStr);
+      if (fs.existsSync(maybeElectronBinary)) {
+        electronBinary = maybeElectronBinary;
+        break;
+      } else {
+        pathStr = '../' + pathStr;
+      }
+    }
   }
 }
 

package/dist/cli.js

@@ -1,18 +1,40 @@
 #!/usr/bin/env node
-const { spawn } = require('child_process');
+const { spawn, spawnSync } = require('child_process');
 const path = require('path');
 const fs = require('fs');
 
-let electronBinary;
-let pathStr = '../node_modules/.bin/electron';
-// recursively look for electron binary in node_modules folder
-for (let i = 0; i < 7; i++) {
-  const maybeElectronBinary = path.resolve(__dirname, pathStr);
-  if (fs.existsSync(maybeElectronBinary)) {
-    electronBinary = maybeElectronBinary;
-    break;
-  } else {
-    pathStr = '../' + pathStr;
+let electronBinary = process.env.ELECTRON_BINARY;
+
+if (!electronBinary) {
+  // Check whether electron is installed globally and compare with the expected version
+  const electronHandleTemp = spawnSync('electron', ['--version']);
+
+  if (electronHandleTemp.stdout) {
+    if (!electronHandleTemp.stdout.toString().startsWith('v29.')) {
+      console.warn(
+        'WARNING: Found a globally installed electron version but it does not match the version requirements of hc-spin (v29.x). The electron binary from node_modules will be used instead.',
+      );
+    } else {
+      electronBinary = 'electron';
+    }
+  }
+
+  if (!electronBinary) {
+    let pathStr =
+      process.platform === 'win32'
+        ? '../node_modules/electron/dist/electron.exe'
+        : '../node_modules/.bin/electron';
+
+    // recursively look for electron binary in node_modules folder
+    for (let i = 0; i < 7; i++) {
+      const maybeElectronBinary = path.resolve(__dirname, pathStr);
+      if (fs.existsSync(maybeElectronBinary)) {
+        electronBinary = maybeElectronBinary;
+        break;
+      } else {
+        pathStr = '../' + pathStr;
+      }
+    }
   }
 }