MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-03-29 23:41:29 -07:00
Code Issues Packages Projects Releases Wiki Activity

Use consistent param names (#12517)

Browse Source
This commit is contained in:
Tommaso Sciortino
2025-11-06 15:03:52 -08:00
committed by GitHub
parent 5f1208ad81
commit f05d937f39
27 changed files with 553 additions and 525 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
packages/core/src/tools/write-file.ts
View File

@@ -143,6 +143,8 @@ class WriteFileToolInvocation extends BaseToolInvocation<
WriteFileToolParams,
ToolResult
> {
private readonly resolvedPath: string;
constructor(
private readonly config: Config,
params: WriteFileToolParams,
@@ -151,15 +153,19 @@ class WriteFileToolInvocation extends BaseToolInvocation<
displayName?: string,
) {
super(params, messageBus, toolName, displayName);
this.resolvedPath = path.resolve(
this.config.getTargetDir(),
this.params.file_path,
);
}
override toolLocations(): ToolLocation[] {
return [{ path: this.params.file_path }];
return [{ path: this.resolvedPath }];
}
override getDescription(): string {
const relativePath = makeRelative(
this.params.file_path,
this.resolvedPath,
this.config.getTargetDir(),
);
return `Writing to ${shortenPath(relativePath)}`;
@@ -174,7 +180,7 @@ class WriteFileToolInvocation extends BaseToolInvocation<
const correctedContentResult = await getCorrectedFileContent(
this.config,
this.params.file_path,
this.resolvedPath,
this.params.content,
abortSignal,
);
@@ -186,10 +192,10 @@ class WriteFileToolInvocation extends BaseToolInvocation<
const { originalContent, correctedContent } = correctedContentResult;
const relativePath = makeRelative(
this.params.file_path,
this.resolvedPath,
this.config.getTargetDir(),
);
const fileName = path.basename(this.params.file_path);
const fileName = path.basename(this.resolvedPath);
const fileDiff = Diff.createPatch(
fileName,
@@ -203,14 +209,14 @@ class WriteFileToolInvocation extends BaseToolInvocation<
const ideClient = await IdeClient.getInstance();
const ideConfirmation =
this.config.getIdeMode() && ideClient.isDiffingEnabled()
? ideClient.openDiff(this.params.file_path, correctedContent)
? ideClient.openDiff(this.resolvedPath, correctedContent)
: undefined;
const confirmationDetails: ToolEditConfirmationDetails = {
type: 'edit',
title: `Confirm Write: ${shortenPath(relativePath)}`,
fileName,
filePath: this.params.file_path,
filePath: this.resolvedPath,
fileDiff,
originalContent,
newContent: correctedContent,
@@ -232,11 +238,10 @@ class WriteFileToolInvocation extends BaseToolInvocation<
}
async execute(abortSignal: AbortSignal): Promise<ToolResult> {
const { file_path, content, ai_proposed_content, modified_by_user } =
this.params;
const { content, ai_proposed_content, modified_by_user } = this.params;
const correctedContentResult = await getCorrectedFileContent(
this.config,
file_path,
this.resolvedPath,
content,
abortSignal,
);
@@ -244,7 +249,7 @@ class WriteFileToolInvocation extends BaseToolInvocation<
if (correctedContentResult.error) {
const errDetails = correctedContentResult.error;
const errorMsg = errDetails.code
? `Error checking existing file '${file_path}': ${errDetails.message} (${errDetails.code})`
? `Error checking existing file '${this.resolvedPath}': ${errDetails.message} (${errDetails.code})`
: `Error checking existing file: ${errDetails.message}`;
return {
llmContent: errorMsg,
@@ -269,17 +274,17 @@ class WriteFileToolInvocation extends BaseToolInvocation<
!correctedContentResult.fileExists);
try {
const dirName = path.dirname(file_path);
const dirName = path.dirname(this.resolvedPath);
if (!fs.existsSync(dirName)) {
fs.mkdirSync(dirName, { recursive: true });
}
await this.config
.getFileSystemService()
.writeTextFile(file_path, fileContent);
.writeTextFile(this.resolvedPath, fileContent);
// Generate diff for display result
const fileName = path.basename(file_path);
const fileName = path.basename(this.resolvedPath);
// If there was a readError, originalContent in correctedContentResult is '',
// but for the diff, we want to show the original content as it was before the write if possible.
// However, if it was unreadable, currentContentForDiff will be empty.
@@ -306,8 +311,8 @@ class WriteFileToolInvocation extends BaseToolInvocation<
const llmSuccessMessageParts = [
isNewFile
? `Successfully created and wrote to new file: ${file_path}.`
: `Successfully overwrote file: ${file_path}.`,
? `Successfully created and wrote to new file: ${this.resolvedPath}.`
: `Successfully overwrote file: ${this.resolvedPath}.`,
];
if (modified_by_user) {
llmSuccessMessageParts.push(
@@ -316,9 +321,9 @@ class WriteFileToolInvocation extends BaseToolInvocation<
}
// Log file operation for telemetry (without diff_stat to avoid double-counting)
const mimetype = getSpecificMimeType(file_path);
const programmingLanguage = getLanguageFromFilePath(file_path);
const extension = path.extname(file_path);
const mimetype = getSpecificMimeType(this.resolvedPath);
const programmingLanguage = getLanguageFromFilePath(this.resolvedPath);
const extension = path.extname(this.resolvedPath);
const operation = isNewFile ? FileOperation.CREATE : FileOperation.UPDATE;
logFileOperation(
@@ -352,17 +357,17 @@ class WriteFileToolInvocation extends BaseToolInvocation<
if (isNodeError(error)) {
// Handle specific Node.js errors with their error codes
errorMsg = `Error writing to file '${file_path}': ${error.message} (${error.code})`;
errorMsg = `Error writing to file '${this.resolvedPath}': ${error.message} (${error.code})`;
// Log specific error types for better debugging
if (error.code === 'EACCES') {
errorMsg = `Permission denied writing to file: ${file_path} (${error.code})`;
errorMsg = `Permission denied writing to file: ${this.resolvedPath} (${error.code})`;
errorType = ToolErrorType.PERMISSION_DENIED;
} else if (error.code === 'ENOSPC') {
errorMsg = `No space left on device: ${file_path} (${error.code})`;
errorMsg = `No space left on device: ${this.resolvedPath} (${error.code})`;
errorType = ToolErrorType.NO_SPACE_LEFT;
} else if (error.code === 'EISDIR') {
errorMsg = `Target is a directory, not a file: ${file_path} (${error.code})`;
errorMsg = `Target is a directory, not a file: ${this.resolvedPath} (${error.code})`;
errorType = ToolErrorType.TARGET_IS_DIRECTORY;
}
@@ -411,8 +416,7 @@ export class WriteFileTool
{
properties: {
file_path: {
description:
"The absolute path to the file to write to (e.g., '/home/user/project/file.txt'). Relative paths are not supported.",
description: 'The path to the file to write to.',
type: 'string',
},
content: {
@@ -438,12 +442,10 @@ export class WriteFileTool
return `Missing or empty "file_path"`;
}
if (!path.isAbsolute(filePath)) {
return `File path must be absolute: ${filePath}`;
}
const resolvedPath = path.resolve(this.config.getTargetDir(), filePath);
const workspaceContext = this.config.getWorkspaceContext();
if (!workspaceContext.isPathWithinWorkspace(filePath)) {
if (!workspaceContext.isPathWithinWorkspace(resolvedPath)) {
const directories = workspaceContext.getDirectories();
return `File path must be within one of the workspace directories: ${directories.join(
', ',
@@ -451,14 +453,14 @@ export class WriteFileTool
}
try {
if (fs.existsSync(filePath)) {
const stats = fs.lstatSync(filePath);
if (fs.existsSync(resolvedPath)) {
const stats = fs.lstatSync(resolvedPath);
if (stats.isDirectory()) {
return `Path is a directory, not a file: ${filePath}`;
return `Path is a directory, not a file: ${resolvedPath}`;
}
}
} catch (statError: unknown) {
return `Error accessing path properties for validation: ${filePath}. Reason: ${
return `Error accessing path properties for validation: ${resolvedPath}. Reason: ${
statError instanceof Error ? statError.message : String(statError)
}`;
}