@google/gemini-cli-core 0.0.1

package/dist/src/tools/shell.test.js

@@ -0,0 +1,301 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { vi, describe, it, expect, beforeEach, afterEach, } from 'vitest';
+const mockShellExecutionService = vi.hoisted(() => vi.fn());
+vi.mock('../services/shellExecutionService.js', () => ({
+    ShellExecutionService: { execute: mockShellExecutionService },
+}));
+vi.mock('fs');
+vi.mock('os');
+vi.mock('crypto');
+vi.mock('../utils/summarizer.js');
+import { isCommandAllowed } from '../utils/shell-utils.js';
+import { ShellTool } from './shell.js';
+import {} from '../config/config.js';
+import {} from '../services/shellExecutionService.js';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import { EOL } from 'node:os';
+import * as path from 'node:path';
+import * as crypto from 'node:crypto';
+import * as summarizer from '../utils/summarizer.js';
+import { ToolErrorType } from './tool-error.js';
+import { ToolConfirmationOutcome } from './tools.js';
+import { OUTPUT_UPDATE_INTERVAL_MS } from './shell.js';
+import { createMockWorkspaceContext } from '../test-utils/mockWorkspaceContext.js';
+describe('ShellTool', () => {
+    let shellTool;
+    let mockConfig;
+    let mockShellOutputCallback;
+    let resolveExecutionPromise;
+    beforeEach(() => {
+        vi.clearAllMocks();
+        mockConfig = {
+            getCoreTools: vi.fn().mockReturnValue([]),
+            getExcludeTools: vi.fn().mockReturnValue([]),
+            getDebugMode: vi.fn().mockReturnValue(false),
+            getTargetDir: vi.fn().mockReturnValue('/test/dir'),
+            getSummarizeToolOutputConfig: vi.fn().mockReturnValue(undefined),
+            getWorkspaceContext: vi
+                .fn()
+                .mockReturnValue(createMockWorkspaceContext('/test/dir')),
+            getGeminiClient: vi.fn(),
+            getShouldUseNodePtyShell: vi.fn().mockReturnValue(false),
+        };
+        shellTool = new ShellTool(mockConfig);
+        vi.mocked(os.platform).mockReturnValue('linux');
+        vi.mocked(os.tmpdir).mockReturnValue('/tmp');
+        vi.mocked(crypto.randomBytes).mockReturnValue(Buffer.from('abcdef', 'hex'));
+        // Capture the output callback to simulate streaming events from the service
+        mockShellExecutionService.mockImplementation((_cmd, _cwd, callback) => {
+            mockShellOutputCallback = callback;
+            return {
+                pid: 12345,
+                result: new Promise((resolve) => {
+                    resolveExecutionPromise = resolve;
+                }),
+            };
+        });
+    });
+    describe('isCommandAllowed', () => {
+        it('should allow a command if no restrictions are provided', () => {
+            mockConfig.getCoreTools.mockReturnValue(undefined);
+            mockConfig.getExcludeTools.mockReturnValue(undefined);
+            expect(isCommandAllowed('ls -l', mockConfig).allowed).toBe(true);
+        });
+        it('should block a command with command substitution using $()', () => {
+            expect(isCommandAllowed('echo $(rm -rf /)', mockConfig).allowed).toBe(false);
+        });
+    });
+    describe('build', () => {
+        it('should return an invocation for a valid command', () => {
+            const invocation = shellTool.build({ command: 'ls -l' });
+            expect(invocation).toBeDefined();
+        });
+        it('should throw an error for an empty command', () => {
+            expect(() => shellTool.build({ command: ' ' })).toThrow('Command cannot be empty.');
+        });
+        it('should throw an error for a relative directory path', () => {
+            expect(() => shellTool.build({ command: 'ls', directory: 'rel/path' })).toThrow('Directory must be an absolute path.');
+        });
+        it('should throw an error for a directory outside the workspace', () => {
+            mockConfig.getWorkspaceContext.mockReturnValue(createMockWorkspaceContext('/test/dir', ['/another/workspace']));
+            expect(() => shellTool.build({ command: 'ls', directory: '/not/in/workspace' })).toThrow("Directory '/not/in/workspace' is not within any of the registered workspace directories.");
+        });
+        it('should return an invocation for a valid absolute directory path', () => {
+            mockConfig.getWorkspaceContext.mockReturnValue(createMockWorkspaceContext('/test/dir', ['/another/workspace']));
+            const invocation = shellTool.build({
+                command: 'ls',
+                directory: '/test/dir/subdir',
+            });
+            expect(invocation).toBeDefined();
+        });
+    });
+    describe('execute', () => {
+        const mockAbortSignal = new AbortController().signal;
+        const resolveShellExecution = (result = {}) => {
+            const fullResult = {
+                rawOutput: Buffer.from(result.output || ''),
+                output: 'Success',
+                exitCode: 0,
+                signal: null,
+                error: null,
+                aborted: false,
+                pid: 12345,
+                executionMethod: 'child_process',
+                ...result,
+            };
+            resolveExecutionPromise(fullResult);
+        };
+        it('should wrap command on linux and parse pgrep output', async () => {
+            const invocation = shellTool.build({ command: 'my-command &' });
+            const promise = invocation.execute(mockAbortSignal);
+            resolveShellExecution({ pid: 54321 });
+            vi.mocked(fs.existsSync).mockReturnValue(true);
+            vi.mocked(fs.readFileSync).mockReturnValue(`54321${EOL}54322${EOL}`); // Service PID and background PID
+            const result = await promise;
+            const tmpFile = path.join(os.tmpdir(), 'shell_pgrep_abcdef.tmp');
+            const wrappedCommand = `{ my-command & }; __code=$?; pgrep -g 0 >${tmpFile} 2>&1; exit $__code;`;
+            expect(mockShellExecutionService).toHaveBeenCalledWith(wrappedCommand, '/test/dir', expect.any(Function), mockAbortSignal, false, {});
+            expect(result.llmContent).toContain('Background PIDs: 54322');
+            expect(vi.mocked(fs.unlinkSync)).toHaveBeenCalledWith(tmpFile);
+        });
+        it('should use the provided directory as cwd', async () => {
+            mockConfig.getWorkspaceContext.mockReturnValue(createMockWorkspaceContext('/test/dir'));
+            const invocation = shellTool.build({
+                command: 'ls',
+                directory: '/test/dir/subdir',
+            });
+            const promise = invocation.execute(mockAbortSignal);
+            resolveShellExecution();
+            await promise;
+            const tmpFile = path.join(os.tmpdir(), 'shell_pgrep_abcdef.tmp');
+            const wrappedCommand = `{ ls; }; __code=$?; pgrep -g 0 >${tmpFile} 2>&1; exit $__code;`;
+            expect(mockShellExecutionService).toHaveBeenCalledWith(wrappedCommand, '/test/dir/subdir', expect.any(Function), mockAbortSignal, false, {});
+        });
+        it('should not wrap command on windows', async () => {
+            vi.mocked(os.platform).mockReturnValue('win32');
+            const invocation = shellTool.build({ command: 'dir' });
+            const promise = invocation.execute(mockAbortSignal);
+            resolveShellExecution({
+                rawOutput: Buffer.from(''),
+                output: '',
+                exitCode: 0,
+                signal: null,
+                error: null,
+                aborted: false,
+                pid: 12345,
+                executionMethod: 'child_process',
+            });
+            await promise;
+            expect(mockShellExecutionService).toHaveBeenCalledWith('dir', '/test/dir', expect.any(Function), mockAbortSignal, false, {});
+        });
+        it('should format error messages correctly', async () => {
+            const error = new Error('wrapped command failed');
+            const invocation = shellTool.build({ command: 'user-command' });
+            const promise = invocation.execute(mockAbortSignal);
+            resolveShellExecution({
+                error,
+                exitCode: 1,
+                output: 'err',
+                rawOutput: Buffer.from('err'),
+                signal: null,
+                aborted: false,
+                pid: 12345,
+                executionMethod: 'child_process',
+            });
+            const result = await promise;
+            expect(result.llmContent).toContain('Error: wrapped command failed');
+            expect(result.llmContent).not.toContain('pgrep');
+        });
+        it('should return a SHELL_EXECUTE_ERROR for a command failure', async () => {
+            const error = new Error('command failed');
+            const invocation = shellTool.build({ command: 'user-command' });
+            const promise = invocation.execute(mockAbortSignal);
+            resolveShellExecution({
+                error,
+                exitCode: 1,
+            });
+            const result = await promise;
+            expect(result.error).toBeDefined();
+            expect(result.error?.type).toBe(ToolErrorType.SHELL_EXECUTE_ERROR);
+            expect(result.error?.message).toBe('command failed');
+        });
+        it('should throw an error for invalid parameters', () => {
+            expect(() => shellTool.build({ command: '' })).toThrow('Command cannot be empty.');
+        });
+        it('should throw an error for invalid directory', () => {
+            expect(() => shellTool.build({ command: 'ls', directory: 'nonexistent' })).toThrow('Directory must be an absolute path.');
+        });
+        it('should summarize output when configured', async () => {
+            mockConfig.getSummarizeToolOutputConfig.mockReturnValue({
+                [shellTool.name]: { tokenBudget: 1000 },
+            });
+            vi.mocked(summarizer.summarizeToolOutput).mockResolvedValue('summarized output');
+            const invocation = shellTool.build({ command: 'ls' });
+            const promise = invocation.execute(mockAbortSignal);
+            resolveExecutionPromise({
+                output: 'long output',
+                rawOutput: Buffer.from('long output'),
+                exitCode: 0,
+                signal: null,
+                error: null,
+                aborted: false,
+                pid: 12345,
+                executionMethod: 'child_process',
+            });
+            const result = await promise;
+            expect(summarizer.summarizeToolOutput).toHaveBeenCalledWith(expect.any(String), mockConfig.getGeminiClient(), mockAbortSignal, 1000);
+            expect(result.llmContent).toBe('summarized output');
+            expect(result.returnDisplay).toBe('long output');
+        });
+        it('should clean up the temp file on synchronous execution error', async () => {
+            const error = new Error('sync spawn error');
+            mockShellExecutionService.mockImplementation(() => {
+                throw error;
+            });
+            vi.mocked(fs.existsSync).mockReturnValue(true); // Pretend the file exists
+            const invocation = shellTool.build({ command: 'a-command' });
+            await expect(invocation.execute(mockAbortSignal)).rejects.toThrow(error);
+            const tmpFile = path.join(os.tmpdir(), 'shell_pgrep_abcdef.tmp');
+            expect(vi.mocked(fs.unlinkSync)).toHaveBeenCalledWith(tmpFile);
+        });
+        describe('Streaming to `updateOutput`', () => {
+            let updateOutputMock;
+            beforeEach(() => {
+                vi.useFakeTimers({ toFake: ['Date'] });
+                updateOutputMock = vi.fn();
+            });
+            afterEach(() => {
+                vi.useRealTimers();
+            });
+            it('should immediately show binary detection message and throttle progress', async () => {
+                const invocation = shellTool.build({ command: 'cat img' });
+                const promise = invocation.execute(mockAbortSignal, updateOutputMock);
+                mockShellOutputCallback({ type: 'binary_detected' });
+                expect(updateOutputMock).toHaveBeenCalledOnce();
+                expect(updateOutputMock).toHaveBeenCalledWith('[Binary output detected. Halting stream...]');
+                mockShellOutputCallback({
+                    type: 'binary_progress',
+                    bytesReceived: 1024,
+                });
+                expect(updateOutputMock).toHaveBeenCalledOnce();
+                // Advance time past the throttle interval.
+                await vi.advanceTimersByTimeAsync(OUTPUT_UPDATE_INTERVAL_MS + 1);
+                // Send a SECOND progress event. This one will trigger the flush.
+                mockShellOutputCallback({
+                    type: 'binary_progress',
+                    bytesReceived: 2048,
+                });
+                // Now it should be called a second time with the latest progress.
+                expect(updateOutputMock).toHaveBeenCalledTimes(2);
+                expect(updateOutputMock).toHaveBeenLastCalledWith('[Receiving binary output... 2.0 KB received]');
+                resolveExecutionPromise({
+                    rawOutput: Buffer.from(''),
+                    output: '',
+                    exitCode: 0,
+                    signal: null,
+                    error: null,
+                    aborted: false,
+                    pid: 12345,
+                    executionMethod: 'child_process',
+                });
+                await promise;
+            });
+        });
+    });
+    describe('shouldConfirmExecute', () => {
+        it('should request confirmation for a new command and allowlist it on "Always"', async () => {
+            const params = { command: 'npm install' };
+            const invocation = shellTool.build(params);
+            const confirmation = await invocation.shouldConfirmExecute(new AbortController().signal);
+            expect(confirmation).not.toBe(false);
+            expect(confirmation && confirmation.type).toBe('exec');
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            await confirmation.onConfirm(ToolConfirmationOutcome.ProceedAlways);
+            // Should now be allowlisted
+            const secondInvocation = shellTool.build({ command: 'npm test' });
+            const secondConfirmation = await secondInvocation.shouldConfirmExecute(new AbortController().signal);
+            expect(secondConfirmation).toBe(false);
+        });
+        it('should throw an error if validation fails', () => {
+            expect(() => shellTool.build({ command: '' })).toThrow();
+        });
+    });
+    describe('getDescription', () => {
+        it('should return the windows description when on windows', () => {
+            vi.mocked(os.platform).mockReturnValue('win32');
+            const shellTool = new ShellTool(mockConfig);
+            expect(shellTool.description).toMatchSnapshot();
+        });
+        it('should return the non-windows description when not on windows', () => {
+            vi.mocked(os.platform).mockReturnValue('linux');
+            const shellTool = new ShellTool(mockConfig);
+            expect(shellTool.description).toMatchSnapshot();
+        });
+    });
+});
+//# sourceMappingURL=shell.test.js.map

