@blackbox_ai/blackbox-cli-core 0.0.4

package/dist/src/tools/modifiable-tool.test.js

@@ -0,0 +1,193 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { modifyWithEditor, isModifiableDeclarativeTool, } from './modifiable-tool.js';
+import fs from 'node:fs';
+import fsp from 'node:fs/promises';
+import os from 'node:os';
+import * as path from 'node:path';
+// Mock dependencies
+const mockOpenDiff = vi.hoisted(() => vi.fn());
+const mockCreatePatch = vi.hoisted(() => vi.fn());
+vi.mock('../utils/editor.js', () => ({
+    openDiff: mockOpenDiff,
+}));
+vi.mock('diff', () => ({
+    createPatch: mockCreatePatch,
+}));
+describe('modifyWithEditor', () => {
+    let testProjectDir;
+    let mockModifyContext;
+    let mockParams;
+    let currentContent;
+    let proposedContent;
+    let modifiedContent;
+    let abortSignal;
+    beforeEach(async () => {
+        vi.resetAllMocks();
+        testProjectDir = await fsp.mkdtemp(path.join(os.tmpdir(), 'modifiable-tool-test-'));
+        abortSignal = new AbortController().signal;
+        currentContent = 'original content\nline 2\nline 3';
+        proposedContent = 'modified content\nline 2\nline 3';
+        modifiedContent = 'user modified content\nline 2\nline 3\nnew line';
+        mockParams = {
+            filePath: path.join(testProjectDir, 'test.txt'),
+            someOtherParam: 'value',
+        };
+        mockModifyContext = {
+            getFilePath: vi.fn().mockReturnValue(mockParams.filePath),
+            getCurrentContent: vi.fn().mockResolvedValue(currentContent),
+            getProposedContent: vi.fn().mockResolvedValue(proposedContent),
+            createUpdatedParams: vi
+                .fn()
+                .mockImplementation((oldContent, modifiedContent, originalParams) => ({
+                ...originalParams,
+                modifiedContent,
+                oldContent,
+            })),
+        };
+        mockOpenDiff.mockImplementation(async (_oldPath, newPath) => {
+            await fsp.writeFile(newPath, modifiedContent, 'utf8');
+        });
+        mockCreatePatch.mockReturnValue('mock diff content');
+    });
+    afterEach(async () => {
+        vi.restoreAllMocks();
+        await fsp.rm(testProjectDir, { recursive: true, force: true });
+        const diffDir = path.join(os.tmpdir(), 'blackbox-cli-tool-modify-diffs');
+        await fsp.rm(diffDir, { recursive: true, force: true });
+    });
+    describe('successful modification', () => {
+        it('should successfully modify content with VSCode editor', async () => {
+            const result = await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+            expect(mockModifyContext.getCurrentContent).toHaveBeenCalledWith(mockParams);
+            expect(mockModifyContext.getProposedContent).toHaveBeenCalledWith(mockParams);
+            expect(mockModifyContext.getFilePath).toHaveBeenCalledWith(mockParams);
+            expect(mockOpenDiff).toHaveBeenCalledOnce();
+            const [oldFilePath, newFilePath] = mockOpenDiff.mock.calls[0];
+            expect(mockModifyContext.createUpdatedParams).toHaveBeenCalledWith(currentContent, modifiedContent, mockParams);
+            expect(mockCreatePatch).toHaveBeenCalledWith(path.basename(mockParams.filePath), currentContent, modifiedContent, 'Current', 'Proposed', expect.objectContaining({
+                context: 3,
+                ignoreWhitespace: true,
+            }));
+            // Check that temp files are deleted.
+            await expect(fsp.access(oldFilePath)).rejects.toThrow();
+            await expect(fsp.access(newFilePath)).rejects.toThrow();
+            expect(result).toEqual({
+                updatedParams: {
+                    ...mockParams,
+                    modifiedContent,
+                    oldContent: currentContent,
+                },
+                updatedDiff: 'mock diff content',
+            });
+        });
+        it('should create temp directory if it does not exist', async () => {
+            const diffDir = path.join(os.tmpdir(), 'blackbox-cli-tool-modify-diffs');
+            await fsp.rm(diffDir, { recursive: true, force: true }).catch(() => { });
+            await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+            const stats = await fsp.stat(diffDir);
+            expect(stats.isDirectory()).toBe(true);
+        });
+        it('should not create temp directory if it already exists', async () => {
+            const diffDir = path.join(os.tmpdir(), 'blackbox-cli-tool-modify-diffs');
+            await fsp.mkdir(diffDir, { recursive: true });
+            const mkdirSpy = vi.spyOn(fs, 'mkdirSync');
+            await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+            expect(mkdirSpy).not.toHaveBeenCalled();
+            mkdirSpy.mockRestore();
+        });
+    });
+    it('should handle missing old temp file gracefully', async () => {
+        mockOpenDiff.mockImplementation(async (oldPath, newPath) => {
+            await fsp.writeFile(newPath, modifiedContent, 'utf8');
+            await fsp.unlink(oldPath);
+        });
+        const result = await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+        expect(mockCreatePatch).toHaveBeenCalledWith(path.basename(mockParams.filePath), '', modifiedContent, 'Current', 'Proposed', expect.objectContaining({
+            context: 3,
+            ignoreWhitespace: true,
+        }));
+        expect(result.updatedParams).toBeDefined();
+        expect(result.updatedDiff).toBe('mock diff content');
+    });
+    it('should handle missing new temp file gracefully', async () => {
+        mockOpenDiff.mockImplementation(async (_oldPath, newPath) => {
+            await fsp.unlink(newPath);
+        });
+        const result = await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+        expect(mockCreatePatch).toHaveBeenCalledWith(path.basename(mockParams.filePath), currentContent, '', 'Current', 'Proposed', expect.objectContaining({
+            context: 3,
+            ignoreWhitespace: true,
+        }));
+        expect(result.updatedParams).toBeDefined();
+        expect(result.updatedDiff).toBe('mock diff content');
+    });
+    it('should clean up temp files even if editor fails', async () => {
+        const editorError = new Error('Editor failed to open');
+        mockOpenDiff.mockRejectedValue(editorError);
+        const writeSpy = vi.spyOn(fs, 'writeFileSync');
+        await expect(modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn())).rejects.toThrow('Editor failed to open');
+        expect(writeSpy).toHaveBeenCalledTimes(2);
+        const oldFilePath = writeSpy.mock.calls[0][0];
+        const newFilePath = writeSpy.mock.calls[1][0];
+        await expect(fsp.access(oldFilePath)).rejects.toThrow();
+        await expect(fsp.access(newFilePath)).rejects.toThrow();
+        writeSpy.mockRestore();
+    });
+    it('should handle temp file cleanup errors gracefully', async () => {
+        const consoleErrorSpy = vi
+            .spyOn(console, 'error')
+            .mockImplementation(() => { });
+        vi.spyOn(fs, 'unlinkSync').mockImplementation(() => {
+            throw new Error('Failed to delete file');
+        });
+        await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+        expect(consoleErrorSpy).toHaveBeenCalledTimes(2);
+        expect(consoleErrorSpy).toHaveBeenCalledWith(expect.stringContaining('Error deleting temp diff file:'));
+        consoleErrorSpy.mockRestore();
+    });
+    it('should create temp files with correct naming with extension', async () => {
+        const testFilePath = path.join(testProjectDir, 'subfolder', 'test-file.txt');
+        mockModifyContext.getFilePath = vi.fn().mockReturnValue(testFilePath);
+        await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+        expect(mockOpenDiff).toHaveBeenCalledOnce();
+        const [oldFilePath, newFilePath] = mockOpenDiff.mock.calls[0];
+        expect(oldFilePath).toMatch(/blackbox-cli-modify-test-file-old-\d+\.txt$/);
+        expect(newFilePath).toMatch(/blackbox-cli-modify-test-file-new-\d+\.txt$/);
+        const diffDir = path.join(os.tmpdir(), 'blackbox-cli-tool-modify-diffs');
+        expect(path.dirname(oldFilePath)).toBe(diffDir);
+        expect(path.dirname(newFilePath)).toBe(diffDir);
+    });
+    it('should create temp files with correct naming without extension', async () => {
+        const testFilePath = path.join(testProjectDir, 'subfolder', 'test-file');
+        mockModifyContext.getFilePath = vi.fn().mockReturnValue(testFilePath);
+        await modifyWithEditor(mockParams, mockModifyContext, 'vscode', abortSignal, vi.fn());
+        expect(mockOpenDiff).toHaveBeenCalledOnce();
+        const [oldFilePath, newFilePath] = mockOpenDiff.mock.calls[0];
+        expect(oldFilePath).toMatch(/blackbox-cli-modify-test-file-old-\d+$/);
+        expect(newFilePath).toMatch(/blackbox-cli-modify-test-file-new-\d+$/);
+        const diffDir = path.join(os.tmpdir(), 'blackbox-cli-tool-modify-diffs');
+        expect(path.dirname(oldFilePath)).toBe(diffDir);
+        expect(path.dirname(newFilePath)).toBe(diffDir);
+    });
+});
+describe('isModifiableTool', () => {
+    it('should return true for objects with getModifyContext method', () => {
+        const mockTool = {
+            name: 'test-tool',
+            getModifyContext: vi.fn(),
+        };
+        expect(isModifiableDeclarativeTool(mockTool)).toBe(true);
+    });
+    it('should return false for objects without getModifyContext method', () => {
+        const mockTool = {
+            name: 'test-tool',
+        };
+        expect(isModifiableDeclarativeTool(mockTool)).toBe(false);
+    });
+});
+//# sourceMappingURL=modifiable-tool.test.js.map

