@bensandee/tooling 0.18.0 → 0.21.0

package/README.md

@@ -162,17 +162,17 @@ import type {
 | `DetectedProjectState` | Detected existing project state (package manager, CI, etc.)                                     |
 | `LegacyConfig`         | Legacy config detection for migration                                                           |
 
-## Docker verification
+## Docker check
 
-The `@bensandee/tooling/docker-verify` export provides utilities for verifying Docker Compose stacks via health checks.
+The `@bensandee/tooling/docker-check` export provides utilities for checking Docker Compose stacks via health checks.
 
 ### Quick start
 
 ```ts
-import { createRealExecutor, runVerification } from "@bensandee/tooling/docker-verify";
-import type { VerifyConfig } from "@bensandee/tooling/docker-verify";
+import { createRealExecutor, runDockerCheck } from "@bensandee/tooling/docker-check";
+import type { CheckConfig } from "@bensandee/tooling/docker-check";
 
-const config: VerifyConfig = {
+const config: CheckConfig = {
   compose: {
     cwd: "./deploy",
     composeFiles: ["docker-compose.yaml"],
@@ -190,7 +190,7 @@ const config: VerifyConfig = {
   pollIntervalMs: 5_000,
 };
 
-const result = await runVerification(createRealExecutor(), config);
+const result = await runDockerCheck(createRealExecutor(), config);
 if (!result.success) {
   console.error(result.reason, result.message);
 }
@@ -200,7 +200,7 @@ if (!result.success) {
 
 | Export                                 | Description                                                       |
 | -------------------------------------- | ----------------------------------------------------------------- |
-| `runVerification(executor, config)`    | Full lifecycle: build, compose up, health check polling, teardown |
+| `runDockerCheck(executor, config)`     | Full lifecycle: build, compose up, health check polling, teardown |
 | `createRealExecutor()`                 | Production executor (real shell, fetch, timers)                   |
 | `composeUp(executor, config)`          | Start compose services                                            |
 | `composeDown(executor, config)`        | Stop and remove compose services                                  |
@@ -211,11 +211,11 @@ if (!result.success) {
 
 ### Types
 
-| Type                   | Description                                                                                |
-| ---------------------- | ------------------------------------------------------------------------------------------ |
-| `VerifyConfig`         | Full verification config (compose settings, build command, health checks, timeouts)        |
-| `ComposeConfig`        | Docker Compose settings (cwd, compose files, env file, services)                           |
-| `HttpHealthCheck`      | Health check definition (name, URL, validate function)                                     |
-| `VerifyResult`         | Result: `{ success: true, elapsedMs }` or `{ success: false, reason, message, elapsedMs }` |
-| `DockerVerifyExecutor` | Side-effect abstraction (exec, fetch, timers) for testability                              |
-| `ContainerInfo`        | Container status info from `composePs`                                                     |
+| Type                  | Description                                                                                |
+| --------------------- | ------------------------------------------------------------------------------------------ |
+| `CheckConfig`         | Full check config (compose settings, build command, health checks, timeouts)               |
+| `ComposeConfig`       | Docker Compose settings (cwd, compose files, env file, services)                           |
+| `HttpHealthCheck`     | Health check definition (name, URL, validate function)                                     |
+| `CheckResult`         | Result: `{ success: true, elapsedMs }` or `{ success: false, reason, message, elapsedMs }` |
+| `DockerCheckExecutor` | Side-effect abstraction (exec, fetch, timers) for testability                              |
+| `ContainerInfo`       | Container status info from `composePs`                                                     |