1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# NvChad Official Terminal Plugin
## Setup:
### Installation:
Simply install the plugin with packer as you would for any other:
```
use {
"NvChad/nvterm",
config = function ()
require("nvterm").setup()
end,
}
```
### Configuration:
Pass a table of configuration options to the plugin's `.setup()` function above.
A sample configuration table with the default options is shown below:
```lua
require("nvterm").setup({
terminals = {
list = {},
type_opts = {
float = {
relative = 'editor',
row = 0.3,
col = 0.25,
width = 0.5,
height = 0.4,
border = "single",
},
horizontal = { location = "rightbelow", split_ratio = .3, },
vertical = { location = "rightbelow", split_ratio = .5 },
}
},
behavior = {
close_on_exit = true,
auto_insert = true,
},
mappings = {
toggle = {
{ '<A-i>', function () terminal.new_or_toggle('float') end },
{ '<A-s>', function () terminal.new_or_toggle('horizontal') end },
{ '<A-v>', function () terminal.new_or_toggle('vertical') end },
}
}
})
```
A shortcut is available for setting options of the different terminal types:
```
require("nvterm").setup({
float = {
relative = 'editor',
row = 0.3,
col = 0.25,
width = 0.5,
height = 0.4,
border = "single",
},
horizontal = { location = "rightbelow", split_ratio = .3, },
vertical = { location = "rightbelow", split_ratio = .5 },
})
```
is equivalent to:
```
require("nvterm").setup({
terminals = {
type_opts = {
float = {
relative = 'editor',
row = 0.3,
col = 0.25,
width = 0.5,
height = 0.4,
border = "single",
},
horizontal = { location = "rightbelow", split_ratio = .3, },
vertical = { location = "rightbelow", split_ratio = .5 },
}
}
})
```
### Additional Functionality:
NvTerm provides an api for you to send commands to the terminal. You can create different ones for different filetypes like so:
```
require("nvterm").setup()
local terminal = require("nvterm.terminal")
local ft_cmds = {
python = "python3 " .. vim.fn.expand('%'),
...
<your commands here>
}
local mappings = {
{ 'n', '<C-l>', function () terminal.send(ft_cmds[vim.bo.filetype]) end },
{ 'n', '<Leader>s', function () terminal.new_or_toggle('horizontal') end },
{ 'n', '<Leader>v', function () terminal.new_or_toggle('vertical') end },
}
for _, mapping in ipairs(mappings) do
vim.keymap.set(mapping[1], mapping[2], mapping[3], opts)
end
```
`terminal.send` also takes a 'type' parameter, so you can choose what type of terminal to send the command to.
By default, it runs the command in the last opened terminal, or a vertical one if none exist.
`terminal.send(ft_cmds[vim.bo.filetype], "float")` will run the command in a floating terminal
|