package/dist/src/tools/modifiable-tool.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modifiable-tool.test.js","sourceRoot":"","sources":["../../../src/tools/modifiable-tool.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAKzE,OAAO,EACL,gBAAgB,EAChB,2BAA2B,GAC5B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,oBAAoB;AACpB,MAAM,YAAY,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAC/C,MAAM,eAAe,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAElD,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,CAAC;IACnC,QAAQ,EAAE,YAAY;CACvB,CAAC,CAAC,CAAC;AAEJ,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IACrB,WAAW,EAAE,eAAe;CAC7B,CAAC,CAAC,CAAC;AAQJ,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,cAAsB,CAAC;IAC3B,IAAI,iBAA4C,CAAC;IACjD,IAAI,UAAsB,CAAC;IAC3B,IAAI,cAAsB,CAAC;IAC3B,IAAI,eAAuB,CAAC;IAC5B,IAAI,eAAuB,CAAC;IAC5B,IAAI,WAAwB,CAAC;IAE7B,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,EAAE,CAAC,aAAa,EAAE,CAAC;QAEnB,cAAc,GAAG,MAAM,GAAG,CAAC,OAAO,CAChC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,uBAAuB,CAAC,CAChD,CAAC;QACF,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;QAE3C,cAAc,GAAG,kCAAkC,CAAC;QACpD,eAAe,GAAG,kCAAkC,CAAC;QACrD,eAAe,GAAG,iDAAiD,CAAC;QACpE,UAAU,GAAG;YACX,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC;YAC/C,cAAc,EAAE,OAAO;SACxB,CAAC;QAEF,iBAAiB,GAAG;YAClB,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzD,iBAAiB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,cAAc,CAAC;YAC5D,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC;YAC9D,mBAAmB,EAAE,EAAE;iBACpB,EAAE,EAAE;iBACJ,kBAAkB,CAAC,CAAC,UAAU,EAAE,eAAe,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC;gBACpE,GAAG,cAAc;gBACjB,eAAe;gBACf,UAAU;aACX,CAAC,CAAC;SACN,CAAC;QAEF,YAAY,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE;YAC1D,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,eAAe,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,EAAE,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,GAAG,CAAC,EAAE,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC,CAAC;QACzE,MAAM,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;YACrE,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;YAEF,MAAM,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,oBAAoB,CAC9D,UAAU,CACX,CAAC;YACF,MAAM,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAC/D,UAAU,CACX,CAAC;YACF,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAEvE,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,EAAE,CAAC;YAC5C,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE9D,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAChE,cAAc,EACd,eAAe,EACf,UAAU,CACX,CAAC;YAEF,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAClC,cAAc,EACd,eAAe,EACf,SAAS,EACT,UAAU,EACV,MAAM,CAAC,gBAAgB,CAAC;gBACtB,OAAO,EAAE,CAAC;gBACV,gBAAgB,EAAE,IAAI;aACvB,CAAC,CACH,CAAC;YAEF,qCAAqC;YACrC,MAAM,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAExD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,aAAa,EAAE;oBACb,GAAG,UAAU;oBACb,eAAe;oBACf,UAAU,EAAE,cAAc;iBAC3B;gBACD,WAAW,EAAE,mBAAmB;aACjC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACjE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC,CAAC;YACzE,MAAM,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAExE,MAAM,gBAAgB,CACpB,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;YAEF,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;YACrE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC,CAAC;YACzE,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAE9C,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;YAE3C,MAAM,gBAAgB,CACpB,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;YAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACxC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,YAAY,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;YACzD,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;YACtD,MAAM,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAClC,EAAE,EACF,eAAe,EACf,SAAS,EACT,UAAU,EACV,MAAM,CAAC,gBAAgB,CAAC;YACtB,OAAO,EAAE,CAAC;YACV,gBAAgB,EAAE,IAAI;SACvB,CAAC,CACH,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,YAAY,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE;YAC1D,MAAM,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAClC,cAAc,EACd,EAAE,EACF,SAAS,EACT,UAAU,EACV,MAAM,CAAC,gBAAgB,CAAC;YACtB,OAAO,EAAE,CAAC;YACV,gBAAgB,EAAE,IAAI;SACvB,CAAC,CACH,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACvD,YAAY,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAE5C,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC;QAE/C,MAAM,MAAM,CACV,gBAAgB,CACd,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CACF,CAAC,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;QAE3C,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QAExD,MAAM,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACxD,MAAM,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAExD,QAAQ,CAAC,WAAW,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,eAAe,GAAG,EAAE;aACvB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC;aACvB,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAChC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,MAAM,gBAAgB,CACpB,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACjD,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,CAC1D,CAAC;QAEF,eAAe,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC5B,cAAc,EACd,WAAW,EACX,eAAe,CAChB,CAAC;QACF,iBAAiB,CAAC,WAAW,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtE,MAAM,gBAAgB,CACpB,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;QAEF,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,EAAE,CAAC;QAC5C,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,6CAA6C,CAAC,CAAC;QAC3E,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,6CAA6C,CAAC,CAAC;QAE3E,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QACzE,iBAAiB,CAAC,WAAW,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtE,MAAM,gBAAgB,CACpB,UAAU,EACV,iBAAiB,EACjB,QAAsB,EACtB,WAAW,EACX,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;QAEF,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,EAAE,CAAC;QAC5C,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,wCAAwC,CAAC,CAAC;QACtE,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,wCAAwC,CAAC,CAAC;QAEtE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,WAAW;YACjB,gBAAgB,EAAE,EAAE,CAAC,EAAE,EAAE;SAC0B,CAAC;QAEtD,MAAM,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,WAAW;SACkC,CAAC;QAEtD,MAAM,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/tools/read-file.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ToolInvocation, ToolResult } from './tools.js';
+import { BaseDeclarativeTool } from './tools.js';
+import type { Config } from '../config/config.js';
+/**
+ * Parameters for the ReadFile tool
+ */
+export interface ReadFileToolParams {
+    /**
+     * The absolute path to the file to read
+     */
+    absolute_path: string;
+    /**
+     * The line number to start reading from (optional)
+     */
+    offset?: number;
+    /**
+     * The number of lines to read (optional)
+     */
+    limit?: number;
+}
+/**
+ * Implementation of the ReadFile tool logic
+ */
+export declare class ReadFileTool extends BaseDeclarativeTool<ReadFileToolParams, ToolResult> {
+    private config;
+    static readonly Name: string;
+    constructor(config: Config);
+    protected validateToolParamValues(params: ReadFileToolParams): string | null;
+    protected createInvocation(params: ReadFileToolParams): ToolInvocation<ReadFileToolParams, ToolResult>;
+}

