jaq-nvim
`jaq-nvim` is **J**ust **A**nother **Q**uickrun plugin for Neovim that was inspired by [quickrun.vim](https://github.com/D0n9X1n/quickrun.vim). In short, it is a plugin that lets you run the code of any language with a single command. ## Demo: | Type Info | Demonstration | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | Internal:Runs a vim command using `:`. |  | | Float:
Opens a floating window with `vim.api.nvim_open_win()` |  | | Terminal:
Opens a terminal with `:terminal` |  | | Bang:
Opens a small window with `:!` |  | | Quickfix:
Command output is placed in a quickfix window |  | ## Installation: #### [packer.nvim](https://github.com/wbthomason/packer.nvim): ```lua use {"is0n/jaq-nvim"} ``` ## Example Lua Config: ```lua require('jaq-nvim').setup{ cmds = { -- Uses vim commands internal = { lua = "luafile %", vim = "source %" }, -- Uses shell commands external = { markdown = "glow %", python = "python3 %", go = "go run %", sh = "sh %" } }, behavior = { -- Default type default = "float", -- Start in insert mode startinsert = false, -- Use `wincmd p` on startup wincmd = false, -- Auto-save files autosave = false }, ui = { float = { -- See ':h nvim_open_win' border = "none", -- See ':h winhl' winhl = "Normal", borderhl = "FloatBorder", -- See ':h winblend' winblend = 0, -- Num from `0-1` for measurements height = 0.8, width = 0.8, x = 0.5, y = 0.5 }, terminal = { -- Window position position = "bot", -- Window size size = 10, -- Disable line numbers line_no = false }, quickfix = { -- Window position position = "bot", -- Window size size = 10 } } } ``` ## Example JSON Config: ```json { "internal": { "lua": "luafile %", "vim": "source %" }, "external": { "markdown": "glow %", "python": "python3 %", "go": "go run %", "sh": "sh %" } } ``` In the current working directory, `Jaq` will search for a file called `.jaq.json`. This config file will be used for running commands, both external and internal. ## Usage: `:Jaq` by default uses the `float` type to run code. The default can be changed (see `Example Lua Config`). To use any other type, provide any of the arguments seen in `Demonstration`. Example: `:Jaq bang` The commands for `:Jaq` also have certain variables that can help in running code. You can put any of the following in `require('jaq-nvim').setup()` or `.jaq.json` ... - `%` / `$file` • Current File - `#` / `$altFile` • Alternate File - `$dir` • Current Working Directory - `$filePath` • Path to Current File - `$fileBase` • Basename of File (no extension) - `$moduleName` • Python Module Name
[](#madewithlua)
================================================
FILE: lua/jaq-nvim.lua
================================================
local M = {}
local config = {
cmds = {
internal = {},
external = {}
},
behavior = {
default = "float",
startinsert = false,
wincmd = false,
autosave = false
},
ui = {
float = {
border = "none",
winhl = "Normal",
borderhl = "FloatBorder",
height = 0.8,
width = 0.8,
x = 0.5,
y = 0.5,
winblend = 0
},
terminal = {
position = "bot",
line_no = false,
size = 10
},
quickfix = {
position = "bot",
size = 10
}
}
}
function M.setup(user_opts)
config = vim.tbl_deep_extend("force", config, user_opts)
end
local function dimensions(opts)
local cl = vim.o.columns
local ln = vim.o.lines
local width = math.ceil(cl * opts.ui.float.width)
local height = math.ceil(ln * opts.ui.float.height - 4)
local col = math.ceil((cl - width) * opts.ui.float.x)
local row = math.ceil((ln - height) * opts.ui.float.y - 1)
return {
width = width,
height = height,
col = col,
row = row
}
end
local function resize()
local dim = dimensions(config)
vim.api.nvim_win_set_config(M.win, {
style = "minimal",
relative = "editor",
border = config.ui.float.border,
height = dim.height,
width = dim.width,
col = dim.col,
row = dim.row
})
end
local function float(cmd)
local dim = dimensions(config)
function M.VimResized()
resize()
end
M.buf = vim.api.nvim_create_buf(false, true)
M.win = vim.api.nvim_open_win(M.buf, true, {
style = "minimal",
relative = "editor",
border = config.ui.float.border,
height = dim.height,
width = dim.width,
col = dim.col,
row = dim.row
})
vim.api.nvim_win_set_option(M.win, "winhl", ("Normal:%s"):format(config.ui.float.winhl))
vim.api.nvim_win_set_option(M.win, "winhl", ("FloatBorder:%s"):format(config.ui.float.borderhl))
vim.api.nvim_win_set_option(M.win, "winblend", config.ui.float.winblend)
vim.api.nvim_buf_set_option(M.buf, "filetype", "Jaq")
vim.api.nvim_buf_set_keymap(M.buf, 'n', '