feat(plan): hide plan write and edit operations on plans in Plan Mode (#19012)

packages/core/src/utils/tool-utils.ts

@@ -8,6 +8,61 @@ import type { AnyDeclarativeTool, AnyToolInvocation } from '../index.js';
 import { isTool } from '../index.js';
 import { SHELL_TOOL_NAMES } from './shell-utils.js';
 import levenshtein from 'fast-levenshtein';
+import { ApprovalMode } from '../policy/types.js';
+import { CoreToolCallStatus } from '../scheduler/types.js';
+import {
+  ASK_USER_DISPLAY_NAME,
+  WRITE_FILE_DISPLAY_NAME,
+  EDIT_DISPLAY_NAME,
+} from '../tools/tool-names.js';
+
+/**
+ * Options for determining if a tool call should be hidden in the CLI history.
+ */
+export interface ShouldHideToolCallParams {
+  /** The display name of the tool. */
+  displayName: string;
+  /** The current status of the tool call. */
+  status: CoreToolCallStatus;
+  /** The approval mode active when the tool was called. */
+  approvalMode?: ApprovalMode;
+  /** Whether the tool has produced a result for display. */
+  hasResultDisplay: boolean;
+}
+
+/**
+ * Determines if a tool call should be hidden from the standard tool history UI.
+ *
+ * We hide tools in several cases:
+ * 1. Ask User tools that are in progress, displayed via specialized UI.
+ * 2. Ask User tools that errored without result display, typically param
+ *    validation errors that the agent automatically recovers from.
+ * 3. WriteFile and Edit tools when in Plan Mode, redundant because the
+ *    resulting plans are displayed separately upon exiting plan mode.
+ */
+export function shouldHideToolCall(params: ShouldHideToolCallParams): boolean {
+  const { displayName, status, approvalMode, hasResultDisplay } = params;
+
+  switch (displayName) {
+    case ASK_USER_DISPLAY_NAME:
+      switch (status) {
+        case CoreToolCallStatus.Scheduled:
+        case CoreToolCallStatus.Validating:
+        case CoreToolCallStatus.Executing:
+        case CoreToolCallStatus.AwaitingApproval:
+          return true;
+        case CoreToolCallStatus.Error:
+          return !hasResultDisplay;
+        default:
+          return false;
+      }
+    case WRITE_FILE_DISPLAY_NAME:
+    case EDIT_DISPLAY_NAME:
+      return approvalMode === ApprovalMode.PLAN;
+    default:
+      return false;
+  }
+}
 
 /**
  * Generates a suggestion string for a tool name that was not found in the registry.