package/dist/src/tools/read-file.js

@@ -0,0 +1,128 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import path from 'node:path';
+import { makeRelative, shortenPath } from '../utils/paths.js';
+import { BaseDeclarativeTool, BaseToolInvocation, Kind } from './tools.js';
+import { ToolNames } from './tool-names.js';
+import { processSingleFileContent, getSpecificMimeType, } from '../utils/fileUtils.js';
+import { FileOperation } from '../telemetry/metrics.js';
+import { getProgrammingLanguage } from '../telemetry/telemetry-utils.js';
+import { logFileOperation } from '../telemetry/loggers.js';
+import { FileOperationEvent } from '../telemetry/types.js';
+class ReadFileToolInvocation extends BaseToolInvocation {
+    config;
+    constructor(config, params) {
+        super(params);
+        this.config = config;
+    }
+    getDescription() {
+        const relativePath = makeRelative(this.params.absolute_path, this.config.getTargetDir());
+        return shortenPath(relativePath);
+    }
+    toolLocations() {
+        return [{ path: this.params.absolute_path, line: this.params.offset }];
+    }
+    async execute() {
+        const result = await processSingleFileContent(this.params.absolute_path, this.config.getTargetDir(), this.config.getFileSystemService(), this.params.offset, this.params.limit);
+        if (result.error) {
+            return {
+                llmContent: result.llmContent,
+                returnDisplay: result.returnDisplay || 'Error reading file',
+                error: {
+                    message: result.error,
+                    type: result.errorType,
+                },
+            };
+        }
+        let llmContent;
+        if (result.isTruncated) {
+            const [start, end] = result.linesShown;
+            const total = result.originalLineCount;
+            const nextOffset = this.params.offset
+                ? this.params.offset + end - start + 1
+                : end;
+            llmContent = `
+IMPORTANT: The file content has been truncated.
+Status: Showing lines ${start}-${end} of ${total} total lines.
+Action: To read more of the file, you can use the 'offset' and 'limit' parameters in a subsequent 'read_file' call. For example, to read the next section of the file, use offset: ${nextOffset}.
+
+--- FILE CONTENT (truncated) ---
+${result.llmContent}`;
+        }
+        else {
+            llmContent = result.llmContent || '';
+        }
+        const lines = typeof result.llmContent === 'string'
+            ? result.llmContent.split('\n').length
+            : undefined;
+        const mimetype = getSpecificMimeType(this.params.absolute_path);
+        const programming_language = getProgrammingLanguage({
+            absolute_path: this.params.absolute_path,
+        });
+        logFileOperation(this.config, new FileOperationEvent(ReadFileTool.Name, FileOperation.READ, lines, mimetype, path.extname(this.params.absolute_path), undefined, programming_language));
+        return {
+            llmContent,
+            returnDisplay: result.returnDisplay || '',
+        };
+    }
+}
+/**
+ * Implementation of the ReadFile tool logic
+ */
+export class ReadFileTool extends BaseDeclarativeTool {
+    config;
+    static Name = ToolNames.READ_FILE;
+    constructor(config) {
+        super(ReadFileTool.Name, 'ReadFile', `Reads and returns the content of a specified file. If the file is large, the content will be truncated. The tool's response will clearly indicate if truncation has occurred and will provide details on how to read more of the file using the 'offset' and 'limit' parameters. Handles text, images (PNG, JPG, GIF, WEBP, SVG, BMP), and PDF files. For text files, it can read specific line ranges.`, Kind.Read, {
+            properties: {
+                absolute_path: {
+                    description: "The absolute path to the file to read (e.g., '/home/user/project/file.txt'). Relative paths are not supported. You must provide an absolute path.",
+                    type: 'string',
+                },
+                offset: {
+                    description: "Optional: For text files, the 0-based line number to start reading from. Requires 'limit' to be set. Use for paginating through large files.",
+                    type: 'number',
+                },
+                limit: {
+                    description: "Optional: For text files, maximum number of lines to read. Use with 'offset' to paginate through large files. If omitted, reads the entire file (if feasible, up to a default limit).",
+                    type: 'number',
+                },
+            },
+            required: ['absolute_path'],
+            type: 'object',
+        });
+        this.config = config;
+    }
+    validateToolParamValues(params) {
+        const filePath = params.absolute_path;
+        if (params.absolute_path.trim() === '') {
+            return "The 'absolute_path' parameter must be non-empty.";
+        }
+        if (!path.isAbsolute(filePath)) {
+            return `File path must be absolute, but was relative: ${filePath}. You must provide an absolute path.`;
+        }
+        const workspaceContext = this.config.getWorkspaceContext();
+        if (!workspaceContext.isPathWithinWorkspace(filePath)) {
+            const directories = workspaceContext.getDirectories();
+            return `File path must be within one of the workspace directories: ${directories.join(', ')}`;
+        }
+        if (params.offset !== undefined && params.offset < 0) {
+            return 'Offset must be a non-negative number';
+        }
+        if (params.limit !== undefined && params.limit <= 0) {
+            return 'Limit must be a positive number';
+        }
+        const fileService = this.config.getFileService();
+        if (fileService.shouldGeminiIgnoreFile(params.absolute_path)) {
+            return `File path '${filePath}' is ignored by .blackboxignore pattern(s).`;
+        }
+        return null;
+    }
+    createInvocation(params) {
+        return new ReadFileToolInvocation(this.config, params);
+    }
+}
+//# sourceMappingURL=read-file.js.map

