Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Bhanukamax/tman.nvim
Terminal Manager for Neovim, focused on running commands, tests, etc
https://github.com/Bhanukamax/tman.nvim
lua neovim terminal vim
Last synced: 2 months ago
JSON representation
Terminal Manager for Neovim, focused on running commands, tests, etc
- Host: GitHub
- URL: https://github.com/Bhanukamax/tman.nvim
- Owner: Bhanukamax
- Created: 2020-12-21T17:42:27.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-09T15:16:33.000Z (over 1 year ago)
- Last Synced: 2024-08-06T18:24:36.972Z (6 months ago)
- Topics: lua, neovim, terminal, vim
- Language: Lua
- Homepage:
- Size: 59.6 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neovim Terminal Manager
## Introduction
Tman.nvim is a terminal manager for Neovim, focused on running commands, tests, etc.
Inspird by `ThePrimeagen/harpoon` and emacs `compilation-mode`.
Works really well with the `vim-test` plugin as a [custom stratergy](https://github.com/Bhanukamax/tman.nvim/blob/master/README.md#use-as-a-vim-test-stratergy) to run tests using a single terminal buffer.
#### How to install
Add this to your packer or Lazy config
```lua
{
'Bhanukamax/tman.nvim',
}
```
### Setup
#### Lua
```lua
local tman = require('tman')
-- setup how the terminal buffer is displayed
-- Note: you don't need to do this if you are okay with using the defaults
tman.setup {
split = "bottom", -- supported values: "bottom", "right"
-- set width and height as a percentage of the terminal width and height
-- should be a integer between 1 to 100
width = 50, -- default is 50
height = 40, -- default is 40
}
```
#### Basic keybindings
```lua
-- This is my favourite way to toggle tman terminal, you don't have to care which mode you are in the terminal, just one keybind to toggle back and forth
vim.keymap.set("n", "", function () tman.toggleLast({insert = true}) end)
vim.keymap.set("t", "", tman.toggleLast)
```
### Advance Usage
Have a look at `:help tman.nvim` for complete API docs
toggle terminal from a specific side
```lua
-- toggle terminal from a specific side
vim.keymap.set("n", "tr", tman.toggleRight)
vim.keymap.set("n", "tb", tman.toggleBottom)
-- toggle terminal from the last open side
vim.keymap.set("n", "tt", tman.toggleLast)
```
#### Send commands interactively
##### Prompts to Send a command to the terminal
`:TmanCmd`
##### Resend the last command
`:TmanCmdLast`
These commands are useful when you want to run things like build commands, test runner commands, for example: `cargo build`, `go build`, etc.
##### How to use these
- When you run `:TmanCmd` it'll propmt for you to enter a command.
- Once you type in the command and press enter it'll open the Tman terminal and run the command you entered.
- You can also run `:TmanCmdLast` to resend the last command you ran.
One nice thing about using these commands is that you never have to go to insert mode in the terminal buffer, so you can just use these to run commands and navigate/visual select/yank text on terminal buffer without ever worrying about going between modes in the terminal buffer.
###### TmanCmd and TmanCmdLast in action
And they works best with some nice remaps like these:
```lua
vim.keymap.set("n", "tc", ":TmanCmd")
vim.keymap.set("n", "tn", ":TmanCmdLast") -- tl or tr would be a better mnemonic binding
```
###### TmanCmd and TmanCmdLast with remaps in action
#### Send commands programmatically
call to send some command to the terminal buffer
`require("tman").sendCommand(cmd, opts)`
cmd: string -> command to send
opts: table
- opts.split: "right" or "bottom": pass a split possition to override default when the command is executed
- opts.open: bool -> if true, open the terminal buffer (always opens if there is no previous terminal buffer)
- opts.pre: string -> a command to excute before the currend `cmd`
- opts.scrollTop: bool (default: true) -> scroll the prompt to top before executing the currently sent command, this is works better than sending `clear` as the `pre` command.
##### use gitk for the current file
```lua
local gitk_file = function()
local filename = vim.fn.expand('%')
local cmd = "gitk " .. filename .. "\r"
require("tman").sendCommand(cmd, {})
end
```
##### use as a vim-test stratergy
```lua
-- ~/.config/nvim/plugins/vim-test.lua (if using lazy.nvim as your plugin manager)
vim.cmd[[
function! Tman(cmd)
let g:cmd = a:cmd . "\n"
lua require("tman").sendCommand(vim.g.cmd, {open = true, split = "last"})
endfunction
let g:test#custom_strategies = {'tman': function('Tman')}
let g:test#strategy = 'tman'
]]
vim.keymap.set("n", "tf", ":TestFile")
vim.keymap.set("n", "ts", ":TestNearest")
vim.keymap.set("n", "tl", ":TestLast")
return {
'vim-test/vim-test',
cmd = {'TestNearest', 'TestFile', 'TestLast'},
dependencies = {
'Bhanukamax/tman.nvim',
}
}
```
##### open magit for the current working directory using emacsclient
```lua
local open_magit_status = function ()
tman.sendCommand('emacsclient -cn -e "(magit-status)" \r', {})
end
vim.keymap.set("n", "cgg", open_magit_status)
```
### Interacting with neovim terminal
- `neotermman` uses the neovim terminal,
- by defualt terminal buffer will open in the `terminal` mode which is similar to `normal` mode.
- to interact with the terminal you need to go into insert mode by pressing `i` key.
#### After using terminal
- to exit out of the insert mode in the terminal, you need to use the neovim terminal escape key sequence which is ``.
- since above key sequence is not very easy, you can rebind it to something else.
- I have found that C-x works best for me for this.
##### Lua
```lua
vim.keymap.set("t", "", "", {})
```