accrete-kit 0.1.0 → 0.2.0

package/dist/ui/vendor/ws/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "ws",
+  "version": "8.22.1",
+  "description": "Simple to use, blazing fast and thoroughly tested websocket client and server for Node.js",
+  "keywords": [
+    "HyBi",
+    "Push",
+    "RFC-6455",
+    "WebSocket",
+    "WebSockets",
+    "real-time"
+  ],
+  "homepage": "https://github.com/websockets/ws",
+  "bugs": "https://github.com/websockets/ws/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/websockets/ws.git"
+  },
+  "author": "Einar Otto Stangvik <einaros@gmail.com> (http://2x.io)",
+  "license": "MIT",
+  "main": "index.js",
+  "exports": {
+    ".": {
+      "browser": "./browser.js",
+      "import": "./wrapper.mjs",
+      "require": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "browser": "browser.js",
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "files": [
+    "browser.js",
+    "index.js",
+    "lib/*.js",
+    "wrapper.mjs"
+  ],
+  "scripts": {
+    "test": "nyc --reporter=lcov --reporter=text mocha --throw-deprecation test/*.test.js",
+    "integration": "mocha --throw-deprecation test/*.integration.js",
+    "lint": "eslint . && prettier --check --ignore-path .gitignore \"**/*.{json,md,yaml,yml}\""
+  },
+  "peerDependencies": {
+    "bufferutil": "^4.0.1",
+    "utf-8-validate": ">=5.0.2"
+  },
+  "peerDependenciesMeta": {
+    "bufferutil": {
+      "optional": true
+    },
+    "utf-8-validate": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "benchmark": "^2.1.4",
+    "bufferutil": "^4.0.1",
+    "eslint": "^10.0.1",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.0.0",
+    "globals": "^17.0.0",
+    "mocha": "^8.4.0",
+    "nyc": "^15.0.0",
+    "prettier": "^3.0.0",
+    "utf-8-validate": "^6.0.0"
+  },
+  "allowScripts": {
+    "bufferutil": true,
+    "utf-8-validate": true
+  }
+}

package/lib/cli.mjs

@@ -5,6 +5,7 @@ import { parseArgs } from 'node:util';
 import { AccreteError } from './fsutil.mjs';
 import { BINARY } from './kernel.mjs';
 import { MARKER, loadScaffold } from './scaffold.mjs';
+import { checkUi, runUi } from './ui.mjs';
 import { createWorkspace, findWorkspace, installWorkspace, upgradeWorkspace } from './workspace.mjs';
 
 const USAGE = `Create or upgrade an ACCRETE Workspace, and install its Kernel.
@@ -13,6 +14,7 @@ const USAGE = `Create or upgrade an ACCRETE Workspace, and install its Kernel.
   npx accrete-kit@latest create .                    Add to this directory or repository
   npx accrete-kit@latest upgrade [OPTIONS]
   npx accrete-kit@<version> install [OPTIONS]        Restore this host's Kernel after a clone
+  npx accrete-kit@latest ui [OPTIONS]                Watch a Workspace in a local web page, macOS only
 
 Create options:
   --name NAME  --id ID  --timezone IANA_ZONE
@@ -29,10 +31,15 @@ Upgrade options:
 Install options:
   --project PATH  --json
 
+UI options:
+  --project PATH  --no-open  --no-tmux  --port N
+
 --no-install skips installing the Kernel binary. Owner edits are preserved: a conflict
 leaves the file alone and writes a candidate under .accrete/template-upgrades/. The Kernel
 runs as ${BINARY}; accrete-kit does not forward commands to it.`;
 
+const UI_ONLY = ['no-open', 'no-tmux', 'port'];
+
 const OPTIONS = {
   name: { type: 'string' },
   id: { type: 'string' },
@@ -44,6 +51,9 @@ const OPTIONS = {
   'dry-run': { type: 'boolean' },
   accept: { type: 'string' },
   json: { type: 'boolean' },
+  'no-open': { type: 'boolean' },
+  'no-tmux': { type: 'boolean' },
+  port: { type: 'string' },
   help: { type: 'boolean', short: 'h' },
   version: { type: 'boolean', short: 'v' }
 };
@@ -113,12 +123,12 @@ function selectWorkspace(values, directories, cwd, command) {
 }
 
 function install(values, directories, scaffold, cwd) {
-  refuse(values, ['name', 'id', 'timezone', 'no-git', 'no-install', 'dry-run', 'agents', 'accept'], 'to install');
+  refuse(values, ['name', 'id', 'timezone', 'no-git', 'no-install', 'dry-run', 'agents', 'accept', ...UI_ONLY], 'to install');
   return installWorkspace(selectWorkspace(values, directories, cwd, 'install'), scaffold);
 }
 
 function upgrade(values, directories, scaffold, cwd) {
-  refuse(values, ['name', 'id', 'timezone', 'no-git'], 'to upgrade');
+  refuse(values, ['name', 'id', 'timezone', 'no-git', ...UI_ONLY], 'to upgrade');
   if (values.accept !== undefined && values.agents !== undefined) throw new AccreteError('invalid', '--accept and --agents are separate operations');
   const root = selectWorkspace(values, directories, cwd, 'upgrade');
   return upgradeWorkspace(root, {
@@ -130,7 +140,7 @@ function upgrade(values, directories, scaffold, cwd) {
 }
 
 function create(values, directories, scaffold, cwd) {
-  refuse(values, ['project', 'dry-run', 'accept'], 'to create');
+  refuse(values, ['project', 'dry-run', 'accept', ...UI_ONLY], 'to create');
   if (directories.length !== 1) throw new AccreteError('invalid', 'create takes one directory, or . for this one');
   return createWorkspace(path.resolve(cwd, directories[0]), {
     name: values.name,
@@ -142,6 +152,13 @@ function create(values, directories, scaffold, cwd) {
   }, scaffold);
 }
 
+/** The server stays in the foreground, so this returns its exit code and no receipt. */
+function ui(values, directories, cwd) {
+  refuse(values, ['name', 'id', 'timezone', 'agents', 'no-git', 'no-install', 'dry-run', 'accept', 'json'], 'to ui');
+  checkUi();
+  return runUi(selectWorkspace(values, directories, cwd, 'ui'), values);
+}
+
 const COMMANDS = { create, upgrade, install };
 
 export function main(argv, cwd = process.cwd()) {
@@ -164,8 +181,9 @@ export function main(argv, cwd = process.cwd()) {
       return 0;
     }
     const [command, ...directories] = positionals;
+    if (command === 'ui') return ui(values, directories, cwd);
     if (!Object.hasOwn(COMMANDS, command ?? '')) {
-      throw new AccreteError('invalid', command === undefined ? 'Name a subcommand: create, upgrade or install' : `Unknown subcommand ${command}; use create, upgrade or install`);
+      throw new AccreteError('invalid', command === undefined ? 'Name a subcommand: create, upgrade, install or ui' : `Unknown subcommand ${command}; use create, upgrade, install or ui`);
     }
     const receipt = COMMANDS[command](values, directories, scaffold, cwd);
     receipt.next_steps = nextSteps(receipt, cwd);

package/lib/ui.mjs

@@ -0,0 +1,24 @@
+// The accrete-ui this package carries, run in the foreground until it exits.
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import os from 'node:os';
+import { fileURLToPath } from 'node:url';
+import { AccreteError } from './fsutil.mjs';
+
+const BUNDLED = new URL('../dist/ui/bin/accrete-ui.mjs', import.meta.url);
+
+/** Before a Workspace is looked for: this host and this package can run the UI. */
+export function checkUi() {
+  if (process.platform !== 'darwin') throw new AccreteError('dependency', 'The UI is macOS only for now');
+  if (!fs.existsSync(BUNDLED)) throw new AccreteError('dependency', 'This copy of accrete-kit has no UI in dist/ui; in a checkout, run scripts/fetch-ui.mjs');
+}
+
+export function runUi(root, values) {
+  const args = [fileURLToPath(BUNDLED), '--project', root];
+  if (values['no-open']) args.push('--no-open');
+  if (values['no-tmux']) args.push('--no-tmux');
+  if (values.port !== undefined) args.push('--port', values.port);
+  const { status, signal, error } = spawnSync(process.execPath, args, { stdio: 'inherit' });
+  if (error) throw new AccreteError('storage', `Cannot run the UI: ${error.message}`);
+  return status ?? 128 + os.constants.signals[signal];
+}

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "accrete-kit",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Create and upgrade ACCRETE Workspaces",
   "license": "MIT",
   "repository": { "type": "git", "url": "git+https://github.com/Wanli-Wylie/accrete-template.git" },
   "type": "module",
   "engines": { "node": ">=20" },
   "bin": { "accrete-kit": "bin/accrete-kit.mjs" },
-  "files": ["bin/", "lib/", "dist/scaffold/", "dist/kernel/", "LICENSE", "CHANGELOG.md"],
-  "accrete": { "cli": "0.1.0", "cliRepo": "Wanli-Wylie/accrete-cli" },
+  "files": ["bin/", "lib/", "dist/scaffold/", "dist/kernel/", "dist/ui/", "LICENSE", "CHANGELOG.md"],
+  "accrete": { "cli": "0.1.0", "cliRepo": "Wanli-Wylie/accrete-cli", "ui": "0.1.0", "uiRepo": "Wanli-Wylie/accrete-ui" },
   "scripts": {
     "build": "node scripts/build.mjs",
     "check": "node scripts/build.mjs --check",
     "pretest": "node scripts/build.mjs",
-    "test": "node --test test/install.test.mjs test/cli.test.mjs test/kernel.test.mjs test/contract.test.mjs test/package.test.mjs",
-    "prepublishOnly": "node scripts/fetch-kernel.mjs --check",
+    "test": "node --test test/install.test.mjs test/cli.test.mjs test/kernel.test.mjs test/contract.test.mjs test/ui.test.mjs test/package.test.mjs",
+    "prepublishOnly": "node scripts/fetch-kernel.mjs --check && node scripts/fetch-ui.mjs --check",
     "prepack": "node scripts/build.mjs"
   }
 }