Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/is0n/jaq-nvim
⚙️ Just Another Quickrun Plugin for Neovim in Lua
https://github.com/is0n/jaq-nvim
lua neovim
Last synced: about 2 months ago
JSON representation
⚙️ Just Another Quickrun Plugin for Neovim in Lua
- Host: GitHub
- URL: https://github.com/is0n/jaq-nvim
- Owner: is0n
- License: gpl-3.0
- Created: 2021-10-30T23:48:59.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T02:25:26.000Z (5 months ago)
- Last Synced: 2024-07-31T20:51:12.671Z (4 months ago)
- Topics: lua, neovim
- Language: Lua
- Homepage:
- Size: 543 KB
- Stars: 176
- Watchers: 2
- Forks: 16
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - is0n/jaq-nvim - Just Another Quickrun Plugin in Lua. (Code Runner / Quickfix)
README
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)