From d970882428a264d122b2f60fc91a4d72da912a93 Mon Sep 17 00:00:00 2001 From: Taylor Mullen Date: Thu, 17 Apr 2025 17:25:01 -0400 Subject: Fix build break (tool -> tools). - Without this we'd get a TS1261 about the name "tool" only differeing from "Tool" (the class) by case. --- packages/cli/src/core/gemini-client.ts | 2 +- packages/cli/src/core/history-updater.ts | 2 +- packages/cli/src/tools/Tool.ts | 147 --------------------- packages/cli/src/tools/edit.tool.ts | 2 +- packages/cli/src/tools/glob.tool.ts | 2 +- packages/cli/src/tools/grep.tool.ts | 2 +- packages/cli/src/tools/ls.tool.ts | 2 +- packages/cli/src/tools/read-file.tool.ts | 2 +- packages/cli/src/tools/terminal.tool.ts | 2 +- packages/cli/src/tools/tool-registry.ts | 2 +- packages/cli/src/tools/tools.ts | 147 +++++++++++++++++++++ packages/cli/src/tools/write-file.tool.ts | 2 +- .../cli/src/ui/components/messages/ToolMessage.tsx | 2 +- packages/cli/src/ui/types.ts | 2 +- 14 files changed, 159 insertions(+), 159 deletions(-) delete mode 100644 packages/cli/src/tools/Tool.ts create mode 100644 packages/cli/src/tools/tools.ts (limited to 'packages/cli/src') diff --git a/packages/cli/src/core/gemini-client.ts b/packages/cli/src/core/gemini-client.ts index e41fda6f..67812f8e 100644 --- a/packages/cli/src/core/gemini-client.ts +++ b/packages/cli/src/core/gemini-client.ts @@ -10,7 +10,7 @@ import { CoreSystemPrompt } from './prompts.js'; import { type ToolCallEvent, type ToolCallConfirmationDetails, ToolCallStatus } from '../ui/types.js'; import process from 'node:process'; import { toolRegistry } from '../tools/tool-registry.js'; -import { ToolResult } from '../tools/tool.js'; +import { ToolResult } from '../tools/tools.js'; import { getFolderStructure } from '../utils/getFolderStructure.js'; import { GeminiEventType, GeminiStream } from './gemini-stream.js'; diff --git a/packages/cli/src/core/history-updater.ts b/packages/cli/src/core/history-updater.ts index 4013728f..369454ff 100644 --- a/packages/cli/src/core/history-updater.ts +++ b/packages/cli/src/core/history-updater.ts @@ -1,7 +1,7 @@ import { Part } from "@google/genai"; import { toolRegistry } from "../tools/tool-registry.js"; import { HistoryItem, IndividualToolCallDisplay, ToolCallEvent, ToolCallStatus, ToolConfirmationOutcome, ToolEditConfirmationDetails, ToolExecuteConfirmationDetails } from "../ui/types.js"; -import { ToolResultDisplay } from "../tools/tool.js"; +import { ToolResultDisplay } from "../tools/tools.js"; /** * Processes a tool call chunk and updates the history state accordingly. diff --git a/packages/cli/src/tools/Tool.ts b/packages/cli/src/tools/Tool.ts deleted file mode 100644 index 21dd88d5..00000000 --- a/packages/cli/src/tools/Tool.ts +++ /dev/null @@ -1,147 +0,0 @@ -import { FunctionDeclaration, Schema } from "@google/genai"; -import { ToolCallConfirmationDetails } from "../ui/types.js"; - -/** - * Interface representing the base Tool functionality - */ -export interface Tool { - /** - * The internal name of the tool (used for API calls) - */ - name: string; - - /** - * The user-friendly display name of the tool - */ - displayName: string; - - /** - * Description of what the tool does - */ - description: string; - - /** - * Function declaration schema from @google/genai - */ - schema: FunctionDeclaration; - - /** - * Validates the parameters for the tool - * @param params Parameters to validate - * @returns An error message string if invalid, null otherwise - */ - invalidParams(params: TParams): string | null; - - /** - * Gets a pre-execution description of the tool operation - * @param params Parameters for the tool execution - * @returns A markdown string describing what the tool will do - * Optional for backward compatibility - */ - getDescription(params: TParams): string; - - /** - * Determines if the tool should prompt for confirmation before execution - * @param params Parameters for the tool execution - * @returns Whether execute should be confirmed. - */ - shouldConfirmExecute(params: TParams): Promise; - - /** - * Executes the tool with the given parameters - * @param params Parameters for the tool execution - * @returns Result of the tool execution - */ - execute(params: TParams): Promise; -} - - -/** - * Base implementation for tools with common functionality - */ -export abstract class BaseTool implements Tool { - /** - * Creates a new instance of BaseTool - * @param name Internal name of the tool (used for API calls) - * @param displayName User-friendly display name of the tool - * @param description Description of what the tool does - * @param parameterSchema JSON Schema defining the parameters - */ - constructor( - public readonly name: string, - public readonly displayName: string, - public readonly description: string, - public readonly parameterSchema: Record - ) {} - - /** - * Function declaration schema computed from name, description, and parameterSchema - */ - get schema(): FunctionDeclaration { - return { - name: this.name, - description: this.description, - parameters: this.parameterSchema as Schema - }; - } - - /** - * Validates the parameters for the tool - * This is a placeholder implementation and should be overridden - * @param params Parameters to validate - * @returns An error message string if invalid, null otherwise - */ - invalidParams(params: TParams): string | null { - // Implementation would typically use a JSON Schema validator - // This is a placeholder that should be implemented by derived classes - return null; - } - - /** - * Gets a pre-execution description of the tool operation - * Default implementation that should be overridden by derived classes - * @param params Parameters for the tool execution - * @returns A markdown string describing what the tool will do - */ - getDescription(params: TParams): string { - return JSON.stringify(params); - } - - /** - * Determines if the tool should prompt for confirmation before execution - * @param params Parameters for the tool execution - * @returns Whether or not execute should be confirmed by the user. - */ - shouldConfirmExecute(params: TParams): Promise { - return Promise.resolve(false); - } - - /** - * Abstract method to execute the tool with the given parameters - * Must be implemented by derived classes - * @param params Parameters for the tool execution - * @returns Result of the tool execution - */ - abstract execute(params: TParams): Promise; -} - - -export interface ToolResult { - /** - * Content meant to be included in LLM history. - * This should represent the factual outcome of the tool execution. - */ - llmContent: string; - - /** - * Markdown string for user display. - * This provides a user-friendly summary or visualization of the result. - */ - returnDisplay: ToolResultDisplay; -} - -export type ToolResultDisplay = string | FileDiff; - -export interface FileDiff { - fileDiff: string -} diff --git a/packages/cli/src/tools/edit.tool.ts b/packages/cli/src/tools/edit.tool.ts index 6b7f02cf..52ef4fe8 100644 --- a/packages/cli/src/tools/edit.tool.ts +++ b/packages/cli/src/tools/edit.tool.ts @@ -2,7 +2,7 @@ import fs from 'fs'; import path from 'path'; import * as Diff from 'diff'; import { SchemaValidator } from '../utils/schemaValidator.js'; -import { BaseTool, ToolResult } from './tool.js'; +import { BaseTool, ToolResult } from './tools.js'; import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolEditConfirmationDetails } from '../ui/types.js'; import { makeRelative, shortenPath } from '../utils/paths.js'; import { ReadFileTool } from './read-file.tool.js'; diff --git a/packages/cli/src/tools/glob.tool.ts b/packages/cli/src/tools/glob.tool.ts index 5a427e75..b63aa1cc 100644 --- a/packages/cli/src/tools/glob.tool.ts +++ b/packages/cli/src/tools/glob.tool.ts @@ -2,7 +2,7 @@ import fs from 'fs'; import path from 'path'; import fg from 'fast-glob'; import { SchemaValidator } from '../utils/schemaValidator.js'; -import { BaseTool, ToolResult } from './tool.js'; +import { BaseTool, ToolResult } from './tools.js'; import { shortenPath, makeRelative } from '../utils/paths.js'; /** diff --git a/packages/cli/src/tools/grep.tool.ts b/packages/cli/src/tools/grep.tool.ts index 93c37f82..ed75890b 100644 --- a/packages/cli/src/tools/grep.tool.ts +++ b/packages/cli/src/tools/grep.tool.ts @@ -4,7 +4,7 @@ import path from 'path'; import { EOL } from 'os'; // Used for parsing grep output lines import { spawn } from 'child_process'; // Used for git grep and system grep import fastGlob from 'fast-glob'; // Used for JS fallback file searching -import { BaseTool, ToolResult } from './tool.js'; +import { BaseTool, ToolResult } from './tools.js'; import { SchemaValidator } from '../utils/schemaValidator.js'; import { makeRelative, shortenPath } from '../utils/paths.js'; diff --git a/packages/cli/src/tools/ls.tool.ts b/packages/cli/src/tools/ls.tool.ts index 9f3714f7..6c4d5848 100644 --- a/packages/cli/src/tools/ls.tool.ts +++ b/packages/cli/src/tools/ls.tool.ts @@ -1,6 +1,6 @@ import fs from 'fs'; import path from 'path'; -import { BaseTool, ToolResult } from './tool.js'; +import { BaseTool, ToolResult } from './tools.js'; import { SchemaValidator } from '../utils/schemaValidator.js'; import { makeRelative, shortenPath } from '../utils/paths.js'; diff --git a/packages/cli/src/tools/read-file.tool.ts b/packages/cli/src/tools/read-file.tool.ts index 64d59df0..7cca3391 100644 --- a/packages/cli/src/tools/read-file.tool.ts +++ b/packages/cli/src/tools/read-file.tool.ts @@ -2,7 +2,7 @@ import fs from 'fs'; import path from 'path'; import { SchemaValidator } from '../utils/schemaValidator.js'; import { makeRelative, shortenPath } from '../utils/paths.js'; -import { BaseTool, ToolResult } from './tool.js'; +import { BaseTool, ToolResult } from './tools.js'; /** * Parameters for the ReadFile tool diff --git a/packages/cli/src/tools/terminal.tool.ts b/packages/cli/src/tools/terminal.tool.ts index fed1a752..eef9b7d4 100644 --- a/packages/cli/src/tools/terminal.tool.ts +++ b/packages/cli/src/tools/terminal.tool.ts @@ -3,7 +3,7 @@ import path from 'path'; import os from 'os'; import crypto from 'crypto'; import { promises as fs } from 'fs'; -import { BaseTool, ToolResult } from './tool.js'; +import { BaseTool, ToolResult } from './tools.js'; import { SchemaValidator } from '../utils/schemaValidator.js'; import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolExecuteConfirmationDetails } from '../ui/types.js'; // Adjust path as needed import { BackgroundTerminalAnalyzer } from '../utils/BackgroundTerminalAnalyzer.js'; diff --git a/packages/cli/src/tools/tool-registry.ts b/packages/cli/src/tools/tool-registry.ts index d9f4504c..48030397 100644 --- a/packages/cli/src/tools/tool-registry.ts +++ b/packages/cli/src/tools/tool-registry.ts @@ -1,5 +1,5 @@ import { ToolListUnion, FunctionDeclaration } from '@google/genai'; -import { Tool } from './tool.js'; +import { Tool } from './tools.js'; class ToolRegistry { private tools: Map = new Map(); diff --git a/packages/cli/src/tools/tools.ts b/packages/cli/src/tools/tools.ts new file mode 100644 index 00000000..21dd88d5 --- /dev/null +++ b/packages/cli/src/tools/tools.ts @@ -0,0 +1,147 @@ +import { FunctionDeclaration, Schema } from "@google/genai"; +import { ToolCallConfirmationDetails } from "../ui/types.js"; + +/** + * Interface representing the base Tool functionality + */ +export interface Tool { + /** + * The internal name of the tool (used for API calls) + */ + name: string; + + /** + * The user-friendly display name of the tool + */ + displayName: string; + + /** + * Description of what the tool does + */ + description: string; + + /** + * Function declaration schema from @google/genai + */ + schema: FunctionDeclaration; + + /** + * Validates the parameters for the tool + * @param params Parameters to validate + * @returns An error message string if invalid, null otherwise + */ + invalidParams(params: TParams): string | null; + + /** + * Gets a pre-execution description of the tool operation + * @param params Parameters for the tool execution + * @returns A markdown string describing what the tool will do + * Optional for backward compatibility + */ + getDescription(params: TParams): string; + + /** + * Determines if the tool should prompt for confirmation before execution + * @param params Parameters for the tool execution + * @returns Whether execute should be confirmed. + */ + shouldConfirmExecute(params: TParams): Promise; + + /** + * Executes the tool with the given parameters + * @param params Parameters for the tool execution + * @returns Result of the tool execution + */ + execute(params: TParams): Promise; +} + + +/** + * Base implementation for tools with common functionality + */ +export abstract class BaseTool implements Tool { + /** + * Creates a new instance of BaseTool + * @param name Internal name of the tool (used for API calls) + * @param displayName User-friendly display name of the tool + * @param description Description of what the tool does + * @param parameterSchema JSON Schema defining the parameters + */ + constructor( + public readonly name: string, + public readonly displayName: string, + public readonly description: string, + public readonly parameterSchema: Record + ) {} + + /** + * Function declaration schema computed from name, description, and parameterSchema + */ + get schema(): FunctionDeclaration { + return { + name: this.name, + description: this.description, + parameters: this.parameterSchema as Schema + }; + } + + /** + * Validates the parameters for the tool + * This is a placeholder implementation and should be overridden + * @param params Parameters to validate + * @returns An error message string if invalid, null otherwise + */ + invalidParams(params: TParams): string | null { + // Implementation would typically use a JSON Schema validator + // This is a placeholder that should be implemented by derived classes + return null; + } + + /** + * Gets a pre-execution description of the tool operation + * Default implementation that should be overridden by derived classes + * @param params Parameters for the tool execution + * @returns A markdown string describing what the tool will do + */ + getDescription(params: TParams): string { + return JSON.stringify(params); + } + + /** + * Determines if the tool should prompt for confirmation before execution + * @param params Parameters for the tool execution + * @returns Whether or not execute should be confirmed by the user. + */ + shouldConfirmExecute(params: TParams): Promise { + return Promise.resolve(false); + } + + /** + * Abstract method to execute the tool with the given parameters + * Must be implemented by derived classes + * @param params Parameters for the tool execution + * @returns Result of the tool execution + */ + abstract execute(params: TParams): Promise; +} + + +export interface ToolResult { + /** + * Content meant to be included in LLM history. + * This should represent the factual outcome of the tool execution. + */ + llmContent: string; + + /** + * Markdown string for user display. + * This provides a user-friendly summary or visualization of the result. + */ + returnDisplay: ToolResultDisplay; +} + +export type ToolResultDisplay = string | FileDiff; + +export interface FileDiff { + fileDiff: string +} diff --git a/packages/cli/src/tools/write-file.tool.ts b/packages/cli/src/tools/write-file.tool.ts index aa2b0d85..78f14440 100644 --- a/packages/cli/src/tools/write-file.tool.ts +++ b/packages/cli/src/tools/write-file.tool.ts @@ -1,6 +1,6 @@ import fs from 'fs'; import path from 'path'; -import { BaseTool, ToolResult } from './tool.js'; +import { BaseTool, ToolResult } from './tools.js'; import { SchemaValidator } from '../utils/schemaValidator.js'; import { makeRelative, shortenPath } from '../utils/paths.js'; import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolEditConfirmationDetails } from '../ui/types.js'; diff --git a/packages/cli/src/ui/components/messages/ToolMessage.tsx b/packages/cli/src/ui/components/messages/ToolMessage.tsx index 4ad947c9..f8db54c4 100644 --- a/packages/cli/src/ui/components/messages/ToolMessage.tsx +++ b/packages/cli/src/ui/components/messages/ToolMessage.tsx @@ -2,7 +2,7 @@ import React from 'react'; import { Box, Text } from 'ink'; import Spinner from 'ink-spinner'; import { ToolCallStatus } from '../../types.js'; -import { ToolResultDisplay } from '../../../tools/tool.js'; +import { ToolResultDisplay } from '../../../tools/tools.js'; import DiffRenderer from './DiffRenderer.js'; import { MarkdownRenderer } from '../../utils/MarkdownRenderer.js'; diff --git a/packages/cli/src/ui/types.ts b/packages/cli/src/ui/types.ts index e7c43c44..f7dcb9d3 100644 --- a/packages/cli/src/ui/types.ts +++ b/packages/cli/src/ui/types.ts @@ -1,4 +1,4 @@ -import { ToolResultDisplay } from '../tools/tool.js'; +import { ToolResultDisplay } from "../tools/tools.js"; export enum ToolCallStatus { Pending, -- cgit v1.2.3