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

package/README.md

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# @webship.co/workspace-docker
 
-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.
+Docker Compose for the [Webship Workspace](https://github.com/webship/workspace) dashboard: the **DOCKER**
+menu on every project folder that carries a compose file (compose.yaml, docker-compose.yml and their variants), with the runtime's verbs as terminal sessions in
+the project, the up/down caption and the site link, and "Write a compose.yaml skeleton here" when a new folder is made.
+A runtime of [`@webship.co/workspace-container`](https://github.com/webship/workspace-container).
+
+A project is a Docker Compose project when it carries `compose.yaml`, `compose.yml`, `docker-compose.yml` or `docker-compose.yaml`. The name is the file's `name:` or the folder; the site link is the first published port of the first service that has one. The dashboard container runs docker against the host's socket (Docker-outside-of-Docker), so the verbs act on the same daemon the host uses.
+
+## Use it
+
+```bash
+cd ~/workspace
+bash core/scripts/plugins.sh --require github:webship/workspace-docker
+bash core/scripts/plugins.sh --activate docker
+bash core/scripts/plugins.sh --install docker
+```
+
+## The verbs
+
+| Verb | Command |
+| --- | --- |
+| Up | `docker compose up -d` |
+| Down | `docker compose down` |
+| Restart | `docker compose restart` |
+| Status | `docker compose ps` |
+| Logs | `docker compose logs -f --tail=200` |
+| Shell | `docker compose exec <first service> sh` |
+| Pull | `docker compose pull` |
+| Build | `docker compose build` |
+| Down and remove volumes | `docker compose down -v` (data is lost: 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/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Docker Compose for Webship Workspace.
+ *
+ * The DOCKER menu on every project folder that carries a compose file (compose.yaml, docker-compose.yml and their variants): the runtime's verbs as terminal
+ * sessions in the project, the up/down caption, the site link, and "Write a compose.yaml skeleton here" when a new folder
+ * is made. All of it is the container family's surface (@webship.co/workspace-container); this
+ * package is the Docker Compose runtime plus its host install.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+import { dockerRuntime } from './lib/runtime';
+export { dockerRuntime };
+export declare function register(api: PluginApi): void;

package/dist/src/index.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Docker Compose for Webship Workspace.
+ *
+ * The DOCKER menu on every project folder that carries a compose file (compose.yaml, docker-compose.yml and their variants): the runtime's verbs as terminal
+ * sessions in the project, the up/down caption, the site link, and "Write a compose.yaml skeleton here" when a new folder
+ * is made. All of it is the container family's surface (@webship.co/workspace-container); this
+ * package is the Docker Compose runtime plus its host install.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dockerRuntime = void 0;
+exports.register = register;
+const workspace_container_1 = require("@webship.co/workspace-container");
+const runtime_1 = require("./lib/runtime");
+Object.defineProperty(exports, "dockerRuntime", { enumerable: true, get: function () { return runtime_1.dockerRuntime; } });
+function register(api) {
+    (0, workspace_container_1.registerContainer)(api, runtime_1.dockerRuntime);
+}
+//# 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,2CAA8C;AAErC,8FAFA,uBAAa,OAEA;AAEtB,SAAgB,QAAQ,CAAC,GAAc;IACrC,IAAA,uCAAiB,EAAC,GAAG,EAAE,uBAAa,CAAC,CAAC;AACxC,CAAC"}

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

@@ -0,0 +1,12 @@
+/**
+ * Docker Compose, as a container runtime: a project with a compose file.
+ */
+import type { ContainerRuntime } from '@webship.co/workspace-container';
+export declare const COMPOSE_FILES: string[];
+/** The compose project's name, first service and first published port, read without a YAML parser. */
+export declare function readCompose(file: string, fallbackName: string): {
+    name: string;
+    service?: string;
+    port?: string;
+};
+export declare const dockerRuntime: ContainerRuntime;

package/dist/src/lib/runtime.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * Docker Compose, as a container runtime: a project with a compose file.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dockerRuntime = exports.COMPOSE_FILES = void 0;
+exports.readCompose = readCompose;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const workspace_container_1 = require("@webship.co/workspace-container");
+exports.COMPOSE_FILES = ['compose.yaml', 'compose.yml', 'docker-compose.yml', 'docker-compose.yaml'];
+/** The compose project's name, first service and first published port, read without a YAML parser. */
+function readCompose(file, fallbackName) {
+    let text = '';
+    try {
+        text = fs_1.default.readFileSync(file, 'utf8');
+    }
+    catch (_) {
+        return { name: fallbackName };
+    }
+    const name = (text.match(/^name:\s*["']?([\w.-]+)/m) || [])[1] || fallbackName;
+    const services = text.indexOf('\nservices:');
+    const body = services >= 0 ? text.slice(services) : '';
+    const service = (body.match(/\n {2}([\w.-]+):/) || [])[1];
+    const port = (body.match(/^\s+-\s*["']?(?:[\d.]+:)?(\d+):\d+/m) || [])[1];
+    return { name, service, port };
+}
+exports.dockerRuntime = {
+    id: 'docker',
+    label: 'DOCKER',
+    title: 'Docker Compose',
+    cli: 'docker',
+    cliHint: 'https://docs.docker.com/engine/install/',
+    detect: (dir) => {
+        const p = (0, workspace_container_1.detectByFiles)(dir, exports.COMPOSE_FILES);
+        if (!p)
+            return null;
+        const c = readCompose(path_1.default.join(dir, p.file), path_1.default.basename(dir));
+        return { file: p.file, name: c.name, url: c.port ? `http://localhost:${c.port}` : undefined };
+    },
+    state: async (p, dir, lib) => {
+        const out = await lib.run('docker', ['compose', '-f', p.file, 'ps', '--status', 'running', '--format', '{{.Name}} {{.State}}'], dir, { timeoutMs: 15 * 1000 });
+        if (!out.ok)
+            return 'unknown';
+        return /running/.test(String(out.stdout)) ? 'up' : 'down';
+    },
+    verbs: {
+        start: { label: 'Up (docker compose up -d)', icon: 'play', kind: 'start', cmd: (p) => `docker compose -f ${p.file} up -d` },
+        stop: { label: 'Down', icon: 'ban', kind: 'stop', cmd: (p) => `docker compose -f ${p.file} down` },
+        restart: { label: 'Restart', icon: 'refresh', kind: 'restart', cmd: (p) => `docker compose -f ${p.file} restart` },
+        status: { label: 'Status (ps)', icon: 'info', kind: 'status', cmd: (p) => `docker compose -f ${p.file} ps` },
+        logs: { label: 'Logs (follow)', icon: 'file-text', kind: 'logs', cmd: (p) => `docker compose -f ${p.file} logs -f --tail=200` },
+        shell: { label: 'Shell in the first service', icon: 'terminal', kind: 'shell', cmd: (p) => `docker compose -f ${p.file} exec $(docker compose -f ${p.file} config --services | head -1) sh` },
+        pull: { label: 'Pull images', icon: 'cloud-download', kind: 'other', cmd: (p) => `docker compose -f ${p.file} pull` },
+        build: { label: 'Build', icon: 'cog', kind: 'other', cmd: (p) => `docker compose -f ${p.file} build` },
+        downv: { label: 'Down and remove volumes (data is lost)', icon: 'trash', kind: 'other', danger: true, cmd: (p) => `docker compose -f ${p.file} down -v` },
+    },
+    init: { label: 'Write a compose.yaml skeleton here', cmd: (name) => `[ -e compose.yaml ] || printf 'name: ${name}\\nservices:\\n  web:\\n    image: nginx:alpine\\n    ports:\\n      - "8080:80"\\n' > compose.yaml`, help: 'One nginx service on port 8080, to edit.' },
+    menuNote: 'The verbs run against the daemon the host uses (Docker-outside-of-Docker)',
+};
+//# 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;;;;;;AAUH,kCASC;AAjBD,4CAAoB;AACpB,gDAAwB;AACxB,yEAAgE;AAGnD,QAAA,aAAa,GAAG,CAAC,cAAc,EAAE,aAAa,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,CAAC;AAE1G,sGAAsG;AACtG,SAAgB,WAAW,CAAC,IAAY,EAAE,YAAoB;IAC5D,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,CAAC;QAAC,IAAI,GAAG,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAAC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QAAC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAAC,CAAC;IAC1F,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC;IAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC7C,MAAM,IAAI,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,qCAAqC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACjC,CAAC;AAEY,QAAA,aAAa,GAAqB;IAC7C,EAAE,EAAE,QAAQ;IACZ,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,gBAAgB;IACvB,GAAG,EAAE,QAAQ;IACb,OAAO,EAAE,yCAAyC;IAClD,MAAM,EAAE,CAAC,GAAG,EAA2B,EAAE;QACvC,MAAM,CAAC,GAAG,IAAA,mCAAa,EAAC,GAAG,EAAE,qBAAa,CAAC,CAAC;QAC5C,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,MAAM,CAAC,GAAG,WAAW,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAClE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IAChG,CAAC;IACD,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC3B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,sBAAsB,CAAC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAC/J,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,OAAO,SAAS,CAAC;QAC9B,OAAO,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;IAC5D,CAAC;IACD,KAAK,EAAE;QACL,KAAK,EAAE,EAAE,KAAK,EAAE,2BAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,QAAQ,EAAE;QAC3H,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,OAAO,EAAE;QAClG,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,UAAU,EAAE;QAClH,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,KAAK,EAAE;QAC5G,IAAI,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,qBAAqB,EAAE;QAC/H,KAAK,EAAE,EAAE,KAAK,EAAE,4BAA4B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,6BAA6B,CAAC,CAAC,IAAI,kCAAkC,EAAE;QAC7L,IAAI,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,OAAO,EAAE;QACrH,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,QAAQ,EAAE;QACtG,KAAK,EAAE,EAAE,KAAK,EAAE,wCAAwC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,IAAI,UAAU,EAAE;KAC1J;IACD,IAAI,EAAE,EAAE,KAAK,EAAE,oCAAoC,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,wCAAwC,IAAI,qGAAqG,EAAE,IAAI,EAAE,0CAA0C,EAAE;IACzQ,QAAQ,EAAE,2EAA2E;CACtF,CAAC"}

package/features/docker.feature

@@ -0,0 +1,8 @@
+Feature: The Docker Compose plugin on a project row
+  Once the plugin is activated and installed, every project folder that carries a compose file (compose.yaml, docker-compose.yml and their variants) carries
+  the DOCKER 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 "Docker Compose"
+      And I should see "@webship.co/workspace-docker"

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@webship.co/workspace-docker",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha1",
+  "description": "Docker Compose for Webship Workspace: the DOCKER menu on every project with a compose file (up, down, restart, ps, logs, a shell in the first service, pull, build), the up/down caption, the published port 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-docker.git"
+  },
+  "files": [
+    "dist/src",
+    "features",
+    "scripts",
+    "README.md"
+  ],
+  "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": "docker",
+    "label": "Docker Compose",
+    "typeActions": {
+      "docker": [
+        "sites",
+        "code"
+      ]
+    },
+    "scripts": {
+      "hostInstall": "scripts/host-install.sh"
+    },
+    "features": [
+      "features/docker.feature"
+    ]
+  },
+  "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 Docker Compose plugin: the CLI on this machine. Run by core/scripts/plugins.sh
+## --install docker, 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 docker 2>/dev/null)" "${HOME}/.local/bin/docker" ; do
+  [ -n "${candidate}" ] && [ -x "${candidate}" ] && { BIN="${candidate}"; break; }
+done
+if [ -n "${BIN}" ] ; then
+  printf '  ✓ %-16s %s\n' "docker" "${BIN}" ;
+else
+  printf '  ✗ %-16s %s\n' "docker" "missing — the DOCKER menu's verbs need it (docs.docker.com/engine/install)" ;
+fi