Skip to content

README.md

Latest commit

 

History

History
81 lines (60 loc) · 2.6 KB

README.md

File metadata and controls

81 lines (60 loc) · 2.6 KB

Neovim Smart Terminal Tplit

Features

  • Automatic Terminal Buffer Closure: Automatically closes terminal buffers upon exit, keeping the workspace clean. Will become unnecessary in future releases of Neovim.
  • Context Preservation: For Unix/Linux users, terminals opened through splits will automatically navigate to the working directory of the current buffer, ensuring a seamless workflow.

Installation

To install this plugin using lazy.nvim, add the following configuration to your Neovim setup:

require("lazy").setup({
    {
        'jam1015/nvim_smart_termsplit',
        config = function()
            require('nvim_smart_termsplit').setup()
        end
    }
})

Usage

After installation, the plugin provides two new commands within Neovim to manage terminal splits:

  • :Tsplit - Opens a new terminal in a horizontal split.
  • :Tvsplit - Opens a new terminal in a vertical split.

Additionally, you can bind keyboard shortcuts to these actions for even quicker access:

Configuration

local opts = { remap = false, silent = true }
local keymap = vim.keymap.set
keymap("n", "<C-w>s", require('nvim_smart_termsplit').term_hsplit, opts)
keymap("t", "<C-w>s", require('nvim_smart_termsplit').term_hsplit, opts)
keymap("n", "<C-w>v", require('nvim_smart_termsplit').term_vsplit, opts)
keymap("t", "<C-w>v", require('nvim_smart_termsplit').term_vsplit, opts)
keymap("n", "<C-w>t", require('nvim_smart_termsplit').term_tabnew, opts)
keymap("t", "<C-w>t", require('nvim_smart_termsplit').term_tabnew, opts)
-- Fallback to built-in window commands if needed
keymap("n", "<C-w><C-s>", "<C-w>s", opts)
keymap("t", "<C-w><C-s>", "<C-\\><C-n><C-w>s", opts)
keymap("n", "<C-w><C-v>", "<C-w>v", opts)
keymap("t", "<C-w><C-v>", "<C-\\><C-n><C-w>v", opts)
keymap("n", "<C-w><C-t>", "<C-w>T", opts)
keymap("t", "<C-w><C-t>", "<C-\\><C-n><C-w>T", opts)

Other helpful Configuration

local keymap = vim.keymap.set

-- generally easier prefix for window related commands
keymap("n", "<C-a>", "<C-w>", { remap = true, silent = true })

-- switches windows from terminal mode. <C-\><C-n> goes to normal mode from terminal mode
keymap("t", "<C-a>", "<C-\\><C-n><C-a>", { remap = true, silent = true })

-- to do splits from terminal mode without using this plugin
keymap("t", "<C-w>", "<C-\\><C-n><C-w>", { remap = true, silent = true })

Note that remap = true allows these mappings to act as prefixes.

License

This project is licensed under the GNU General Public License v3.0. For more information, see the LICENSE file in the repository.