package/dist/src/tools/read-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-file.js","sourceRoot":"","sources":["../../../src/tools/read-file.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAsB3D,MAAM,sBAAuB,SAAQ,kBAGpC;IAEW;IADV,YACU,MAAc,EACtB,MAA0B;QAE1B,KAAK,CAAC,MAAM,CAAC,CAAC;QAHN,WAAM,GAAN,MAAM,CAAQ;IAIxB,CAAC;IAED,cAAc;QACZ,MAAM,YAAY,GAAG,YAAY,CAC/B,IAAI,CAAC,MAAM,CAAC,aAAa,EACzB,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAC3B,CAAC;QACF,OAAO,WAAW,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC;IAEQ,aAAa;QACpB,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAC3C,IAAI,CAAC,MAAM,CAAC,aAAa,EACzB,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAC1B,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAClC,IAAI,CAAC,MAAM,CAAC,MAAM,EAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAClB,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO;gBACL,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,aAAa,EAAE,MAAM,CAAC,aAAa,IAAI,oBAAoB;gBAC3D,KAAK,EAAE;oBACL,OAAO,EAAE,MAAM,CAAC,KAAK;oBACrB,IAAI,EAAE,MAAM,CAAC,SAAS;iBACvB;aACF,CAAC;QACJ,CAAC;QAED,IAAI,UAAqB,CAAC;QAC1B,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,UAAW,CAAC;YACxC,MAAM,KAAK,GAAG,MAAM,CAAC,iBAAkB,CAAC;YACxC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM;gBACnC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,CAAC;gBACtC,CAAC,CAAC,GAAG,CAAC;YACR,UAAU,GAAG;;wBAEK,KAAK,IAAI,GAAG,OAAO,KAAK;qLACqI,UAAU;;;EAG7L,MAAM,CAAC,UAAU,EAAE,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;QACvC,CAAC;QAED,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ;YACnC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM;YACtC,CAAC,CAAC,SAAS,CAAC;QAChB,MAAM,QAAQ,GAAG,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAChE,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;YAClD,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;SACzC,CAAC,CAAC;QACH,gBAAgB,CACd,IAAI,CAAC,MAAM,EACX,IAAI,kBAAkB,CACpB,YAAY,CAAC,IAAI,EACjB,aAAa,CAAC,IAAI,EAClB,KAAK,EACL,QAAQ,EACR,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EACvC,SAAS,EACT,oBAAoB,CACrB,CACF,CAAC;QAEF,OAAO;YACL,UAAU;YACV,aAAa,EAAE,MAAM,CAAC,aAAa,IAAI,EAAE;SAC1C,CAAC;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,mBAGjC;IAGqB;IAFpB,MAAM,CAAU,IAAI,GAAW,SAAS,CAAC,SAAS,CAAC;IAEnD,YAAoB,MAAc;QAChC,KAAK,CACH,YAAY,CAAC,IAAI,EACjB,UAAU,EACV,yYAAyY,EACzY,IAAI,CAAC,IAAI,EACT;YACE,UAAU,EAAE;gBACV,aAAa,EAAE;oBACb,WAAW,EACT,mJAAmJ;oBACrJ,IAAI,EAAE,QAAQ;iBACf;gBACD,MAAM,EAAE;oBACN,WAAW,EACT,8IAA8I;oBAChJ,IAAI,EAAE,QAAQ;iBACf;gBACD,KAAK,EAAE;oBACL,WAAW,EACT,uLAAuL;oBACzL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,QAAQ,EAAE,CAAC,eAAe,CAAC;YAC3B,IAAI,EAAE,QAAQ;SACf,CACF,CAAC;QA3BgB,WAAM,GAAN,MAAM,CAAQ;IA4BlC,CAAC;IAEkB,uBAAuB,CACxC,MAA0B;QAE1B,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,CAAC;QACtC,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACvC,OAAO,kDAAkD,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,OAAO,iDAAiD,QAAQ,sCAAsC,CAAC;QACzG,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC;QAC3D,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtD,MAAM,WAAW,GAAG,gBAAgB,CAAC,cAAc,EAAE,CAAC;YACtD,OAAO,8DAA8D,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAChG,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,OAAO,sCAAsC,CAAC;QAChD,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;YACpD,OAAO,iCAAiC,CAAC;QAC3C,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QACjD,IAAI,WAAW,CAAC,sBAAsB,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;YAC7D,OAAO,cAAc,QAAQ,6CAA6C,CAAC;QAC7E,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,gBAAgB,CACxB,MAA0B;QAE1B,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC"}

package/dist/src/tools/read-file.test.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};