nvim-plugins/toggleterm.nvim
1
0
Fork 0
mirror of https://github.com/akinsho/toggleterm.nvim synced 2024-09-16 21:34:03 +02:00
Code Issues Projects Releases Packages Wiki Activity

newline_chr is optionally user-specified (#518)

Browse source 
* newline_chr is optionally user-specified

R on cmd.exe on windows adds a newline using the current logic (newline
is chosen as: "\r\n"). This proposal makes newline_chr a property of the
terminal, and allows the user to specify it's value when creating
custom terminals.

* remove commented code

* Docs: CUSTOM TERMINAL USAGE

* spelling

Co-authored-by: Akin <22454918+akinsho@users.noreply.github.com>

* remove comment

---------

Co-authored-by: Akin <22454918+akinsho@users.noreply.github.com>
This commit is contained in:
fisher-j 2023-12-13 00:06:51 -08:00 committed by GitHub
parent cbd041d91b
commit 0532d3a94d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/toggleterm.txt
View file

@ -477,13 +477,17 @@ using the current count e.g. `:5ToggleTerm<CR>`
local lazygit = Terminal:new({ cmd = "lazygit", count = 5 })
<
You can also set a custom layout for a terminal.
You can also set several options for the custom terminal including layout,
opening and closing functions, and the newline character used when sending text
to the terminal. The `newline_chr` defaults to "\r" on powershell, "\r\n" on
cmd.exe, and "\n" otherwise.
>lua
local lazygit = Terminal:new({
cmd = "lazygit",
dir = "git_dir",
direction = "float",
newline_chr = "\n"
float_opts = {
border = "double",
},

9
lua/toggleterm/terminal.lua
View file

@ -46,6 +46,7 @@ end
local terminals = {}
--- @class TermCreateArgs
--- @field newline_chr? string user specified newline chararacter
--- @field cmd? string a custom command to run
--- @field direction? string the layout style for the terminal
--- @field id number?
@ -65,6 +66,7 @@ local terminals = {}
--- @field on_close fun(term:Terminal)?
--- @class Terminal
--- @field newline_chr string
--- @field cmd string
--- @field direction string the layout style for the terminal
--- @field id number
@ -193,6 +195,7 @@ function Terminal:new(term)
if id and terminals[id] then return terminals[id] end
local conf = config.get()
self.__index = self
term.newline_chr = term.newline_chr or get_newline_chr()
term.direction = term.direction or conf.direction
term.id = id or next_id()
term.display_name = term.display_name
@ -287,10 +290,10 @@ end
---Combine arguments into strings separated by new lines
---@vararg string
---@param newline_chr string
---@return string
local function with_cr(...)
local function with_cr(newline_chr, ...)
local result = {}
local newline_chr = get_newline_chr()
for _, str in ipairs({ ... }) do
table.insert(result, str .. newline_chr)
end
@ -312,7 +315,7 @@ end
---@param cmd string|string[]
---@param go_back boolean? whether or not to return to original window
function Terminal:send(cmd, go_back)
cmd = type(cmd) == "table" and with_cr(unpack(cmd)) or with_cr(cmd --[[@as string]])
cmd = type(cmd) == "table" and with_cr(self.newline_chr, unpack(cmd)) or with_cr(self.newline_chr, cmd --[[@as string]])
fn.chansend(self.job_id, cmd)
self:scroll_bottom()
if go_back and self:is_focused() then