greyjoy.nvim
is a pluggable pattern/file based launcher.
greyjoy uses vim.ui.select so the settings from (telescope, dressing etc.) menu will reflect it. The above example uses telescope.
Integration with toggleterm is also provided.
Neovim 0.9+ is required
{
ui = {
buffer = { -- width and height for the buffer output
width = math.ceil(math.min(vim.o.columns, math.max(80, vim.o.columns - 20))),
height = math.ceil(math.min(vim.o.lines, math.max(20, vim.o.lines - 10))),
},
toggleterm = { -- by default no size is defined for the toggleterm by
-- greyjoy.nvim it will be dependent on the user configured size for toggle
-- term.
size = nil,
}
},
toggleterm = {
-- default_group_id can be a number or a function that takes a string as parameter.
-- The string passed as parameter is the name of the plugin so its possible to do logic based
-- on plugin name and function should always return a number like:
-- default_group_id = function(plugin) return 1 end
default_group_id = 1,
},
enable = true,
border = "rounded", -- style for vim.ui.selector
style = "minimal",
show_command = false, -- show command to run in menu
show_command_in_output = true, -- show command that was just executed in output
patterns = {".git", ".svn"}, -- patterns to find the root of the project
output_result = "buffer", -- buffer or to toggleterm
extensions = {}, -- no extensions are loaded per default
last_first = false, -- make sure last option is first on next run, not persistant
run_groups = {}, -- no groups configured per default
}
Per default all plugins use the same terminal but this behaviour (if you are using toggleterm
) can be overridden by either grouping the plugins to a specific group_id
or create a function to assign number based on plugin name.
So if you want all plugins to run under id id
(default) but the docker_compose
you would like to have another group you can configure it via
extensions = {
docker_compose = { group_id = 2 },
},
and now all docker compose's exec is running in a secondary terminal (group_id 2) and all the others in group_id 1
Default greyjoy
does not have any extensions enabled.
generic
extension is a global module that does not take into account if we are in a project (found via the patterns). Commands to run can be matched using filetype
, filename
, filepath
example:
generic = {
commands = {
["run {filename}"] = {
command = {"python3", "{filename}"},
filetype = "python",
filename = "test.py"
},
["run {filename}"] = {
command = {"go", "run", "{filename}"},
filetype = "go"
}
...
}
},
The generic module can substitue current variables
variable | expands to |
---|---|
{filename} | current filename |
{filepath} | path of current file |
The above example is only triggered if a file is of type python
and the filename matches test.py
The makefile
extension is filebased and will only trigger if a Makefile
is located in the project root. It finds all targets for a Makefile
.
requires make
and awk
to work.
The vscode_tasks
extension is filebased and will only trigger if .vscode/tasks.json
exists in the project root
The kitchen
extension is also filebased and looks for .kitchen.yml
and requires kitchen
(from chefdk or cinc-workstation) + awk
to be installed.
This extension has a few config options like which kitchen
targets you want
Default is:
kitchen = {
targets = {"converge", "verify", "test", "destroy"}, -- targets
include_all = false, -- include all in list
}
NOTICE: kitchen is quite slow so its possible to create a group without it and only use it when needed
The cargo
extension is filebased and looks for Cargo.toml
and requires cargo
Default is:
cargo = {
targets = {
{"build"}, {"build", "--release"}, {"check"}, {"clean"},
{"update"}
}
}
The docker_compose
extension is filebased and looks for docker-compose.yml
and requires docker-compose
/docker compose
Default is:
docker_compose = {
cmd = "/usr/bin/docker-compose", -- can be replaced with /usr/bin/docker compose
shell = "/bin/bash"
}
using packer
use({"desdic/greyjoy.nvim",
config = function()
local greyjoy = require("greyjoy")
greyjoy.setup({
output_results = "toggleterm",
last_first = true,
extensions = {
generic = {
commands = {
["run test.py"] = {
command = {"./test.py"},
filetype = "python"
},
["run {filename}"] = {
command = {"go", "run", "{filename}"},
filetype = "go"
}
}
},
kitchen = {
targets = {"converge", "verify"},
include_all = false,
}
},
run_groups = {
fast = {"generic", "makefile", "cargo"},
}
})
greyjoy.load_extension("generic")
greyjoy.load_extension("vscode_tasks")
greyjoy.load_extension("makefile")
greyjoy.load_extension("kitchen")
greyjoy.load_extension("cargo")
greyjoy.load_extension("docker_compose")
end
})
Once installed and reloaded you can use :Greyjoy
to run it or Greyjoy <pluginname or group name>
.
So in the above example its possible to run the generic and makefile plugin by running :Greyjoy fast
or if you only wanted to run the makefile plugin you could do :Greyjoy makefile
Once installed make sure you run :checkhealth greyjoy
to ensure its set up correctly.
Breaking changes will be announced in this Github Issue
Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:
git checkout -b my-new-feature
)git commit -am 'Added some feature'
)git push origin my-new-feature
)Thank you @TheSafdarAwan for PR #22