MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-04-21 10:34:35 -07:00
Code Issues Packages Projects Releases Wiki Activity

feat(core): generalize path correction for use across tools (#10612)

Browse Source
This commit is contained in:
anthony bushong
2025-10-09 13:51:16 -07:00
committed by GitHub
parent 433ca84ce0
commit ae02236c63
4 changed files with 174 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/src/tools/smart-edit.test.ts
-71
View File
@@ -274,77 +274,6 @@ describe('SmartEditTool', () => {
expect(result.occurrences).toBe(1);
});
});
describe('correctPath', () => {
it('should correct a relative path if it is unambiguous', () => {
const testFile = 'unique.txt';
fs.writeFileSync(path.join(rootDir, testFile), 'content');
const params: EditToolParams = {
file_path: testFile,
instruction: 'An instruction',
old_string: 'old',
new_string: 'new',
};
const validationResult = (tool as any).correctPath(params);
expect(validationResult).toBeNull();
expect(params.file_path).toBe(path.join(rootDir, testFile));
});
it('should correct a partial relative path if it is unambiguous', () => {
const subDir = path.join(rootDir, 'sub');
fs.mkdirSync(subDir);
const testFile = 'file.txt';
const partialPath = path.join('sub', testFile);
const fullPath = path.join(subDir, testFile);
fs.writeFileSync(fullPath, 'content');
const params: EditToolParams = {
file_path: partialPath,
instruction: 'An instruction',
old_string: 'old',
new_string: 'new',
};
const validationResult = (tool as any).correctPath(params);
expect(validationResult).toBeNull();
expect(params.file_path).toBe(fullPath);
});
it('should return an error for a relative path that does not exist', () => {
const params: EditToolParams = {
file_path: 'test.txt',
instruction: 'An instruction',
old_string: 'old',
new_string: 'new',
};
const result = (tool as any).correctPath(params);
expect(result).toMatch(/File not found for 'test.txt'/);
});
it('should return an error for an ambiguous path', () => {
const subDir1 = path.join(rootDir, 'module1');
const subDir2 = path.join(rootDir, 'module2');
fs.mkdirSync(subDir1, { recursive: true });
fs.mkdirSync(subDir2, { recursive: true });
const ambiguousFile = 'component.ts';
fs.writeFileSync(path.join(subDir1, ambiguousFile), 'content 1');
fs.writeFileSync(path.join(subDir2, ambiguousFile), 'content 2');
const params: EditToolParams = {
file_path: ambiguousFile,
instruction: 'An instruction',
old_string: 'old',
new_string: 'new',
};
const validationResult = (tool as any).correctPath(params);
expect(validationResult).toMatch(/ambiguous and matches multiple files/);
});
});
describe('validateToolParams', () => {
it('should return null for valid params', () => {
packages/core/src/tools/smart-edit.ts
+10 -55
View File
@@ -38,6 +38,7 @@ import { logSmartEditStrategy } from '../telemetry/loggers.js';
import { SmartEditCorrectionEvent } from '../telemetry/types.js';
import { logSmartEditCorrectionEvent } from '../telemetry/loggers.js';
import { correctPath } from '../utils/pathCorrector.js';
interface ReplacementContext {
params: EditToolParams;
currentContent: string;
@@ -876,58 +877,6 @@ A good instruction should concisely answer:
);
}
/**
* Quickly checks if the file path can be resolved directly against the workspace root.
* @param filePath The relative file path to check.
* @returns The absolute path if the file exists, otherwise null.
*/
private findDirectPath(filePath: string): string | null {
const directPath = path.join(this.config.getTargetDir(), filePath);
return fs.existsSync(directPath) ? directPath : null;
}
/**
* Searches for a file across all configured workspace directories.
* @param filePath The file path (can be partial) to search for.
* @returns A list of absolute paths for all matching files found.
*/
private findAmbiguousPaths(filePath: string): string[] {
const workspaceContext = this.config.getWorkspaceContext();
const fileSystem = this.config.getFileSystemService();
const searchPaths = workspaceContext.getDirectories();
return fileSystem.findFiles(filePath, searchPaths);
}
/**
* Attempts to correct a relative file path to an absolute path.
* This function modifies `params.file_path` in place if successful.
* @param params The tool parameters containing the file_path to correct.
* @returns An error message string if correction fails, otherwise null.
*/
private correctPath(params: EditToolParams): string | null {
const directPath = this.findDirectPath(params.file_path);
if (directPath) {
params.file_path = directPath;
return null;
}
const foundFiles = this.findAmbiguousPaths(params.file_path);
if (foundFiles.length === 0) {
return `File not found for '${params.file_path}' and path is not absolute.`;
}
if (foundFiles.length > 1) {
return (
`The file path '${params.file_path}' is too ambiguous and matches multiple files. ` +
`Please provide a more specific path. Matches: ${foundFiles.join(', ')}`
);
}
params.file_path = foundFiles[0];
return null;
}
/**
* Validates the parameters for the Edit tool
* @param params Parameters to validate
@@ -940,11 +889,17 @@ A good instruction should concisely answer:
return "The 'file_path' parameter must be non-empty.";
}
if (!path.isAbsolute(params.file_path)) {
let filePath = params.file_path;
if (!path.isAbsolute(filePath)) {
// Attempt to auto-correct to an absolute path
const error = this.correctPath(params);
if (error) return error;
const result = correctPath(filePath, this.config);
if (result.success) {
filePath = result.correctedPath;
} else {
return result.error;
}
}
params.file_path = filePath;
const workspaceContext = this.config.getWorkspaceContext();
if (!workspaceContext.isPathWithinWorkspace(params.file_path)) {