@webship.co/workspace-docksal 0.0.0-stage → 1.0.0-alpha1

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# @webship.co/workspace-docksal
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Docksal for the [Webship Workspace](https://github.com/webship/workspace) dashboard: the **DOCKSAL**
+menu on every project folder that carries a .docksal/ folder, with the runtime's verbs as terminal sessions in
+the project, the up/down caption and the site link, and "Scaffold .docksal/ here (fin config generate)" when a new folder is made.
+A runtime of [`@webship.co/workspace-container`](https://github.com/webship/workspace-container).
+
+A project is a Docksal project when it carries `.docksal/` (`docksal.env` or `docksal.yml`); the site link is `VIRTUAL_HOST` from `docksal.env`, or `<folder>.docksal.site`.
+
+## Use it
+
+```bash
+cd ~/workspace
+bash core/scripts/plugins.sh --require github:webship/workspace-docksal
+bash core/scripts/plugins.sh --activate docksal
+bash core/scripts/plugins.sh --install docksal
+```
+
+## The verbs
+
+| Verb | Command |
+| --- | --- |
+| Start | `fin project start` |
+| Stop | `fin project stop` |
+| Restart | `fin project restart` |
+| Status | `fin project status` |
+| Logs | `fin logs -f` |
+| Shell | `fin bash` |
+| Init | `fin init` (the project's own init command) |
+| Remove | `fin project remove -f` (containers and data: marked in red) |
+
+Every verb opens a terminal session in the project folder, so what the CLI prints is what you see,
+and a verb that asks a question can be answered.
+
+The `workspacePlugin` block in `package.json` is the manifest the installer reads.

package/ddev/docker-compose.docksal.yaml

@@ -0,0 +1,7 @@
+# Docksal's config, shared FROM THE HOST into the dashboard container, so the verbs that run from
+# the dashboard see the same contexts and sessions the host does.
+services:
+  web:
+    volumes:
+      - "${HOME}/.local/bin:/host-local-bin:ro"
+      - "${HOME}/.docksal:/home/${USER}/.docksal:rw"

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Docksal for Webship Workspace.
+ *
+ * The DOCKSAL menu on every project folder that carries a .docksal/ folder: the runtime's verbs as terminal
+ * sessions in the project, the up/down caption, the site link, and "Scaffold .docksal/ here (fin config generate)" when a new folder
+ * is made. All of it is the container family's surface (@webship.co/workspace-container); this
+ * package is the Docksal runtime plus its host install.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+import { docksalRuntime } from './lib/runtime';
+export { docksalRuntime };
+export declare function register(api: PluginApi): void;

package/dist/src/index.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Docksal for Webship Workspace.
+ *
+ * The DOCKSAL menu on every project folder that carries a .docksal/ folder: the runtime's verbs as terminal
+ * sessions in the project, the up/down caption, the site link, and "Scaffold .docksal/ here (fin config generate)" when a new folder
+ * is made. All of it is the container family's surface (@webship.co/workspace-container); this
+ * package is the Docksal runtime plus its host install.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.docksalRuntime = void 0;
+exports.register = register;
+const workspace_container_1 = require("@webship.co/workspace-container");
+const runtime_1 = require("./lib/runtime");
+Object.defineProperty(exports, "docksalRuntime", { enumerable: true, get: function () { return runtime_1.docksalRuntime; } });
+function register(api) {
+    (0, workspace_container_1.registerContainer)(api, runtime_1.docksalRuntime);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AASH,4BAEC;AARD,yEAAoE;AAEpE,2CAA+C;AAEtC,+FAFA,wBAAc,OAEA;AAEvB,SAAgB,QAAQ,CAAC,GAAc;IACrC,IAAA,uCAAiB,EAAC,GAAG,EAAE,wBAAc,CAAC,CAAC;AACzC,CAAC"}

package/dist/src/lib/runtime.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Docksal, as a container runtime: a project with a .docksal/ folder.
+ */
+import type { ContainerRuntime } from '@webship.co/workspace-container';
+export declare const docksalRuntime: ContainerRuntime;

package/dist/src/lib/runtime.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * Docksal, as a container runtime: a project with a .docksal/ folder.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.docksalRuntime = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+exports.docksalRuntime = {
+    id: 'docksal',
+    label: 'DOCKSAL',
+    title: 'Docksal',
+    cli: 'fin',
+    cliHint: 'https://docs.docksal.io/getting-started/setup/',
+    detect: (dir) => {
+        const file = ['.docksal/docksal.env', '.docksal/docksal.yml'].find((f) => fs_1.default.existsSync(path_1.default.join(dir, f)));
+        if (!file)
+            return null;
+        let host = '';
+        try {
+            host = (fs_1.default.readFileSync(path_1.default.join(dir, '.docksal', 'docksal.env'), 'utf8').match(/^VIRTUAL_HOST=["']?([\w.-]+)/m) || [])[1] || '';
+        }
+        catch (_) { /* no env file */ }
+        const name = path_1.default.basename(dir);
+        return { file, name, url: `http://${host || `${name}.docksal.site`}` };
+    },
+    state: async (_p, dir, lib) => {
+        const out = await lib.run('fin', ['project', 'status'], dir, { timeoutMs: 20 * 1000 });
+        if (!out.ok)
+            return 'unknown';
+        return /\bUp\b/.test(String(out.stdout)) ? 'up' : 'down';
+    },
+    verbs: {
+        start: { label: 'Start', icon: 'play', kind: 'start', cmd: () => 'fin project start' },
+        stop: { label: 'Stop', icon: 'ban', kind: 'stop', cmd: () => 'fin project stop' },
+        restart: { label: 'Restart', icon: 'refresh', kind: 'restart', cmd: () => 'fin project restart' },
+        status: { label: 'Status', icon: 'info', kind: 'status', cmd: () => 'fin project status' },
+        logs: { label: 'Logs (follow)', icon: 'file-text', kind: 'logs', cmd: () => 'fin logs -f' },
+        shell: { label: 'Shell (fin bash)', icon: 'terminal', kind: 'shell', cmd: () => 'fin bash' },
+        init: { label: 'Run the project init (fin init)', icon: 'bolt', kind: 'other', cmd: () => 'fin init' },
+        remove: { label: 'Remove (containers and data)', icon: 'trash', kind: 'other', danger: true, cmd: () => 'fin project remove -f' },
+    },
+    init: { label: 'Scaffold .docksal/ here (fin config generate)', cmd: () => 'fin config generate', help: 'Docksal writes .docksal/docksal.env with the default stack.' },
+    menuNote: 'Every verb opens a terminal in the project',
+};
+//# sourceMappingURL=runtime.js.map

package/dist/src/lib/runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../../src/lib/runtime.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;AAEH,4CAAoB;AACpB,gDAAwB;AAGX,QAAA,cAAc,GAAqB;IAC9C,EAAE,EAAE,SAAS;IACb,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;IAChB,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,gDAAgD;IACzD,MAAM,EAAE,CAAC,GAAG,EAA2B,EAAE;QACvC,MAAM,IAAI,GAAG,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5G,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,CAAC;YAAC,IAAI,GAAG,CAAC,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,+BAA+B,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAAC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAC,iBAAiB,CAAC,CAAC;QAC1K,MAAM,IAAI,GAAG,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,IAAI,IAAI,GAAG,IAAI,eAAe,EAAE,EAAE,CAAC;IACzE,CAAC;IACD,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC5B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QACvF,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,OAAO,SAAS,CAAC;QAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3D,CAAC;IACD,KAAK,EAAE;QACL,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,mBAAmB,EAAE;QACtF,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,kBAAkB,EAAE;QACjF,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,qBAAqB,EAAE;QACjG,MAAM,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,oBAAoB,EAAE;QAC1F,IAAI,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE;QAC3F,KAAK,EAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE;QAC5F,IAAI,EAAE,EAAE,KAAK,EAAE,iCAAiC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE;QACtG,MAAM,EAAE,EAAE,KAAK,EAAE,8BAA8B,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,uBAAuB,EAAE;KAClI;IACD,IAAI,EAAE,EAAE,KAAK,EAAE,+CAA+C,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,qBAAqB,EAAE,IAAI,EAAE,6DAA6D,EAAE;IACvK,QAAQ,EAAE,4CAA4C;CACvD,CAAC"}

package/features/docksal.feature

@@ -0,0 +1,8 @@
+Feature: The Docksal plugin on a project row
+  Once the plugin is activated and installed, every project folder that carries a .docksal/ folder carries
+  the DOCKSAL menu, and the Plugins page lists the plugin with its four steps.
+
+  Scenario: The plugin is listed on the Plugins page
+    Given I am on "/settings/plugins"
+     Then I should see "Docksal"
+      And I should see "@webship.co/workspace-docksal"

package/host-mounts.txt

@@ -0,0 +1,2 @@
+# Directories the dashboard container bind-mounts for this plugin; host-mounts.sh creates them as you first.
+~/.docksal

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "@webship.co/workspace-docksal",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha1",
+  "description": "Docksal for Webship Workspace: the DOCKSAL menu on every project with a .docksal/ folder (start, stop, restart, status, logs, bash, init, remove), the up/down caption, the virtual host as the site link. A runtime of @webship.co/workspace-container.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webship/workspace-docksal.git"
+  },
+  "files": [
+    "dist/src",
+    "features",
+    "scripts",
+    "README.md",
+    "ddev",
+    "host-mounts.txt"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "test": "npm run build && node --test dist/tests/*.test.js",
+    "lint": "tsc -p tsconfig.json --noEmit"
+  },
+  "workspacePlugin": {
+    "name": "docksal",
+    "label": "Docksal",
+    "typeActions": {
+      "docksal": [
+        "sites",
+        "code"
+      ]
+    },
+    "scripts": {
+      "hostInstall": "scripts/host-install.sh"
+    },
+    "features": [
+      "features/docksal.feature"
+    ],
+    "ddev": {
+      "compose": [
+        "ddev/docker-compose.docksal.yaml"
+      ],
+      "hostMounts": [
+        "~/.docksal"
+      ]
+    }
+  },
+  "dependencies": {
+    "@webship.co/workspace-container": "^1.0.0-alpha1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "@webship.co/workspace-plugin-api": "^1.0.0-alpha1",
+    "typescript": "^5.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/scripts/host-install.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+## The host side of the Docksal plugin: the CLI on this machine. Run by core/scripts/plugins.sh
+## --install docksal, and by core/scripts/install.sh for every installed plugin that ships one.
+## Idempotent: whatever is already there is reported, not redone; nothing is installed unasked.
+set -u
+BIN='';
+for candidate in "$(command -v fin 2>/dev/null)" "${HOME}/.local/bin/fin" ; do
+  [ -n "${candidate}" ] && [ -x "${candidate}" ] && { BIN="${candidate}"; break; }
+done
+if [ -n "${BIN}" ] ; then
+  printf '  ✓ %-16s %s\n' "fin" "${BIN}" ;
+else
+  printf '  ✗ %-16s %s\n' "fin" "missing — the DOCKSAL menu's verbs need it (docs.docksal.io/getting-started/setup)" ;
+fi