Merge pull request #229 from zhengpd/feat/configurable-terminal-displ…

…ay-options

feat: more flexible terminal display options

doc/sniprun.txt

@@ -103,6 +103,9 @@ require'sniprun'.setup({
   live_display = { "VirtualTextOk" }, --# display mode used in live_mode
 
   display_options = {
+    terminal_scrollback = vim.o.scrollback, -- change terminal display scrollback lines
+    terminal_line_number = false, -- whether show line number in terminal window
+    terminal_signcolumn = false, -- whether show signcolumn in terminal window
     terminal_width = 45,       --# change the terminal display option width
     notification_timeout = 5   --# timeout for nvim_notify output
   },

doc/sources/README.md

@@ -251,6 +251,9 @@ require'sniprun'.setup({
   live_display = { "VirtualTextOk" }, --# display mode used in live_mode
 
   display_options = {
+    terminal_scrollback = vim.o.scrollback, -- change terminal display scrollback lines
+    terminal_line_number = false, -- whether show line number in terminal window
+    terminal_signcolumn = false, -- whether show signcolumn in terminal window
     terminal_width = 45,       --# change the terminal display option width
     notification_timeout = 5   --# timeout for nvim_notify output
   },

doc/sources/display_modes.md

@@ -125,6 +125,9 @@ lua << EOF
 require'sniprun'.setup({
     display = { "Terminal" },
     display_options = {
+        terminal_scrollback = vim.o.scrollback, -- change terminal display scrollback lines
+        terminal_line_number = false, -- whether show line number in terminal window
+        terminal_signcolumn = false, -- whether show signcolumn in terminal window
         terminal_width = 45,
     },
 })

lua/sniprun.lua

@@ -35,6 +35,9 @@ M.config_values = {
   live_display = { "VirtualTextOk" }, -- displayed only for live mode
 
   display_options = {
+    terminal_scrollback = vim.o.scrollback, -- change terminal display scrollback lines
+    terminal_line_number = false, -- whether show line number in terminal window
+    terminal_signcolumn = false, -- whether show signcolumn in terminal window
     terminal_width = 45,       -- change the terminal display option width
     notification_timeout = 5   -- timeout for nvim_notify output
   },
@@ -80,6 +83,8 @@ end
 
 function M.setup(opts)
   opts = opts or {}
+
+  -- pre-process config keys
   for key,value in pairs(opts) do
     if M.config_values[key] == nil then
       error(string.format('[Sniprun] Key %s does not exist in config values',key))
@@ -91,8 +96,11 @@ function M.setup(opts)
     if key == 'live_mode_toggle' and opts[key] == 'enable' then
       require('sniprun.live_mode')
     end
-    M.config_values[key] = value
   end
+
+  -- merge user config into default config values
+  M.config_values = vim.tbl_deep_extend("force", M.config_values, opts)
+
   M.configure_keymaps()
   M.setup_highlights()
   M.setup_autocommands()

lua/sniprun/display.lua

@@ -45,12 +45,22 @@ function M.term_set_window_handle()
 end
 
 function M.term_set_buffer_chan(winid)
-  if M.term.buffer ~= -1 then return end
+  if M.term.buffer ~= -1 then
+    vim.api.nvim_win_set_buf(winid, M.term.buffer)
+    return
+  end
 
   local buf = vim.api.nvim_create_buf(false, true)
-  vim.fn.win_execute(winid, "set scrollback=1")
-  vim.fn.win_execute(winid, "setlocal nonu")
-  vim.fn.win_execute(winid, "setlocal signcolumn=no")
+
+  vim.api.nvim_win_set_buf(winid, buf)
+  local display_options = require("sniprun").config_values.display_options
+  vim.fn.win_execute(winid, "setlocal scrollback=" .. display_options.terminal_scrollback)
+
+  local lnumber = display_options.terminal_line_number and "number" or "nonumber"
+  vim.fn.win_execute(winid, "setlocal " .. lnumber)
+
+  local scl = display_options.terminal_signcolumn and vim.o.signcolumn or "no"
+  vim.fn.win_execute(winid, "setlocal signcolumn=" .. scl)
 
   M.term.buffer = buf
   M.term.chan = vim.api.nvim_open_term(buf, {})
@@ -59,8 +69,6 @@ end
 function M.term_open()
   M.term_set_window_handle()
   M.term_set_buffer_chan(M.term.window_handle)
-
-  vim.api.nvim_win_set_buf(M.term.window_handle, M.term.buffer)
 end
 
 function M.write_to_term(message, ok)
@@ -84,9 +92,12 @@ function M.write_to_term(message, ok)
     vim.api.nvim_chan_send(M.term.chan, line)
     vim.api.nvim_chan_send(M.term.chan, "\n\r");
   end
-  vim.api.nvim_chan_send(M.term.chan, "\n\r");
+
   M.term.current_line = h
 
+  if M.term.current_line > vim.fn.line("w$") then
+    vim.fn.win_execute(M.term.window_handle, "normal " .. M.term.current_line .. "gg")
+  end
 end
 
 

ressources/display_terminal.md

@@ -26,6 +26,9 @@ EOF
 You can change the width of the terminal by using the display option in the configuration:
 ```
   display_options = {
+    terminal_scrollback = vim.o.scrollback, -- change terminal display scrollback lines
+    terminal_line_number = false, -- whether show line number in terminal window
+    terminal_signcolumn = false, -- whether show signcolumn in terminal window
     terminal_width = 45,       -- change the terminal display option width
   },
 ```