venn.nvim
Draw ASCII diagrams in Neovim.
Installation
Install using your prefered method:
Plug 'jbyuki/venn.nvim'use "jbyuki/venn.nvim"Usage
-
set virtualedit=allorset ve=all. This will allow you to freely move the cursor in the buffer. (seehelp virtualedit). -
Enter in Visual Block mode using
<C-v>. Select the region where the box should be. -
Invoke
:VBox. This will draw a rectangle. In case, it has a width or a height of 1, it will draw a line.
Key Mapping
Using hydra.nvim
Using toggle command
You can map :VBox commands to allow different ways of drawing lines.
Use the following function in your neovim config to toggle drawing lines on HJKL directional keys to allow for faster creation of diagrams:
-- venn.nvim: enable or disable keymappings
function _G.Toggle_venn()
local venn_enabled = vim.inspect(vim.b.venn_enabled)
if venn_enabled == "nil" then
vim.b.venn_enabled = true
vim.cmd[[setlocal ve=all]]
-- draw a line on HJKL keystokes
vim.api.nvim_buf_set_keymap(0, "n", "J", "<C-v>j:VBox<CR>", {noremap = true})
vim.api.nvim_buf_set_keymap(0, "n", "K", "<C-v>k:VBox<CR>", {noremap = true})
vim.api.nvim_buf_set_keymap(0, "n", "L", "<C-v>l:VBox<CR>", {noremap = true})
vim.api.nvim_buf_set_keymap(0, "n", "H", "<C-v>h:VBox<CR>", {noremap = true})
-- draw a box by pressing "f" with visual selection
vim.api.nvim_buf_set_keymap(0, "v", "f", ":VBox<CR>", {noremap = true})
else
vim.cmd[[setlocal ve=]]
vim.cmd[[mapclear <buffer>]]
vim.b.venn_enabled = nil
end
end
-- toggle keymappings for venn using <leader>v
vim.api.nvim_set_keymap('n', '<leader>v', ":lua Toggle_venn()<CR>", { noremap = true})