feat: create file will not fail if file already exists (#658)

Author: brandonskiser

crates/q_cli/src/cli/chat/tools/fs_write.rs

@@ -26,7 +26,6 @@ use syntect::util::{
     LinesWithEndings,
     as_24_bit_terminal_escaped,
 };
-use tokio::io::AsyncWriteExt;
 use tracing::error;
 
 use super::{
@@ -62,16 +61,20 @@ impl FsWrite {
         let cwd = ctx.env().current_dir()?;
         match self {
             FsWrite::Create { path, file_text } => {
+                let relative_path = format_path(cwd, fs.chroot_path(path));
+                let invoke_description = if fs.exists(path) {
+                    "Replacing the current file contents at"
+                } else {
+                    "Creating a new file at"
+                };
                 queue!(
                     updates,
                     style::SetForegroundColor(Color::Green),
-                    style::Print(format!("Creating a new file at {}", format_path(cwd, path))),
+                    style::Print(format!("{} {}", invoke_description, relative_path)),
                     style::ResetColor,
                     style::Print("\n"),
                 )?;
-                let mut file = fs.create_new(path).await?;
-                file.write_all(file_text.as_bytes()).await?;
-                file.sync_data().await?;
+                fs.write(&path, file_text.as_bytes()).await?;
                 Ok(Default::default())
             },
             FsWrite::StrReplace { path, old_str, new_str } => {
@@ -132,18 +135,39 @@ impl FsWrite {
         let cwd = ctx.env().current_dir()?;
         match self {
             FsWrite::Create { path, file_text } => {
-                let path = format_path(cwd, path);
-                let file = stylize_output_if_able(&path, file_text, None, None);
+                let relative_path = format_path(cwd, path);
                 queue!(
                     updates,
                     style::Print("Path: "),
                     style::SetForegroundColor(Color::Green),
-                    style::Print(path),
-                    style::ResetColor,
-                    style::Print("\n\nContents:\n"),
-                    style::Print(file),
+                    style::Print(&relative_path),
                     style::ResetColor,
+                    style::Print("\n\n"),
                 )?;
+                if ctx.fs().exists(path) {
+                    let prev = ctx.fs().read_to_string_sync(path)?;
+                    let prev = stylize_output_if_able(&relative_path, prev.as_str(), None, Some("-"));
+                    let new = stylize_output_if_able(&relative_path, file_text, None, Some("+"));
+                    queue!(
+                        updates,
+                        style::Print("Replacing:\n"),
+                        style::Print(prev),
+                        style::ResetColor,
+                        style::Print("\n\n"),
+                        style::Print("With:\n"),
+                        style::Print(new),
+                        style::ResetColor,
+                        style::Print("\n\n")
+                    )?;
+                } else {
+                    let file = stylize_output_if_able(&relative_path, file_text, None, None);
+                    queue!(
+                        updates,
+                        style::Print("\n\nContents:\n"),
+                        style::Print(file),
+                        style::ResetColor,
+                    )?;
+                }
                 Ok(())
             },
             FsWrite::Insert {
@@ -182,15 +206,11 @@ impl FsWrite {
                     style::Print(path),
                     style::ResetColor,
                     style::Print("\n\n"),
-                    // style::SetAttribute(style::Attribute::Bold),
                     style::Print("Replacing:\n"),
-                    // style::SetAttribute(style::Attribute::Reset),
                     style::Print(old_str),
                     style::ResetColor,
                     style::Print("\n\n"),
-                    // style::SetAttribute(style::Attribute::Bold),
                     style::Print("With:\n"),
-                    // style::SetAttribute(style::Attribute::Reset),
                     style::Print(new_str),
                     style::ResetColor
                 )?;
@@ -433,6 +453,20 @@ mod tests {
             .unwrap();
 
         assert_eq!(ctx.fs().read_to_string("/my-file").await.unwrap(), file_text);
+
+        let file_text = "Goodbye, world!\nSee you later";
+        let v = serde_json::json!({
+            "path": "/my-file",
+            "command": "create",
+            "file_text": file_text
+        });
+        serde_json::from_value::<FsWrite>(v)
+            .unwrap()
+            .invoke(&ctx, &mut stdout)
+            .await
+            .unwrap();
+
+        assert_eq!(ctx.fs().read_to_string("/my-file").await.unwrap(), file_text);
     }
 
     #[tokio::test]

crates/q_cli/src/cli/chat/tools/tool_index.json

@@ -40,7 +40,7 @@
   },
   {
     "name": "fs_write",
-    "description": "Custom editing tool for creating and editing files\n * The `create` command cannot be used if the specified `path` already exists as a file\n * If a `command` generates a long output, it will be truncated and marked with `<response clipped>` \n Notes for using the `str_replace` command:\n * The `old_str` parameter should match EXACTLY one or more consecutive lines from the original file. Be mindful of whitespaces!\n * If the `old_str` parameter is not unique in the file, the replacement will not be performed. Make sure to include enough context in `old_str` to make it unique\n * The `new_str` parameter should contain the edited lines that should replace the `old_str`",
+    "description": "Custom editing tool for creating and editing files\n * The `create` command will override the file at `path` if it already exists as a file, and otherwise create a new file\n * If a `command` generates a long output, it will be truncated and marked with `<response clipped>` \n Notes for using the `str_replace` command:\n * The `old_str` parameter should match EXACTLY one or more consecutive lines from the original file. Be mindful of whitespaces!\n * If the `old_str` parameter is not unique in the file, the replacement will not be performed. Make sure to include enough context in `old_str` to make it unique\n * The `new_str` parameter should contain the edited lines that should replace the `old_str`",
     "input_schema": {
       "type": "object",
       "properties": {

crates/q_cli/tests/chat_response_stubs/fs_write.json

@@ -0,0 +1,26 @@
+[
+    [
+        "I will use the `fs_write` tool. This should verify that the `create` command will not fail if the file already exists.",
+        {
+            "tool_use_id": "1",
+            "name": "fs_write",
+            "args": {
+                "command": "create",
+                "path": "stub_output/test_file.sh",
+                "file_text": "#!/usr/bin/env sh\necho 'hello'\necho 'world'\n"
+            }
+        }
+    ],
+    [
+        "Now, overwriting.",
+        {
+            "tool_use_id": "1",
+            "name": "fs_write",
+            "args": {
+                "command": "create",
+                "path": "stub_output/test_file.sh",
+                "file_text": "#!/usr/bin/env sh\necho 'goodbye'\necho 'world'\n"
+            }
+        }
+    ]
+]