@holochain/hc-spin 0.100.0

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

package/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+out
+.gitignore

package/.eslintrc

@@ -0,0 +1,31 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "parser": "@typescript-eslint/parser",
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "env": {
+    "browser": true,
+    "es2017": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "prettier",
+    "@electron-toolkit/eslint-config-ts/recommended",
+    "@electron-toolkit/eslint-config-prettier"
+  ],
+  "plugins": ["@typescript-eslint", "prettier", "simple-import-sort"],
+  "rules": {
+    "prettier/prettier": "error",
+    "vue/attribute-hyphenation": "off",
+    "vue/no-multiple-template-root": "off",
+    "vue/multi-word-component-names": "off",
+    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "@typescript-eslint/explicit-function-return-type": "off"
+  }
+}

package/.prettierignore

@@ -0,0 +1,6 @@
+out
+dist
+pnpm-lock.yaml
+LICENSE.md
+tsconfig.json
+tsconfig.*.json

package/.prettierrc.yaml

@@ -0,0 +1,3 @@
+singleQuote: true
+semi: true
+printWidth: 100

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["dbaeumer.vscode-eslint"]
+}

package/.vscode/launch.json

@@ -0,0 +1,39 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Main Process",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceRoot}",
+      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron-vite",
+      "windows": {
+        "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron-vite.cmd"
+      },
+      "runtimeArgs": ["--sourcemap"],
+      "env": {
+        "REMOTE_DEBUGGING_PORT": "9222"
+      }
+    },
+    {
+      "name": "Debug Renderer Process",
+      "port": 9222,
+      "request": "attach",
+      "type": "chrome",
+      "webRoot": "${workspaceFolder}/src/renderer",
+      "timeout": 60000,
+      "presentation": {
+        "hidden": true
+      }
+    }
+  ],
+  "compounds": [
+    {
+      "name": "Debug All",
+      "configurations": ["Debug Main Process", "Debug Renderer Process"],
+      "presentation": {
+        "order": 1
+      }
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "editor.formatOnSave": true,
+}

package/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/README.md

@@ -0,0 +1,61 @@
+# hc-spin
+
+CLI to run Holochain apps in development mode.
+
+## Installation
+
+To install the latest version compatible with holochain 0.1.x:
+
+```
+npm install --save-dev @holochain/hc-spin@">=0.100.0 <0.200.0"
+```
+
+To install the latest version compatible with holochain 0.2.x:
+
+```
+npm install --save-dev @holochain/hc-spin@">=0.200.0 <0.300.0"
+```
+
+## Usage
+
+```
+Usage: hc-spin [options] <path>
+
+CLI to run Holochain aps during development.
+
+Arguments:
+  path                       Path to .webhapp or .happ file to launch. If a .happ file is passed, either a UI path must be specified via
+                             --ui-path or a port pointing to a localhost server via --ui-port
+
+Options:
+  -V, --version              output the version number
+  --app-id <string>          Install the app with a specific app id. By default the app id is derived from the name of the .webhapp/.happ
+                             file that you pass but this option allows you to set it explicitly
+                             but this argument allows you to specify a custom one.
+  --holochain-path <path>    Set the path to the holochain binary [default: holochain].
+  -n, --num-agents <number>  How many agents to spawn the app for.
+  --ui-path <path>           Path to the folder containing the index.html of the webhapp's UI.
+  --ui-port <number>         Port pointing to a localhost dev server that serves your UI assets.
+                             but this argument allows you to specify a custom one.
+  -h, --help                 display help for command
+```
+
+## Example Commands
+
+Run a .happ file with 2 agents connected to the UI of your dev server running on port 8888:
+
+```
+hc-spin -n 2 --ui-port 8888 path/to/your/happ-file.happ
+```
+
+Run a fully packaged .webhapp for 2 agents:
+
+```
+hc-spin -n 2 path/to/your/webhapp-file.webhapp
+```
+
+Run a .happ file with 2 agents connected to the UI assets residing at the provided path:
+
+```
+hc-spin -n 2 --ui-path path/to/directory/containing/ui/assets path/to/your/happ-file.happ
+```

package/build/entitlements.mac.plist

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.allow-dyld-environment-variables</key>
+    <true/>
+  </dict>
+</plist>

package/cli/cli.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+const { spawn } = 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;
+  }
+}
+
+if (!electronBinary) {
+  throw new Error('Failed to locate electron binary. __dirname: ', __dirname);
+}
+
+const child = spawn(
+  electronBinary,
+  [path.resolve(__dirname, 'main/index.js'), ...process.argv.slice(2)],
+  {
+    stdio: 'inherit',
+  },
+);
+
+// Handle child process exit
+child.on('exit', (code, _signal) => {
+  process.exit(code);
+});

package/dist/cli.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+const { spawn } = 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;
+  }
+}
+
+if (!electronBinary) {
+  throw new Error('Failed to locate electron binary. __dirname: ', __dirname);
+}
+
+const child = spawn(
+  electronBinary,
+  [path.resolve(__dirname, 'main/index.js'), ...process.argv.slice(2)],
+  {
+    stdio: 'inherit',
+  },
+);
+
+// Handle child process exit
+child.on('exit', (code, _signal) => {
+  process.exit(code);
+});