Add clear option to send

Author: waiting-for-dev

CHANGELOG.md

@@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file.
 - BREAKING: `selectable` option has been deprecated in favor of `auto_list`.
 - BREAKING: Rename `.get_last_focused()` to `.get_target_for_bang()`.
 - Added `scrollback` setting to configure terminal scrollback buffer size.
+- Added `clear` option to `term:send()` to clear the terminal before sending input.
 
 ## 0.9.0 - 2025-11-07
 

lua/ergoterm/commandline.lua

@@ -41,6 +41,7 @@ end
 ---@field name string?
 ---@field target string?
 ---@field action string?
+---@field clear boolean?
 ---@field decorator string?
 ---@field trim boolean?
 ---@field new_line boolean?
@@ -95,6 +96,7 @@ function M.parse(args)
       new_line = true,
       auto_scroll = true,
       bang_target = true,
+      clear = true,
       watch_files = true,
       persist_mode = true,
       persist_size = true,
@@ -283,6 +285,8 @@ M._all_options = {
 
   bang_target = M._boolean_options,
 
+  clear = M._boolean_options,
+
   watch_files = M._boolean_options,
 
   persist_mode = M._boolean_options,
@@ -432,6 +436,7 @@ M._term_send_options = {
   decorator = M._all_options.decorator,
   trim = M._all_options.trim,
   new_line = M._all_options.new_line,
+  clear = M._all_options.clear
 }
 
 M._term_select_options = {

lua/ergoterm/commands.lua

@@ -121,6 +121,7 @@ function M.send(args, range, bang, picker)
   vim.validate("decorator", parsed.decorator, "string", true)
   vim.validate("trim", parsed.trim, "boolean", true)
   vim.validate("new_line", parsed.new_line, "boolean", true)
+  vim.validate("clear", parsed.clear, "boolean", true)
   local selection = range == 0 and "single_line" or
       (vim.fn.visualmode() == "V" and "visual_lines" or "visual_selection")
   local input = parsed.text and { parsed.text } or selection
@@ -130,7 +131,8 @@ function M.send(args, range, bang, picker)
       action = parsed.action,
       trim = parsed.trim,
       new_line = parsed.new_line,
-      decorator = parsed.decorator
+      decorator = parsed.decorator,
+      clear = parsed.clear
     })
   end
   return M._execute_on_terminal(

lua/ergoterm/instance/send.lua

@@ -19,6 +19,7 @@ local M = {}
 ---@field action? send_action terminal interaction mode (default: "focus")
 ---@field trim? boolean remove leading/trailing whitespace (default: true)
 ---@field new_line? boolean append newline for command execution (default: true)
+---@field clear? boolean clear terminal before sending (default: false)
 ---@field decorator? string | fun(text: string[]): string[] transform text before sending
 
 ---@param term Terminal
@@ -30,13 +31,15 @@ function M.send(term, input, opts)
   local action = opts.action or "focus"
   local trim = opts.trim == nil or opts.trim
   local new_line = opts.new_line == nil or opts.new_line
+  local clear = opts.clear or false
   local decorator = M._parse_decorator(opts.decorator)
   if not M._validate_selection_type(input) then return term end
   local computed_input = M._parse_input(input, term)
   term._state.last_sent = vim.deepcopy(computed_input)
   computed_input = M._maybe_add_new_line(computed_input, new_line)
   computed_input = M._maybe_trim_input(computed_input, trim)
   computed_input = decorator(computed_input)
+  M._maybe_clear(term, clear)
   M._perform_action(term, action)
   vim.fn.chansend(term._state.job_id, computed_input)
   term:_scroll_bottom()
@@ -50,6 +53,15 @@ function M.clear(term, action)
   return M.send(term, { clear }, { action = action })
 end
 
+---@param term Terminal
+---@param clear boolean
+---@private
+function M._maybe_clear(term, clear)
+  if clear then
+    M.clear(term, "start")
+  end
+end
+
 function M._validate_selection_type(input)
   local valid_selection_types = { "single_line", "visual_lines", "visual_selection", "last" }
   if type(input) == "string" and not vim.tbl_contains(valid_selection_types, input) then

spec/ergoterm/commandline_spec.lua

@@ -103,6 +103,7 @@ describe("commandline.term_send_complete", function()
     assert.is_true(vim.tbl_contains(result, "decorator="))
     assert.is_true(vim.tbl_contains(result, "trim="))
     assert.is_true(vim.tbl_contains(result, "new_line="))
+    assert.is_true(vim.tbl_contains(result, "clear="))
   end)
 
   it("completes boolean values for trim", function()
@@ -112,6 +113,20 @@ describe("commandline.term_send_complete", function()
     assert.is_true(vim.tbl_contains(result, "trim=false"))
   end)
 
+  it("completes boolean values for new_line", function()
+    local result = commandline.term_send_complete("new_line=", "new_line=", 9)
+
+    assert.is_true(vim.tbl_contains(result, "new_line=true"))
+    assert.is_true(vim.tbl_contains(result, "new_line=false"))
+  end)
+
+  it("completes boolean values for clear", function()
+    local result = commandline.term_send_complete("clear=", "clear=", 6)
+
+    assert.is_true(vim.tbl_contains(result, "clear=true"))
+    assert.is_true(vim.tbl_contains(result, "clear=false"))
+  end)
+
   it("completes action values", function()
     local result = commandline.term_send_complete("action=", "action=", 7)
 

spec/ergoterm/commands_spec.lua

@@ -265,6 +265,18 @@ describe("M.send", function()
     })
   end)
 
+  it("clear screehn if specified", function()
+    local term = terms.Terminal:new():start()
+    local spy_chansend = spy.on(vim.fn, "chansend")
+
+    commands.send("clear=true text='after clear'", 0, false, select_only_picker)
+
+    assert.spy(spy_chansend).was_called_with(
+      term:get_state("job_id"),
+      { "clear", "" }
+    )
+  end)
+
   it("uses last focused terminal when called with the bang option", function()
     local term = terms.Terminal:new():start()
     term:focus()

spec/ergoterm/instance/send_spec.lua

@@ -169,6 +169,29 @@ describe(":send", function()
     assert.is_true(vim.tbl_contains(lines, "foo"))
   end)
 
+  it("clears before sending if clear is true", function()
+    local original_is_windows = utils.is_windows
+    ---@diagnostic disable-next-line: duplicate-set-field
+    utils.is_windows = function() return false end
+
+    local term = Terminal:new():start()
+    local spy_chansend = spy.on(vim.fn, "chansend")
+
+    send.send(term, { "line" }, { clear = true })
+    vim.wait(100)
+
+    assert.spy(spy_chansend).was_called_with(
+      term:get_state("job_id"),
+      { "clear", "" }
+    )
+    assert.spy(spy_chansend).was_called_with(
+      term:get_state("job_id"),
+      { "line", "" }
+    )
+
+    utils.is_windows = original_is_windows
+  end)
+
   it("only starts the terminal if action is start", function()
     local term = Terminal:new()