package/dist/src/tools/shell.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shell.test.js","sourceRoot":"","sources":["../../../src/tools/shell.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,EAAE,EACF,QAAQ,EACR,EAAE,EACF,MAAM,EACN,UAAU,EACV,SAAS,GAEV,MAAM,QAAQ,CAAC;AAEhB,MAAM,yBAAyB,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAC5D,EAAE,CAAC,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC;IACrD,qBAAqB,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;CAC9D,CAAC,CAAC,CAAC;AACJ,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACd,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACd,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAClB,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;AAElC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAe,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAGN,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AAEnF,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAI,SAAoB,CAAC;IACzB,IAAI,UAAkB,CAAC;IACvB,IAAI,uBAA0D,CAAC;IAC/D,IAAI,uBAA+D,CAAC;IAEpE,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,aAAa,EAAE,CAAC;QAEnB,UAAU,GAAG;YACX,YAAY,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC;YACzC,eAAe,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC;YAC5C,YAAY,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC;YAC5C,YAAY,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,WAAW,CAAC;YAClD,4BAA4B,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC;YAChE,mBAAmB,EAAE,EAAE;iBACpB,EAAE,EAAE;iBACJ,eAAe,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;YAC3D,eAAe,EAAE,EAAE,CAAC,EAAE,EAAE;YACxB,wBAAwB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC;SACpC,CAAC;QAEvB,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAEtC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAChD,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC5C,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAU,CAAC,eAAe,CACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAC7B,CAAC;QAEF,4EAA4E;QAC5E,yBAAyB,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YACpE,uBAAuB,GAAG,QAAQ,CAAC;YACnC,OAAO;gBACL,GAAG,EAAE,KAAK;gBACV,MAAM,EAAE,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC9B,uBAAuB,GAAG,OAAO,CAAC;gBACpC,CAAC,CAAC;aACH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAC/D,UAAU,CAAC,YAAqB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC5D,UAAU,CAAC,eAAwB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAChE,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CACnE,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;QACrB,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YACzD,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,CACrD,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,CAAC,GAAG,EAAE,CACV,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAC1D,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACpE,UAAU,CAAC,mBAA4B,CAAC,eAAe,CACtD,0BAA0B,CAAC,WAAW,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAChE,CAAC;YACF,MAAM,CAAC,GAAG,EAAE,CACV,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,mBAAmB,EAAE,CAAC,CACnE,CAAC,OAAO,CACP,0FAA0F,CAC3F,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACxE,UAAU,CAAC,mBAA4B,CAAC,eAAe,CACtD,0BAA0B,CAAC,WAAW,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAChE,CAAC;YACF,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC;gBACjC,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,kBAAkB;aAC9B,CAAC,CAAC;YACH,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;QAErD,MAAM,qBAAqB,GAAG,CAC5B,SAAwC,EAAE,EAC1C,EAAE;YACF,MAAM,UAAU,GAAyB;gBACvC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;gBAC3C,MAAM,EAAE,SAAS;gBACjB,QAAQ,EAAE,CAAC;gBACX,MAAM,EAAE,IAAI;gBACZ,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,KAAK;gBACd,GAAG,EAAE,KAAK;gBACV,eAAe,EAAE,eAAe;gBAChC,GAAG,MAAM;aACV,CAAC;YACF,uBAAuB,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC;QAEF,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACpD,qBAAqB,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YAEtC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAC/C,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,QAAQ,GAAG,QAAQ,GAAG,EAAE,CAAC,CAAC,CAAC,iCAAiC;YAEvG,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;YAE7B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC,CAAC;YACjE,MAAM,cAAc,GAAG,4CAA4C,OAAO,sBAAsB,CAAC;YACjG,MAAM,CAAC,yBAAyB,CAAC,CAAC,oBAAoB,CACpD,cAAc,EACd,WAAW,EACX,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EACpB,eAAe,EACf,KAAK,EACL,EAAE,CACH,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;YAC9D,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;YACvD,UAAU,CAAC,mBAA4B,CAAC,eAAe,CACtD,0BAA0B,CAAC,WAAW,CAAC,CACxC,CAAC;YACF,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC;gBACjC,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,kBAAkB;aAC9B,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACpD,qBAAqB,EAAE,CAAC;YACxB,MAAM,OAAO,CAAC;YAEd,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC,CAAC;YACjE,MAAM,cAAc,GAAG,mCAAmC,OAAO,sBAAsB,CAAC;YACxF,MAAM,CAAC,yBAAyB,CAAC,CAAC,oBAAoB,CACpD,cAAc,EACd,kBAAkB,EAClB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EACpB,eAAe,EACf,KAAK,EACL,EAAE,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAChD,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACpD,qBAAqB,CAAC;gBACpB,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,CAAC;gBACX,MAAM,EAAE,IAAI;gBACZ,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,KAAK;gBACd,GAAG,EAAE,KAAK;gBACV,eAAe,EAAE,eAAe;aACjC,CAAC,CAAC;YACH,MAAM,OAAO,CAAC;YACd,MAAM,CAAC,yBAAyB,CAAC,CAAC,oBAAoB,CACpD,KAAK,EACL,WAAW,EACX,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EACpB,eAAe,EACf,KAAK,EACL,EAAE,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAClD,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACpD,qBAAqB,CAAC;gBACpB,KAAK;gBACL,QAAQ,EAAE,CAAC;gBACX,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC7B,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,KAAK;gBACd,GAAG,EAAE,KAAK;gBACV,eAAe,EAAE,eAAe;aACjC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;YACrE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;YACzE,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAC1C,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACpD,qBAAqB,CAAC;gBACpB,KAAK;gBACL,QAAQ,EAAE,CAAC;aACZ,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;YAE7B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;YACnE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CACpD,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,CAAC,GAAG,EAAE,CACV,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAC7D,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACtD,UAAU,CAAC,4BAAqC,CAAC,eAAe,CAAC;gBAChE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;aACxC,CAAC,CAAC;YACH,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,iBAAiB,CACzD,mBAAmB,CACpB,CAAC;YAEF,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACtD,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACpD,uBAAuB,CAAC;gBACtB,MAAM,EAAE,aAAa;gBACrB,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;gBACrC,QAAQ,EAAE,CAAC;gBACX,MAAM,EAAE,IAAI;gBACZ,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,KAAK;gBACd,GAAG,EAAE,KAAK;gBACV,eAAe,EAAE,eAAe;aACjC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;YAE7B,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CACzD,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAClB,UAAU,CAAC,eAAe,EAAE,EAC5B,eAAe,EACf,IAAI,CACL,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACpD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;YAC5E,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAC5C,yBAAyB,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBAChD,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B;YAE1E,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;YAC7D,MAAM,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAEzE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC,CAAC;YACjE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;YAC3C,IAAI,gBAAsB,CAAC;YAC3B,UAAU,CAAC,GAAG,EAAE;gBACd,EAAE,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACvC,gBAAgB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,GAAG,EAAE;gBACb,EAAE,CAAC,aAAa,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,wEAAwE,EAAE,KAAK,IAAI,EAAE;gBACtF,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC3D,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;gBAEtE,uBAAuB,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;gBACrD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,EAAE,CAAC;gBAChD,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAC3C,6CAA6C,CAC9C,CAAC;gBAEF,uBAAuB,CAAC;oBACtB,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,IAAI;iBACpB,CAAC,CAAC;gBACH,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,EAAE,CAAC;gBAEhD,2CAA2C;gBAC3C,MAAM,EAAE,CAAC,wBAAwB,CAAC,yBAAyB,GAAG,CAAC,CAAC,CAAC;gBAEjE,iEAAiE;gBACjE,uBAAuB,CAAC;oBACtB,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,IAAI;iBACpB,CAAC,CAAC;gBAEH,kEAAkE;gBAClE,MAAM,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;gBAClD,MAAM,CAAC,gBAAgB,CAAC,CAAC,wBAAwB,CAC/C,8CAA8C,CAC/C,CAAC;gBAEF,uBAAuB,CAAC;oBACtB,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC1B,MAAM,EAAE,EAAE;oBACV,QAAQ,EAAE,CAAC;oBACX,MAAM,EAAE,IAAI;oBACZ,KAAK,EAAE,IAAI;oBACX,OAAO,EAAE,KAAK;oBACd,GAAG,EAAE,KAAK;oBACV,eAAe,EAAE,eAAe;iBACjC,CAAC,CAAC;gBACH,MAAM,OAAO,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;YAC1F,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC3C,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,oBAAoB,CACxD,IAAI,eAAe,EAAE,CAAC,MAAM,CAC7B,CAAC;YAEF,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrC,MAAM,CAAC,YAAY,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,8DAA8D;YAC9D,MAAO,YAAoB,CAAC,SAAS,CACnC,uBAAuB,CAAC,aAAa,CACtC,CAAC;YAEF,4BAA4B;YAC5B,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;YAClE,MAAM,kBAAkB,GAAG,MAAM,gBAAgB,CAAC,oBAAoB,CACpE,IAAI,eAAe,EAAE,CAAC,MAAM,CAC7B,CAAC;YACF,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAChD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,eAAe,EAAE,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;YACvE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAChD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,eAAe,EAAE,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/tools/smart-edit.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BaseDeclarativeTool, type ToolInvocation, type ToolResult } from './tools.js';
+import { ToolErrorType } from './tool-error.js';
+import { type Config } from '../config/config.js';
+import { type ModifiableDeclarativeTool, type ModifyContext } from './modifiable-tool.js';
+interface ReplacementContext {
+    params: EditToolParams;
+    currentContent: string;
+    abortSignal: AbortSignal;
+}
+interface ReplacementResult {
+    newContent: string;
+    occurrences: number;
+    finalOldString: string;
+    finalNewString: string;
+}
+export declare function calculateReplacement(context: ReplacementContext): Promise<ReplacementResult>;
+export declare function getErrorReplaceResult(params: EditToolParams, occurrences: number, expectedReplacements: number, finalOldString: string, finalNewString: string): {
+    display: string;
+    raw: string;
+    type: ToolErrorType;
+} | undefined;
+/**
+ * Parameters for the Edit tool
+ */
+export interface EditToolParams {
+    /**
+     * The absolute path to the file to modify
+     */
+    file_path: string;
+    /**
+     * The text to replace
+     */
+    old_string: string;
+    /**
+     * The text to replace it with
+     */
+    new_string: string;
+    /**
+     * The instruction for what needs to be done.
+     */
+    instruction: string;
+    /**
+     * Whether the edit was modified manually by the user.
+     */
+    modified_by_user?: boolean;
+    /**
+     * Initially proposed string.
+     */
+    ai_proposed_string?: string;
+}
+/**
+ * Implementation of the Edit tool logic
+ */
+export declare class SmartEditTool extends BaseDeclarativeTool<EditToolParams, ToolResult> implements ModifiableDeclarativeTool<EditToolParams> {
+    private readonly config;
+    static readonly Name = "replace";
+    constructor(config: Config);
+    /**
+     * Validates the parameters for the Edit tool
+     * @param params Parameters to validate
+     * @returns Error message string or null if valid
+     */
+    protected validateToolParamValues(params: EditToolParams): string | null;
+    protected createInvocation(params: EditToolParams): ToolInvocation<EditToolParams, ToolResult>;
+    getModifyContext(_: AbortSignal): ModifyContext<EditToolParams>;
+}
+export {};