docs: document cli test batch

steipete · steipete · commit 8cb093e7a9e5 · 2026-06-04T19:32:43.000-04:00
diff --git a/src/cli/capability-cli.test.ts b/src/cli/capability-cli.test.ts
@@ -1,3 +1,4 @@
+// Capability CLI tests cover capability command registration and output formatting.
 import fs from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
diff --git a/src/cli/channel-auth.test.ts b/src/cli/channel-auth.test.ts
@@ -1,3 +1,4 @@
+// Channel auth CLI tests cover channel auth command routing and credential prompts.
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { runChannelLogin, runChannelLogout } from "./channel-auth.js";
 
diff --git a/src/cli/cli-utils.test.ts b/src/cli/cli-utils.test.ts
@@ -1,3 +1,4 @@
+// CLI utility tests cover shared command helpers, option parsing, and output formatting.
 import { Command } from "commander";
 import { describe, expect, it, vi } from "vitest";
 import { registerDnsCli } from "./dns-cli.js";
diff --git a/src/cli/command-path-matches.test.ts b/src/cli/command-path-matches.test.ts
@@ -1,3 +1,4 @@
+// Command path match tests cover CLI command path matching and normalization.
 import { describe, expect, it } from "vitest";
 import {
   matchesAnyCommandPath,
diff --git a/src/cli/command-path-policy.test.ts b/src/cli/command-path-policy.test.ts
@@ -1,3 +1,4 @@
+// Command path policy tests cover allowed CLI command path shapes and lazy imports.
 import { importFreshModule } from "openclaw/plugin-sdk/test-fixtures";
 import { afterEach, describe, expect, it, vi } from "vitest";
 import type { CliCommandCatalogEntry, CliCommandPathPolicy } from "./command-catalog.js";
diff --git a/src/cli/command-registration-policy.test.ts b/src/cli/command-registration-policy.test.ts
@@ -1,3 +1,4 @@
+// Command registration policy tests cover CLI registration boundaries and duplicate guards.
 import { describe, expect, it } from "vitest";
 import {
   shouldEagerRegisterSubcommands,
diff --git a/src/cli/command-secret-gateway.test.ts b/src/cli/command-secret-gateway.test.ts
@@ -1,3 +1,4 @@
+// Command secret gateway tests cover secret resolution for gateway-backed CLI commands.
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import type { OpenClawConfig } from "../config/config.js";
 import { withEnvAsync } from "../test-utils/env.js";
diff --git a/src/cli/completion-runtime.test.ts b/src/cli/completion-runtime.test.ts
@@ -1,3 +1,4 @@
+// Completion runtime tests cover shell completion generation and runtime file writes.
 import fs from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
diff --git a/src/cli/config-cli.test.ts b/src/cli/config-cli.test.ts
@@ -1,3 +1,4 @@
+// Config CLI tests cover config command registration, reads, writes, and output modes.
 import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
@@ -2265,10 +2266,7 @@ describe("config cli", () => {
       const rootDir = fs.mkdtempSync(path.join(os.tmpdir(), "openclaw-config-plugin-provider-"));
       try {
         writeSecurePluginEntrypoint(path.join(rootDir, "index.js"), "export default {};\n");
-        writeSecurePluginEntrypoint(
-          path.join(rootDir, "resolve.mjs"),
-          "process.stdin.resume();\n",
-        );
+        writeSecurePluginEntrypoint(path.join(rootDir, "resolve.mjs"), "process.stdin.resume();\n");
         const resolved = {
           secrets: {
             providers: {},
diff --git a/src/cli/devices-cli.lazy.test.ts b/src/cli/devices-cli.lazy.test.ts
@@ -1,3 +1,4 @@
+// Devices CLI lazy tests cover lazy device command imports and registration.
 import { Command } from "commander";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 
diff --git a/src/cli/directory-cli.test.ts b/src/cli/directory-cli.test.ts
@@ -1,3 +1,4 @@
+// Directory CLI tests cover directory command registration and plugin-backed lookups.
 import { Command } from "commander";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { registerDirectoryCli } from "./directory-cli.js";
diff --git a/src/cli/json-output-mode.test.ts b/src/cli/json-output-mode.test.ts
@@ -1,3 +1,4 @@
+// JSON output mode tests cover CLI JSON mode detection and output handling.
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
 import { loggingState } from "../logging/state.js";
 import { hasJsonOutputFlag, withConsoleLogsRoutedToStderrForJson } from "./json-output-mode.js";
diff --git a/src/cli/logs-cli.test.ts b/src/cli/logs-cli.test.ts
@@ -1,3 +1,4 @@
+// Logs CLI tests cover log command routing and runtime log output behavior.
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { GatewayTransportError } from "../gateway/call.js";
 import { runRegisteredCli } from "../test-utils/command-runner.js";
diff --git a/src/cli/mcp-cli.test.ts b/src/cli/mcp-cli.test.ts
@@ -1,3 +1,4 @@
+// MCP CLI tests cover MCP command registration and server configuration behavior.
 import fs from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
diff --git a/src/cli/models-cli.test.ts b/src/cli/models-cli.test.ts
@@ -1,3 +1,4 @@
+// Models CLI tests cover model listing command registration and provider output.
 import { Command } from "commander";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { runRegisteredCli } from "../test-utils/command-runner.js";
diff --git a/src/cli/native-hook-relay-cli.test.ts b/src/cli/native-hook-relay-cli.test.ts
@@ -1,3 +1,4 @@
+// Native hook relay CLI tests cover relay command registration and runtime delegation.
 import { describe, expect, it, vi } from "vitest";
 import {
   createReadableTextStream,
diff --git a/src/cli/outbound-send-mapping.test.ts b/src/cli/outbound-send-mapping.test.ts
@@ -1,3 +1,4 @@
+// Outbound send mapping tests cover CLI-to-channel outbound payload mapping.
 import { describe, expect, it, vi } from "vitest";
 import {
   CLI_OUTBOUND_SEND_FACTORY,
diff --git a/src/cli/plugin-registry.test.ts b/src/cli/plugin-registry.test.ts
@@ -1,3 +1,4 @@
+// Plugin registry CLI tests cover registry loading, command integration, and reset behavior.
 import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
 import { createEmptyPluginRegistry } from "../plugins/registry.js";
 
diff --git a/src/cli/plugins-cli.list.test.ts b/src/cli/plugins-cli.list.test.ts
@@ -1,3 +1,4 @@
+// Plugins CLI list tests cover plugin listing output and installed-state formatting.
 import { beforeEach, describe, expect, it } from "vitest";
 import { createPluginRecord } from "../plugins/status.test-helpers.js";
 import {
diff --git a/src/cli/plugins-cli.uninstall.test.ts b/src/cli/plugins-cli.uninstall.test.ts
@@ -1,3 +1,4 @@
+// Plugins CLI uninstall tests cover plugin removal selection and uninstall output.
 import { installedPluginRoot } from "openclaw/plugin-sdk/test-fixtures";
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
 import type { OpenClawConfig } from "../config/config.js";
diff --git a/src/cli/plugins-install-record-commit.test.ts b/src/cli/plugins-install-record-commit.test.ts
@@ -1,3 +1,4 @@
+// Plugin install record commit tests cover install record persistence after CLI installs.
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import type { OpenClawConfig } from "../config/types.openclaw.js";
 import type { PluginInstallRecord } from "../config/types.plugins.js";
diff --git a/src/cli/plugins-location-bridges.test.ts b/src/cli/plugins-location-bridges.test.ts
@@ -1,3 +1,4 @@
+// Plugin location bridge tests cover CLI plugin path bridging between install surfaces.
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import type { InstalledPluginIndex } from "../plugins/installed-plugin-index.js";
 import type { InstalledPluginStartupInfo } from "../plugins/installed-plugin-index.js";
diff --git a/src/cli/profile.test.ts b/src/cli/profile.test.ts
@@ -1,3 +1,4 @@
+// Profile CLI tests cover profile selection, persistence, and command wiring.
 import path from "node:path";
 import { describe, expect, it } from "vitest";
 import { formatCliCommand } from "./command-format.js";
diff --git a/src/cli/program.nodes-basic.e2e.test.ts b/src/cli/program.nodes-basic.e2e.test.ts
@@ -1,3 +1,4 @@
+// Program nodes basic e2e tests cover node command registration through the full CLI program.
 import { Command } from "commander";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { createIosNodeListResponse } from "./program.nodes-test-helpers.js";
diff --git a/src/cli/program.smoke.test.ts b/src/cli/program.smoke.test.ts
@@ -1,3 +1,4 @@
+// Program smoke tests cover core CLI command registration and startup behavior.
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { buildProgram } from "./program.js";
 import {
diff --git a/src/cli/program.test-mocks.ts b/src/cli/program.test-mocks.ts
@@ -1,3 +1,4 @@
+// Program test mocks provide shared CLI command doubles and typed Vitest helpers.
 import { vi, type Mock } from "vitest";
 
 type AnyMock = Mock<(...args: unknown[]) => unknown>;
diff --git a/src/cli/progress.test.ts b/src/cli/progress.test.ts
@@ -1,3 +1,4 @@
+// Progress tests cover CLI progress rendering and lifecycle cleanup.
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { MAX_TIMER_TIMEOUT_MS } from "../shared/number-coercion.js";
 import { createCliProgress, shouldUseInteractiveProgressSpinner } from "./progress.js";
diff --git a/src/cli/prompt.test.ts b/src/cli/prompt.test.ts
@@ -1,3 +1,4 @@
+// Prompt tests cover CLI prompt input handling and cancellation behavior.
 import readline from "node:readline/promises";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { isYes, setVerbose, setYes } from "../globals.js";
diff --git a/src/cli/proxy-cli.runtime.test.ts b/src/cli/proxy-cli.runtime.test.ts
@@ -1,3 +1,4 @@
+// Proxy CLI runtime tests cover proxy runtime process handling and lifecycle events.
 import { EventEmitter } from "node:events";
 import { mkdtempSync, rmSync } from "node:fs";
 import os from "node:os";
diff --git a/src/cli/proxy-cli.test.ts b/src/cli/proxy-cli.test.ts
@@ -1,3 +1,4 @@
+// Proxy CLI tests cover proxy command registration and option parsing.
 import { Command } from "commander";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { registerProxyCli } from "./proxy-cli.js";
diff --git a/src/cli/qr-cli.test.ts b/src/cli/qr-cli.test.ts
@@ -1,3 +1,4 @@
+// QR CLI tests cover QR command registration and terminal output behavior.
 import { Command } from "commander";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { encodePairingSetupCode } from "../pairing/setup-code.js";
diff --git a/src/cli/qr-dashboard.integration.test.ts b/src/cli/qr-dashboard.integration.test.ts
@@ -1,3 +1,4 @@
+// QR dashboard integration tests cover QR dashboard command wiring and rendered output.
 import { Command } from "commander";
 import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
 import { captureEnv } from "../test-utils/env.js";
diff --git a/src/cli/root-help-live-config.test.ts b/src/cli/root-help-live-config.test.ts
@@ -1,3 +1,4 @@
+// Root help live config tests cover root help output derived from live config state.
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { loadRootHelpRenderOptionsForConfigSensitivePlugins } from "./root-help-live-config.js";
 
diff --git a/src/cli/run-main.test.ts b/src/cli/run-main.test.ts
@@ -1,3 +1,4 @@
+// Run main tests cover CLI main entrypoint behavior and process error handling.
 import { describe, expect, it } from "vitest";
 import type { PluginManifestCommandAliasRegistry } from "../plugins/manifest-command-aliases.js";
 import {
diff --git a/src/cli/skills-cli.formatting.test.ts b/src/cli/skills-cli.formatting.test.ts
@@ -1,3 +1,4 @@
+// Skills CLI formatting tests cover skill listing and display formatting.
 import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
diff --git a/src/cli/skills-cli.workshop.test.ts b/src/cli/skills-cli.workshop.test.ts
@@ -1,3 +1,4 @@
+// Skills workshop CLI tests cover workshop skill commands and filesystem setup.
 import fs from "node:fs/promises";
 import path from "node:path";
 import { Command } from "commander";
diff --git a/src/cli/startup-metadata.test.ts b/src/cli/startup-metadata.test.ts
@@ -1,3 +1,4 @@
+// Startup metadata tests cover CLI startup metadata collection and propagation.
 import path from "node:path";
 import { pathToFileURL } from "node:url";
 import { describe, expect, it } from "vitest";
diff --git a/src/cli/tagline.test.ts b/src/cli/tagline.test.ts
@@ -1,3 +1,4 @@
+// Tagline tests cover CLI tagline selection and display formatting.
 import { describe, expect, it } from "vitest";
 import { DEFAULT_TAGLINE, pickTagline } from "./tagline.js";
 
diff --git a/src/cli/update-cli.option-collisions.test.ts b/src/cli/update-cli.option-collisions.test.ts
@@ -1,3 +1,4 @@
+// Update CLI option collision tests cover update command flag registration boundaries.
 import { Command } from "commander";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { runRegisteredCli } from "../test-utils/command-runner.js";
diff --git a/src/cli/update-cli.test.ts b/src/cli/update-cli.test.ts
@@ -1,3 +1,4 @@
+// Update CLI tests cover update command behavior, runtime calls, and output handling.
 import { EventEmitter } from "node:events";
 import fsSync from "node:fs";
 import fs from "node:fs/promises";

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Capability CLI tests cover capability command registration and output formatting.`
`1`	`2`	`import fs from "node:fs/promises";`
`2`	`3`	`import os from "node:os";`
`3`	`4`	`import path from "node:path";`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Channel auth CLI tests cover channel auth command routing and credential prompts.`
`1`	`2`	`import { beforeEach, describe, expect, it, vi } from "vitest";`
`2`	`3`	`import { runChannelLogin, runChannelLogout } from "./channel-auth.js";`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// CLI utility tests cover shared command helpers, option parsing, and output formatting.`
`1`	`2`	`import { Command } from "commander";`
`2`	`3`	`import { describe, expect, it, vi } from "vitest";`
`3`	`4`	`import { registerDnsCli } from "./dns-cli.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Command path match tests cover CLI command path matching and normalization.`
`1`	`2`	`import { describe, expect, it } from "vitest";`
`2`	`3`	`import {`
`3`	`4`	`matchesAnyCommandPath,`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Command path policy tests cover allowed CLI command path shapes and lazy imports.`
`1`	`2`	`import { importFreshModule } from "openclaw/plugin-sdk/test-fixtures";`
`2`	`3`	`import { afterEach, describe, expect, it, vi } from "vitest";`
`3`	`4`	`import type { CliCommandCatalogEntry, CliCommandPathPolicy } from "./command-catalog.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Command registration policy tests cover CLI registration boundaries and duplicate guards.`
`1`	`2`	`import { describe, expect, it } from "vitest";`
`2`	`3`	`import {`
`3`	`4`	`shouldEagerRegisterSubcommands,`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Command secret gateway tests cover secret resolution for gateway-backed CLI commands.`
`1`	`2`	`import { beforeEach, describe, expect, it, vi } from "vitest";`
`2`	`3`	`import type { OpenClawConfig } from "../config/config.js";`
`3`	`4`	`import { withEnvAsync } from "../test-utils/env.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Completion runtime tests cover shell completion generation and runtime file writes.`
`1`	`2`	`import fs from "node:fs/promises";`
`2`	`3`	`import os from "node:os";`
`3`	`4`	`import path from "node:path";`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Devices CLI lazy tests cover lazy device command imports and registration.`
`1`	`2`	`import { Command } from "commander";`
`2`	`3`	`import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";`
`3`	`4`