@paretools/docker 0.12.0 → 0.13.0

package/dist/lib/formatters.js

@@ -1,6 +1,9 @@
 /** Formats structured Docker container data into a human-readable listing with state and ports. */
 export function formatPs(data) {
-    const lines = [`${data.total} containers (${data.running} running, ${data.stopped} stopped)`];
+    const total = data.containers.length;
+    const running = data.containers.filter((c) => c.state === "running").length;
+    const stopped = total - running;
+    const lines = [`${total} containers (${running} running, ${stopped} stopped)`];
     for (const c of data.containers) {
         const portsArr = c.ports ?? [];
         const ports = portsArr.length
@@ -16,20 +19,24 @@ export function formatPs(data) {
 /** Formats structured Docker build results into a human-readable success/failure summary.
  *  #97: Includes structured error details with line numbers. */
 export function formatBuild(data) {
+    const cacheByStep = data.cacheByStep ?? [];
+    const cacheHits = cacheByStep.filter((s) => s.cached).length;
+    const cacheMisses = cacheByStep.filter((s) => !s.cached).length;
+    const steps = cacheByStep.length;
     if (data.success) {
-        const parts = [`Build succeeded in ${data.duration}s`];
+        const parts = ["Build succeeded"];
         if (data.imageId)
             parts[0] += ` → ${data.imageId}`;
-        if (data.steps)
-            parts.push(`${data.steps} steps`);
-        if (data.cacheHits != null || data.cacheMisses != null) {
-            parts.push(`cache hits=${data.cacheHits ?? 0}, misses=${data.cacheMisses ?? 0}`);
+        if (steps > 0)
+            parts.push(`${steps} steps`);
+        if (cacheByStep.length > 0) {
+            parts.push(`cache hits=${cacheHits}, misses=${cacheMisses}`);
         }
         return parts.join(", ");
     }
-    const lines = [`Build failed (${data.duration}s)`];
-    if (data.cacheHits != null || data.cacheMisses != null) {
-        lines.push(`  cache hits=${data.cacheHits ?? 0}, misses=${data.cacheMisses ?? 0}`);
+    const lines = ["Build failed"];
+    if (cacheByStep.length > 0) {
+        lines.push(`  cache hits=${cacheHits}, misses=${cacheMisses}`);
     }
     for (const err of data.errors ?? []) {
         if (typeof err === "string") {
@@ -48,12 +55,11 @@ export function formatBuild(data) {
     }
     return lines.join("\n");
 }
-/** Formats structured Docker logs data into a human-readable output with container name and line count.
+/** Formats structured Docker logs data into a human-readable output with line count.
  *  #113: Notes when separate stdout/stderr streams are available. */
 export function formatLogs(data) {
-    const header = data.isTruncated
-        ? `${data.container} (${data.total} of ${data.totalLines} lines, truncated)`
-        : `${data.container} (${data.total} lines)`;
+    const total = (data.lines ?? []).length;
+    const header = data.isTruncated ? `${total} lines (truncated)` : `${total} lines`;
     const streamInfo = data.stdoutLines || data.stderrLines
         ? ` [stdout=${(data.stdoutLines ?? []).length}, stderr=${(data.stderrLines ?? []).length}]`
         : "";
@@ -65,9 +71,10 @@ export function formatLogs(data) {
 /** Formats structured Docker image data into a human-readable listing with repository, tag, and size.
  *  #110: Shows ISO creation timestamp when available. */
 export function formatImages(data) {
-    if (data.total === 0)
+    const total = data.images.length;
+    if (total === 0)
         return "No images found.";
-    const lines = [`${data.total} images:`];
+    const lines = [`${total} images:`];
     for (const img of data.images) {
         const tag = img.tag && img.tag !== "<none>" ? `:${img.tag}` : "";
         const digest = img.digest ? ` [${img.digest.slice(0, 19)}...]` : "";
@@ -85,7 +92,7 @@ export function formatImages(data) {
 export function formatRun(data) {
     const name = data.name ? ` (${data.name})` : "";
     const mode = data.detached ? "detached" : "attached";
-    const lines = [`Container ${data.containerId}${name} started from ${data.image} [${mode}]`];
+    const lines = [`Container ${data.containerId}${name} started [${mode}]`];
     if (data.exitCode != null && data.exitCode !== 0) {
         lines.push(`  Exit code: ${data.exitCode}`);
         if (data.errorCategory)
@@ -104,14 +111,14 @@ export function formatRun(data) {
 /** Formats structured Docker exec output into a human-readable summary.
  *  #108: Shows truncation indicator. */
 export function formatExec(data) {
+    const success = data.exitCode === 0;
     const status = data.timedOut
         ? "timed out"
-        : data.success
+        : success
             ? "succeeded"
             : `failed (exit code ${data.exitCode})`;
-    const dur = data.duration != null ? ` in ${data.duration}s` : "";
     const trunc = data.isTruncated ? " [truncated]" : "";
-    const lines = [`Exec ${status}${dur}${trunc}`];
+    const lines = [`Exec ${status}${trunc}`];
     if (data.stdout)
         lines.push(data.stdout);
     if (data.stderr)
@@ -127,11 +134,10 @@ export function formatExec(data) {
 export function formatComposeUp(data) {
     if (!data.success)
         return "Compose up failed";
-    if (data.started === 0)
+    const started = (data.services ?? []).length;
+    if (started === 0)
         return "Compose up succeeded (no new services started)";
-    const lines = [
-        `Compose up: ${data.started} services started (${(data.services ?? []).join(", ")})`,
-    ];
+    const lines = [`Compose up: ${started} services started (${(data.services ?? []).join(", ")})`];
     if (data.serviceStates && data.serviceStates.length > 0) {
         for (const ss of data.serviceStates) {
             lines.push(`  ${ss.name}: ${ss.action}`);
@@ -149,7 +155,9 @@ export function formatComposeUp(data) {
 export function formatComposeDown(data) {
     if (!data.success)
         return "Compose down failed";
-    const parts = [`Compose down: ${data.stopped} stopped, ${data.removed} removed`];
+    const removedContainers = (data.containers ?? []).filter((c) => c.action === "Removed").length;
+    const removed = removedContainers + (data.volumesRemoved ?? 0) + (data.networksRemoved ?? 0);
+    const parts = [`Compose down: ${data.stopped} stopped, ${removed} removed`];
     if (data.volumesRemoved)
         parts[0] += `, ${data.volumesRemoved} volumes removed`;
     if (data.networksRemoved)
@@ -167,13 +175,13 @@ export function formatPull(data) {
     if (!data.success) {
         const errType = data.errorType ? ` (${data.errorType})` : "";
         const msg = data.errorMessage ? `: ${data.errorMessage}` : "";
-        return `Pull failed for ${data.image}:${data.tag}${errType}${msg}`;
+        return `Pull failed${errType}${msg}`;
     }
     const digest = data.digest ? ` (${data.digest.slice(0, 19)}...)` : "";
     const size = data.size ? ` [${data.size}]` : "";
     if (data.status === "up-to-date")
-        return `${data.image}:${data.tag} is up to date${digest}`;
-    return `Pulled ${data.image}:${data.tag}${digest}${size}`;
+        return `Image is up to date${digest}`;
+    return `Pulled${digest}${size}`;
 }
 export function compactPsMap(data) {
     return {
@@ -183,13 +191,12 @@ export function compactPsMap(data) {
             image: c.image,
             status: c.status,
         })),
-        total: data.total,
-        running: data.running,
-        stopped: data.stopped,
     };
 }
 export function formatPsCompact(data) {
-    const lines = [`${data.total} containers (${data.running} running)`];
+    const total = data.containers.length;
+    const running = data.containers.filter((c) => c.status.toLowerCase().startsWith("up")).length;
+    const lines = [`${total} containers (${running} running)`];
     for (const c of data.containers) {
         lines.push(`  ${c.id.slice(0, 12)} ${c.name} (${c.image}) ${c.status}`);
     }
@@ -203,13 +210,13 @@ export function compactImagesMap(data) {
             tag: img.tag,
             size: img.size,
         })),
-        total: data.total,
     };
 }
 export function formatImagesCompact(data) {
-    if (data.total === 0)
+    const total = data.images.length;
+    if (total === 0)
         return "No images found.";
-    const lines = [`${data.total} images:`];
+    const lines = [`${total} images:`];
     for (const img of data.images) {
         const tag = img.tag && img.tag !== "<none>" ? `:${img.tag}` : "";
         lines.push(`  ${img.repository}${tag} (${img.size})`);
@@ -220,48 +227,35 @@ export function compactBuildMap(data) {
     return {
         success: data.success,
         ...(data.imageId ? { imageId: data.imageId } : {}),
-        duration: data.duration,
-        errorCount: (data.errors ?? []).length,
-        ...(data.cacheHits != null ? { cacheHits: data.cacheHits } : {}),
-        ...(data.cacheMisses != null ? { cacheMisses: data.cacheMisses } : {}),
     };
 }
 export function formatBuildCompact(data) {
     if (data.success) {
         const id = data.imageId ? ` → ${data.imageId}` : "";
-        const cache = data.cacheHits != null || data.cacheMisses != null
-            ? ` [cache h=${data.cacheHits ?? 0} m=${data.cacheMisses ?? 0}]`
-            : "";
-        return `Build succeeded in ${data.duration}s${id}${cache}`;
+        return `Build succeeded${id}`;
     }
-    const cache = data.cacheHits != null || data.cacheMisses != null
-        ? `, cache h=${data.cacheHits ?? 0} m=${data.cacheMisses ?? 0}`
-        : "";
-    return `Build failed (${data.duration}s, ${data.errorCount} errors${cache})`;
+    return "Build failed";
 }
 export function compactLogsMap(data) {
     const HEAD_SIZE = 5;
     const TAIL_SIZE = 5;
     const lines = data.lines ?? [];
+    const total = lines.length;
     return {
-        container: data.container,
-        total: data.total,
         head: lines.slice(0, HEAD_SIZE),
-        tail: data.total > HEAD_SIZE + TAIL_SIZE ? lines.slice(-TAIL_SIZE) : [],
+        tail: total > HEAD_SIZE + TAIL_SIZE ? lines.slice(-TAIL_SIZE) : [],
     };
 }
 export function formatLogsCompact(data) {
-    const parts = [`${data.container} (${data.total} lines)`];
+    const parts = [`${data.head.length + data.tail.length} lines`];
     if (data.head.length)
         parts.push(data.head.join("\n"));
     if (data.tail.length)
-        parts.push(`  ... ${data.total - data.head.length - data.tail.length} lines omitted ...`, data.tail.join("\n"));
+        parts.push("  ... lines omitted ...", data.tail.join("\n"));
     return parts.join("\n");
 }
 export function compactPullMap(data) {
     return {
-        image: data.image,
-        tag: data.tag,
         ...(data.digest ? { digest: data.digest } : {}),
         status: data.status,
         success: data.success,
@@ -271,29 +265,26 @@ export function compactPullMap(data) {
 export function formatPullCompact(data) {
     if (!data.success) {
         const err = data.errorType ? ` (${data.errorType})` : "";
-        return `Pull failed for ${data.image}:${data.tag}${err}`;
+        return `Pull failed${err}`;
     }
     const digest = data.digest ? ` (${data.digest.slice(0, 19)}...)` : "";
     if (data.status === "up-to-date")
-        return `${data.image}:${data.tag} is up to date${digest}`;
-    return `Pulled ${data.image}:${data.tag}${digest}`;
+        return `Image is up to date${digest}`;
+    return `Pulled${digest}`;
 }
 export function compactRunMap(data) {
     return {
         containerId: data.containerId,
-        image: data.image,
         detached: data.detached,
     };
 }
 export function formatRunCompact(data) {
     const mode = data.detached ? "detached" : "attached";
-    return `Container ${data.containerId} from ${data.image} [${mode}]`;
+    return `Container ${data.containerId} [${mode}]`;
 }
 export function compactExecMap(data) {
     return {
         exitCode: data.exitCode,
-        success: data.success,
-        ...(data.duration != null ? { duration: data.duration } : {}),
         ...(data.timedOut ? { timedOut: true } : {}),
         ...(data.isTruncated ? { isTruncated: true } : {}),
         ...(data.stdout ? { stdoutPreview: data.stdout.slice(0, 200) } : {}),
@@ -301,14 +292,14 @@ export function compactExecMap(data) {
     };
 }
 export function formatExecCompact(data) {
-    const dur = data.duration != null ? ` in ${data.duration}s` : "";
+    const success = data.exitCode === 0;
     const status = data.timedOut
         ? "timed out"
-        : data.success
+        : success
             ? "succeeded"
             : `failed (exit code ${data.exitCode})`;
     const trunc = data.isTruncated ? " [truncated]" : "";
-    const lines = [`Exec ${status}${dur}${trunc}`];
+    const lines = [`Exec ${status}${trunc}`];
     if (data.stdoutPreview)
         lines.push(data.stdoutPreview);
     if (data.stderrPreview)
@@ -318,7 +309,7 @@ export function formatExecCompact(data) {
 export function compactComposeUpMap(data) {
     return {
         success: data.success,
-        started: data.started,
+        ...(data.services ? { services: data.services } : {}),
         ...(data.networksCreated != null ? { networksCreated: data.networksCreated } : {}),
         ...(data.volumesCreated != null ? { volumesCreated: data.volumesCreated } : {}),
     };
@@ -326,22 +317,22 @@ export function compactComposeUpMap(data) {
 export function formatComposeUpCompact(data) {
     if (!data.success)
         return "Compose up failed";
+    const started = (data.services ?? []).length;
     const infra = data.networksCreated != null || data.volumesCreated != null
         ? ` (networks=${data.networksCreated ?? 0}, volumes=${data.volumesCreated ?? 0})`
         : "";
-    return `Compose up: ${data.started} services started${infra}`;
+    return `Compose up: ${started} services started${infra}`;
 }
 export function compactComposeDownMap(data) {
     return {
         success: data.success,
         stopped: data.stopped,
-        removed: data.removed,
     };
 }
 export function formatComposeDownCompact(data) {
     if (!data.success)
         return "Compose down failed";
-    return `Compose down: ${data.stopped} stopped, ${data.removed} removed`;
+    return `Compose down: ${data.stopped} stopped`;
 }
 // ── Inspect ──────────────────────────────────────────────────────────
 /** Formats structured Docker inspect data into a human-readable summary.
@@ -508,9 +499,10 @@ export function formatInspectCompact(data) {
  *  #115: Shows labels when present.
  *  #116: Shows boolean flags. */
 export function formatNetworkLs(data) {
-    if (data.total === 0)
+    const total = data.networks.length;
+    if (total === 0)
         return "No networks found.";
-    const lines = [`${data.total} networks:`];
+    const lines = [`${total} networks:`];
     for (const n of data.networks) {
         const created = n.createdAt ? ` (${n.createdAt})` : "";
         const flags = [];
@@ -533,13 +525,13 @@ export function compactNetworkLsMap(data) {
             name: n.name,
             driver: n.driver,
         })),
-        total: data.total,
     };
 }
 export function formatNetworkLsCompact(data) {
-    if (data.total === 0)
+    const total = data.networks.length;
+    if (total === 0)
         return "No networks found.";
-    const lines = [`${data.total} networks:`];
+    const lines = [`${total} networks:`];
     for (const n of data.networks) {
         const id = n.id ? ` [${n.id}]` : "";
         lines.push(`  ${n.name} (${n.driver})${id}`);
@@ -550,9 +542,10 @@ export function formatNetworkLsCompact(data) {
 /** Formats structured Docker volume list into a human-readable listing.
  *  #125: Shows labels when present. */
 export function formatVolumeLs(data) {
-    if (data.total === 0)
+    const total = data.volumes.length;
+    if (total === 0)
         return "No volumes found.";
-    const lines = [`${data.total} volumes:`];
+    const lines = [`${total} volumes:`];
     for (const v of data.volumes) {
         const created = v.createdAt ? ` (${v.createdAt})` : "";
         const status = v.status ? ` status=${v.status}` : "";
@@ -568,13 +561,13 @@ export function compactVolumeLsMap(data) {
             driver: v.driver,
             ...(v.mountpoint ? { mountpoint: v.mountpoint } : {}),
         })),
-        total: data.total,
     };
 }
 export function formatVolumeLsCompact(data) {
-    if (data.total === 0)
+    const total = data.volumes.length;
+    if (total === 0)
         return "No volumes found.";
-    const lines = [`${data.total} volumes:`];
+    const lines = [`${total} volumes:`];
     for (const v of data.volumes) {
         const mp = v.mountpoint ? ` @ ${v.mountpoint}` : "";
         lines.push(`  ${v.name} (${v.driver})${mp}`);
@@ -585,15 +578,18 @@ export function formatVolumeLsCompact(data) {
 /** Formats structured Docker Compose build output into a human-readable summary.
  *  #99: Shows per-service duration. */
 export function formatComposeBuild(data) {
-    if (!data.success && data.built === 0) {
-        const lines = [`Compose build failed (${data.duration}s)`];
-        for (const s of data.services ?? []) {
+    const services = data.services ?? [];
+    const built = services.filter((s) => s.success).length;
+    const failed = services.filter((s) => !s.success).length;
+    if (!data.success && built === 0) {
+        const lines = ["Compose build failed"];
+        for (const s of services) {
             if (s.error)
                 lines.push(`  ${s.service}: ${s.error}`);
         }
         return lines.join("\n");
     }
-    const lines = [`Compose build: ${data.built} built, ${data.failed} failed (${data.duration}s)`];
+    const lines = [`Compose build: ${built} built, ${failed} failed`];
     for (const s of data.services ?? []) {
         const status = s.success ? "built" : "failed";
         const error = s.error ? ` — ${s.error}` : "";
@@ -608,9 +604,10 @@ export function formatComposeBuild(data) {
 /** Formats structured Docker stats data into a human-readable listing with CPU, memory, and I/O.
  *  #123/#124: Shows numeric memory and I/O values. */
 export function formatStats(data) {
-    if (data.total === 0)
+    const total = data.containers.length;
+    if (total === 0)
         return "No container stats available.";
-    const lines = [`${data.total} containers:`];
+    const lines = [`${total} containers:`];
     for (const c of data.containers) {
         const state = c.state ? ` [${c.state}]` : "";
         lines.push(`  ${c.name}${state} (${c.id}) CPU: ${c.cpuPercent.toFixed(2)}% Mem: ${c.memoryUsage}/${c.memoryLimit} (${c.memoryPercent.toFixed(2)}%) Net: ${c.netIO} Block: ${c.blockIO} PIDs: ${c.pids}`);
@@ -620,16 +617,24 @@ export function formatStats(data) {
 export function compactComposeBuildMap(data) {
     return {
         success: data.success,
-        built: data.built,
-        failed: data.failed,
-        duration: data.duration,
+        ...(data.services
+            ? {
+                services: data.services.map((s) => ({
+                    service: s.service,
+                    success: s.success,
+                })),
+            }
+            : {}),
     };
 }
 export function formatComposeBuildCompact(data) {
-    if (!data.success && data.built === 0) {
-        return `Compose build failed (${data.duration}s)`;
+    const services = data.services ?? [];
+    const built = services.filter((s) => s.success).length;
+    const failed = services.filter((s) => !s.success).length;
+    if (!data.success && built === 0) {
+        return "Compose build failed";
     }
-    return `Compose build: ${data.built} built, ${data.failed} failed (${data.duration}s)`;
+    return `Compose build: ${built} built, ${failed} failed`;
 }
 export function compactStatsMap(data) {
     return {
@@ -642,13 +647,13 @@ export function compactStatsMap(data) {
             memoryPercent: c.memoryPercent,
             pids: c.pids,
         })),
-        total: data.total,
     };
 }
 export function formatStatsCompact(data) {
-    if (data.total === 0)
+    const total = data.containers.length;
+    if (total === 0)
         return "No container stats available.";
-    const lines = [`${data.total} containers:`];
+    const lines = [`${total} containers:`];
     for (const c of data.containers) {
         const mem = c.memoryUsage ? ` ${c.memoryUsage}` : "";
         const state = c.state ? ` [${c.state}]` : "";
@@ -661,12 +666,13 @@ export function formatStatsCompact(data) {
  *  #105: Shows health status.
  *  #106: Shows running/stopped counts. */
 export function formatComposePs(data) {
-    if (data.total === 0)
+    const total = data.services.length;
+    if (total === 0)
         return "No compose services found.";
-    const countInfo = data.running != null && data.stopped != null
-        ? ` (${data.running} running, ${data.stopped} stopped)`
-        : "";
-    const lines = [`${data.total} services${countInfo}:`];
+    const running = data.services.filter((s) => s.state === "running").length;
+    const stopped = data.services.filter((s) => s.state === "exited" || s.state === "dead" || s.state === "removing").length;
+    const countInfo = ` (${running} running, ${stopped} stopped)`;
+    const lines = [`${total} services${countInfo}:`];
     for (const s of data.services) {
         const portsArr = s.ports ?? [];
         const ports = portsArr.length
@@ -686,13 +692,13 @@ export function compactComposePsMap(data) {
             state: s.state,
             ...(s.exitCode != null ? { exitCode: s.exitCode } : {}),
         })),
-        total: data.total,
     };
 }
 export function formatComposePsCompact(data) {
-    if (data.total === 0)
+    const total = data.services.length;
+    if (total === 0)
         return "No compose services found.";
-    const lines = [`${data.total} services:`];
+    const lines = [`${total} services:`];
     for (const s of data.services) {
         const exit = s.exitCode != null ? ` exit=${s.exitCode}` : "";
         lines.push(`  ${s.state.padEnd(10)} ${s.name} (${s.service})${exit}`);
@@ -703,9 +709,13 @@ export function formatComposePsCompact(data) {
 /** Formats structured Docker Compose logs into a human-readable output grouped by service.
  *  #104: Shows log level when available. */
 export function formatComposeLogs(data) {
+    const entries = data.entries ?? [];
+    const total = entries.length;
+    const serviceSet = new Set(entries.map((e) => e.service));
+    const serviceCount = serviceSet.size;
     const header = data.isTruncated
-        ? `Compose logs: ${data.services.length} services, ${data.total} of ${data.totalEntries} entries (truncated)`
-        : `Compose logs: ${data.services.length} services, ${data.total} entries`;
+        ? `Compose logs: ${serviceCount} services, ${total} entries (truncated)`
+        : `Compose logs: ${serviceCount} services, ${total} entries`;
     const lines = [header];
     for (const entry of data.entries ?? []) {
         const ts = entry.timestamp ? `${entry.timestamp} ` : "";
@@ -718,15 +728,14 @@ export function compactComposeLogsMap(data) {
     const HEAD_SIZE = 5;
     const TAIL_SIZE = 5;
     const entries = data.entries ?? [];
+    const total = entries.length;
     return {
-        services: data.services,
-        total: data.total,
         head: entries.slice(0, HEAD_SIZE).map((e) => ({
             service: e.service,
             message: e.message,
             ...(e.timestamp ? { timestamp: e.timestamp } : {}),
         })),
-        tail: data.total > HEAD_SIZE + TAIL_SIZE
+        tail: total > HEAD_SIZE + TAIL_SIZE
             ? entries.slice(-TAIL_SIZE).map((e) => ({
                 service: e.service,
                 message: e.message,
@@ -736,13 +745,15 @@ export function compactComposeLogsMap(data) {
     };
 }
 export function formatComposeLogsCompact(data) {
-    const parts = [`Compose logs: ${data.services.length} services, ${data.total} entries`];
+    const total = data.head.length + data.tail.length;
+    const serviceSet = new Set([...data.head, ...data.tail].map((e) => e.service));
+    const parts = [`Compose logs: ${serviceSet.size} services, ${total} entries`];
     for (const e of data.head) {
         const ts = e.timestamp ? `${e.timestamp} ` : "";
         parts.push(`  ${e.service} | ${ts}${e.message}`);
     }
     if (data.tail.length) {
-        parts.push(`  ... ${data.total - data.head.length - data.tail.length} entries omitted ...`);
+        parts.push("  ... entries omitted ...");
         for (const e of data.tail) {
             const ts = e.timestamp ? `${e.timestamp} ` : "";
             parts.push(`  ${e.service} | ${ts}${e.message}`);