refactor: improve code quality based on PR review feedback

- Enhanced error handling in diff.lua with proper return values
- Optimized debug logging to avoid string operations when disabled
- Documented timing configuration changes with rationale
- Removed redundant comments that added no value
- Added backward compatibility for test environments

Change-Id: Ic9ac0aa77506114955b740b42ee3d1af0bc7fea0
Signed-off-by: Thomas Kosiewski <[email protected]>

Author: ThomasK33

lua/claudecode/config.lua

@@ -18,8 +18,6 @@ M.defaults = {
 }
 
 --- @param config table The configuration table to validate.
--- @return boolean true if the configuration is valid.
--- @error string if any configuration option is invalid.
 function M.validate(config)
   assert(
     type(config.port_range) == "table"
@@ -63,7 +61,6 @@ function M.validate(config)
 end
 
 --- @param user_config table|nil The user-provided configuration table.
--- @return table The final, validated configuration table.
 function M.apply(user_config)
   local config = vim.deepcopy(M.defaults)
 

lua/claudecode/diff.lua

@@ -399,11 +399,14 @@ end
 --- Apply accepted changes to the original file and reload open buffers
 -- @param diff_data table The diff state data
 -- @param final_content string The final content to write
+-- @return boolean success Whether the operation succeeded
+-- @return string|nil error Error message if operation failed
 function M._apply_accepted_changes(diff_data, final_content)
   local old_file_path = diff_data.old_file_path
   if not old_file_path then
-    require("claudecode.logger").error("diff", "No old_file_path found in diff_data")
-    return
+    local error_msg = "No old_file_path found in diff_data"
+    require("claudecode.logger").error("diff", error_msg)
+    return false, error_msg
   end
 
   require("claudecode.logger").debug("diff", "Writing accepted changes to file:", old_file_path)
@@ -415,14 +418,9 @@ function M._apply_accepted_changes(diff_data, final_content)
       require("claudecode.logger").debug("diff", "Creating parent directories for new file:", parent_dir)
       local mkdir_success, mkdir_err = pcall(vim.fn.mkdir, parent_dir, "p")
       if not mkdir_success then
-        require("claudecode.logger").error(
-          "diff",
-          "Failed to create parent directories:",
-          parent_dir,
-          "error:",
-          mkdir_err
-        )
-        return
+        local error_msg = "Failed to create parent directories: " .. parent_dir .. " - " .. tostring(mkdir_err)
+        require("claudecode.logger").error("diff", error_msg)
+        return false, error_msg
       end
       require("claudecode.logger").debug("diff", "Successfully created parent directories:", parent_dir)
     end
@@ -433,8 +431,9 @@ function M._apply_accepted_changes(diff_data, final_content)
   local success, err = pcall(vim.fn.writefile, lines, old_file_path)
 
   if not success then
-    require("claudecode.logger").error("diff", "Failed to write file:", old_file_path, "error:", err)
-    return
+    local error_msg = "Failed to write file: " .. old_file_path .. " - " .. tostring(err)
+    require("claudecode.logger").error("diff", error_msg)
+    return false, error_msg
   end
 
   require("claudecode.logger").debug("diff", "Successfully wrote changes to", old_file_path)
@@ -454,6 +453,8 @@ function M._apply_accepted_changes(diff_data, final_content)
       end
     end
   end
+
+  return true, nil
 end
 
 --- Resolve diff as accepted with final content

lua/claudecode/init.lua

@@ -46,7 +46,7 @@ local default_config = {
   terminal_cmd = nil,
   log_level = "info",
   track_selection = true,
-  visual_demotion_delay_ms = 50,
+  visual_demotion_delay_ms = 50, -- Reduced from 200ms for better responsiveness in tree navigation
   diff_opts = {
     auto_close_on_accept = true,
     show_diff_stats = true,
@@ -294,17 +294,25 @@ function M._create_commands()
 
     local broadcast_success = M.state.server.broadcast("at_mentioned", params)
     if broadcast_success then
-      local message = "Broadcast success: Added " .. (is_directory and "directory" or "file") .. " " .. formatted_path
-      if not is_directory and (start_line or end_line) then
-        local range_info = ""
-        if start_line and end_line then
-          range_info = " (lines " .. start_line .. "-" .. end_line .. ")"
-        elseif start_line then
-          range_info = " (from line " .. start_line .. ")"
+      if logger.is_level_enabled and logger.is_level_enabled("debug") then
+        local message = "Broadcast success: Added " .. (is_directory and "directory" or "file") .. " " .. formatted_path
+        if not is_directory and (start_line or end_line) then
+          local range_info = ""
+          if start_line and end_line then
+            range_info = " (lines " .. start_line .. "-" .. end_line .. ")"
+          elseif start_line then
+            range_info = " (from line " .. start_line .. ")"
+          end
+          message = message .. range_info
         end
-        message = message .. range_info
+        logger.debug("command", message)
+      elseif not logger.is_level_enabled then
+        -- Fallback for tests or environments where logger isn't fully initialized
+        logger.debug(
+          "command",
+          "Broadcast success: Added " .. (is_directory and "directory" or "file") .. " " .. formatted_path
+        )
       end
-      logger.debug("command", message)
       return true, nil
     else
       local error_msg = "Failed to broadcast " .. (is_directory and "directory" or "file") .. " " .. formatted_path

lua/claudecode/logger.lua

@@ -112,6 +112,17 @@ function M.info(component, ...)
   end
 end
 
+--- Check if a specific log level is enabled
+-- @param level_name string The level name ("error", "warn", "info", "debug", "trace")
+-- @return boolean Whether the level is enabled
+function M.is_level_enabled(level_name)
+  local level_value = level_values[level_name]
+  if not level_value then
+    return false
+  end
+  return level_value <= current_log_level_value
+end
+
 --- @param component string|nil Optional component/module name.
 -- @param ... any Varargs representing parts of the message.
 function M.debug(component, ...)