mirror of
https://github.com/aminnairi/dotfiles.git
synced 2026-09-14 12:12:13 +02:00
initial commit
This commit is contained in:
aminnairi
@@ -0,0 +1,257 @@
|
||||
--- ### AstroNvim Utilities
|
||||
--
|
||||
-- Various utility functions to use within AstroNvim and user configurations.
|
||||
--
|
||||
-- This module can be loaded with `local utils = require "astronvim.utils"`
|
||||
--
|
||||
-- @module astronvim.utils
|
||||
-- @copyright 2022
|
||||
-- @license GNU General Public License v3.0
|
||||
|
||||
local M = {}
|
||||
|
||||
--- Merge extended options with a default table of options
|
||||
-- @param default the default table that you want to merge into
|
||||
-- @param opts the new options that should be merged with the default table
|
||||
-- @return the merged table
|
||||
function M.extend_tbl(default, opts)
|
||||
opts = opts or {}
|
||||
return default and vim.tbl_deep_extend("force", default, opts) or opts
|
||||
end
|
||||
|
||||
--- Insert one or more values into a list like table and maintain that you do not insert non-unique values (THIS MODIFIES `lst`)
|
||||
-- @param lst the list like table that you want to insert into
|
||||
-- @param vals either a list like table of values to be inserted or a single value to be inserted
|
||||
-- @return the modified list like table
|
||||
function M.list_insert_unique(lst, vals)
|
||||
assert(vim.tbl_islist(lst), "Provided table is not a list like table")
|
||||
if not vim.tbl_islist(vals) then vals = { vals } end
|
||||
for _, val in ipairs(vals) do
|
||||
if not vim.tbl_contains(lst, val) then table.insert(lst, val) end
|
||||
end
|
||||
return lst
|
||||
end
|
||||
|
||||
--- Call function if a condition is met
|
||||
-- @param func the function to run
|
||||
-- @param condition a boolean value of whether to run the function or not
|
||||
function M.conditional_func(func, condition, ...)
|
||||
-- if the condition is true or no condition is provided, evaluate the function with the rest of the parameters and return the result
|
||||
if condition and type(func) == "function" then return func(...) end
|
||||
end
|
||||
|
||||
--- Get an icon from `lspkind` if it is available and return it
|
||||
-- @param kind the kind of icon in `lspkind` to retrieve
|
||||
-- @return the icon
|
||||
function M.get_icon(kind)
|
||||
local icon_pack = vim.g.icons_enabled and "icons" or "text_icons"
|
||||
if not M[icon_pack] then
|
||||
M.icons = astronvim.user_opts("icons", require "astronvim.icons.nerd_font")
|
||||
M.text_icons = astronvim.user_opts("text_icons", require "astronvim.icons.text")
|
||||
end
|
||||
return M[icon_pack] and M[icon_pack][kind] or ""
|
||||
end
|
||||
|
||||
--- Get highlight properties for a given highlight name
|
||||
-- @param name highlight group name
|
||||
-- @return table of highlight group properties
|
||||
function M.get_hlgroup(name, fallback)
|
||||
if vim.fn.hlexists(name) == 1 then
|
||||
local hl
|
||||
if vim.api.nvim_get_hl then -- check for new neovim 0.9 API
|
||||
hl = vim.api.nvim_get_hl(0, { name = name, link = false })
|
||||
if not hl.fg then hl.fg = "NONE" end
|
||||
if not hl.bg then hl.bg = "NONE" end
|
||||
else
|
||||
hl = vim.api.nvim_get_hl_by_name(name, vim.o.termguicolors)
|
||||
if not hl.foreground then hl.foreground = "NONE" end
|
||||
if not hl.background then hl.background = "NONE" end
|
||||
hl.fg, hl.bg = hl.foreground, hl.background
|
||||
hl.ctermfg, hl.ctermbg = hl.fg, hl.bg
|
||||
hl.sp = hl.special
|
||||
end
|
||||
return hl
|
||||
end
|
||||
return fallback
|
||||
end
|
||||
|
||||
--- Serve a notification with a title of AstroNvim
|
||||
-- @param msg the notification body
|
||||
-- @param type the type of the notification (:help vim.log.levels)
|
||||
-- @param opts table of nvim-notify options to use (:help notify-options)
|
||||
function M.notify(msg, type, opts)
|
||||
vim.schedule(function() vim.notify(msg, type, M.extend_tbl({ title = "AstroNvim" }, opts)) end)
|
||||
end
|
||||
|
||||
--- Trigger an AstroNvim user event
|
||||
-- @param event the event name to be appended to Astro
|
||||
function M.event(event)
|
||||
vim.schedule(function() vim.api.nvim_exec_autocmds("User", { pattern = "Astro" .. event }) end)
|
||||
end
|
||||
|
||||
--- Open a URL under the cursor with the current operating system
|
||||
-- @param path the path of the file to open with the system opener
|
||||
function M.system_open(path)
|
||||
local cmd
|
||||
if vim.fn.has "win32" == 1 and vim.fn.executable "explorer" == 1 then
|
||||
cmd = { "cmd.exe", "/K", "explorer" }
|
||||
elseif vim.fn.has "unix" == 1 and vim.fn.executable "xdg-open" == 1 then
|
||||
cmd = { "xdg-open" }
|
||||
elseif (vim.fn.has "mac" == 1 or vim.fn.has "unix" == 1) and vim.fn.executable "open" == 1 then
|
||||
cmd = { "open" }
|
||||
end
|
||||
if not cmd then M.notify("Available system opening tool not found!", "error") end
|
||||
vim.fn.jobstart(vim.fn.extend(cmd, { path or vim.fn.expand "<cfile>" }), { detach = true })
|
||||
end
|
||||
|
||||
-- term_details can be either a string for just a command or
|
||||
-- a complete table to provide full access to configuration when calling Terminal:new()
|
||||
|
||||
--- Toggle a user terminal if it exists, if not then create a new one and save it
|
||||
-- @param term_details a terminal command string or a table of options for Terminal:new() (Check toggleterm.nvim documentation for table format)
|
||||
function M.toggle_term_cmd(opts)
|
||||
local terms = astronvim.user_terminals
|
||||
-- if a command string is provided, create a basic table for Terminal:new() options
|
||||
if type(opts) == "string" then opts = { cmd = opts, hidden = true } end
|
||||
local num = vim.v.count > 0 and vim.v.count or 1
|
||||
-- if terminal doesn't exist yet, create it
|
||||
if not terms[opts.cmd] then terms[opts.cmd] = {} end
|
||||
if not terms[opts.cmd][num] then
|
||||
if not opts.count then opts.count = vim.tbl_count(terms) * 100 + num end
|
||||
if not opts.on_exit then opts.on_exit = function() terms[opts.cmd][num] = nil end end
|
||||
terms[opts.cmd][num] = require("toggleterm.terminal").Terminal:new(opts)
|
||||
end
|
||||
-- toggle the terminal
|
||||
terms[opts.cmd][num]:toggle()
|
||||
end
|
||||
|
||||
--- Create a button entity to use with the alpha dashboard
|
||||
-- @param sc the keybinding string to convert to a button
|
||||
-- @param txt the explanation text of what the keybinding does
|
||||
-- @return a button entity table for an alpha configuration
|
||||
function M.alpha_button(sc, txt)
|
||||
-- replace <leader> in shortcut text with LDR for nicer printing
|
||||
local sc_ = sc:gsub("%s", ""):gsub("LDR", "<leader>")
|
||||
-- if the leader is set, replace the text with the actual leader key for nicer printing
|
||||
if vim.g.mapleader then sc = sc:gsub("LDR", vim.g.mapleader == " " and "SPC" or vim.g.mapleader) end
|
||||
-- return the button entity to display the correct text and send the correct keybinding on press
|
||||
return {
|
||||
type = "button",
|
||||
val = txt,
|
||||
on_press = function()
|
||||
local key = vim.api.nvim_replace_termcodes(sc_, true, false, true)
|
||||
vim.api.nvim_feedkeys(key, "normal", false)
|
||||
end,
|
||||
opts = {
|
||||
position = "center",
|
||||
text = txt,
|
||||
shortcut = sc,
|
||||
cursor = 5,
|
||||
width = 36,
|
||||
align_shortcut = "right",
|
||||
hl = "DashboardCenter",
|
||||
hl_shortcut = "DashboardShortcut",
|
||||
},
|
||||
}
|
||||
end
|
||||
|
||||
--- Check if a plugin is defined in lazy. Useful with lazy loading when a plugin is not necessarily loaded yet
|
||||
-- @param plugin the plugin string to search for
|
||||
-- @return boolean value if the plugin is available
|
||||
function M.is_available(plugin)
|
||||
local lazy_config_avail, lazy_config = pcall(require, "lazy.core.config")
|
||||
return lazy_config_avail and lazy_config.plugins[plugin] ~= nil
|
||||
end
|
||||
|
||||
--- A helper function to wrap a module function to require a plugin before running
|
||||
-- @param plugin the plugin string to call `require("lazy").load` with
|
||||
-- @param module the system module where the functions live (e.g. `vim.ui`)
|
||||
-- @param func_names a string or a list like table of strings for functions to wrap in the given module (e.g. `{ "ui", "select }`)
|
||||
function M.load_plugin_with_func(plugin, module, func_names)
|
||||
if type(func_names) == "string" then func_names = { func_names } end
|
||||
for _, func in ipairs(func_names) do
|
||||
local old_func = module[func]
|
||||
module[func] = function(...)
|
||||
module[func] = old_func
|
||||
require("lazy").load { plugins = { plugin } }
|
||||
module[func](...)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--- Register queued which-key mappings
|
||||
function M.which_key_register()
|
||||
if M.which_key_queue then
|
||||
local wk_avail, wk = pcall(require, "which-key")
|
||||
if wk_avail then
|
||||
for mode, registration in pairs(M.which_key_queue) do
|
||||
wk.register(registration, { mode = mode })
|
||||
end
|
||||
M.which_key_queue = nil
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--- Table based API for setting keybindings
|
||||
-- @param map_table A nested table where the first key is the vim mode, the second key is the key to map, and the value is the function to set the mapping to
|
||||
-- @param base A base set of options to set on every keybinding
|
||||
function M.set_mappings(map_table, base)
|
||||
-- iterate over the first keys for each mode
|
||||
base = base or {}
|
||||
for mode, maps in pairs(map_table) do
|
||||
-- iterate over each keybinding set in the current mode
|
||||
for keymap, options in pairs(maps) do
|
||||
-- build the options for the command accordingly
|
||||
if options then
|
||||
local cmd = options
|
||||
local keymap_opts = base
|
||||
if type(options) == "table" then
|
||||
cmd = options[1]
|
||||
keymap_opts = vim.tbl_deep_extend("force", keymap_opts, options)
|
||||
keymap_opts[1] = nil
|
||||
end
|
||||
if not cmd or keymap_opts.name then -- if which-key mapping, queue it
|
||||
if not M.which_key_queue then M.which_key_queue = {} end
|
||||
if not M.which_key_queue[mode] then M.which_key_queue[mode] = {} end
|
||||
M.which_key_queue[mode][keymap] = keymap_opts
|
||||
else -- if not which-key mapping, set it
|
||||
vim.keymap.set(mode, keymap, cmd, keymap_opts)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
if package.loaded["which-key"] then M.which_key_register() end -- if which-key is loaded already, register
|
||||
end
|
||||
|
||||
--- regex used for matching a valid URL/URI string
|
||||
local url_matcher =
|
||||
"\\v\\c%(%(h?ttps?|ftp|file|ssh|git)://|[a-z]+[@][a-z]+[.][a-z]+:)%([&:#*@~%_\\-=?!+;/0-9a-z]+%(%([.;/?]|[.][.]+)[&:#*@~%_\\-=?!+/0-9a-z]+|:\\d+|,%(%(%(h?ttps?|ftp|file|ssh|git)://|[a-z]+[@][a-z]+[.][a-z]+:)@![0-9a-z]+))*|\\([&:#*@~%_\\-=?!+;/.0-9a-z]*\\)|\\[[&:#*@~%_\\-=?!+;/.0-9a-z]*\\]|\\{%([&:#*@~%_\\-=?!+;/.0-9a-z]*|\\{[&:#*@~%_\\-=?!+;/.0-9a-z]*})\\})+"
|
||||
|
||||
--- Delete the syntax matching rules for URLs/URIs if set
|
||||
function M.delete_url_match()
|
||||
for _, match in ipairs(vim.fn.getmatches()) do
|
||||
if match.group == "HighlightURL" then vim.fn.matchdelete(match.id) end
|
||||
end
|
||||
end
|
||||
|
||||
--- Add syntax matching rules for highlighting URLs/URIs
|
||||
function M.set_url_match()
|
||||
M.delete_url_match()
|
||||
if vim.g.highlighturl_enabled then vim.fn.matchadd("HighlightURL", url_matcher, 15) end
|
||||
end
|
||||
|
||||
--- Run a shell command and capture the output and if the command succeeded or failed
|
||||
-- @param cmd the terminal command to execute
|
||||
-- @param show_error boolean of whether or not to show an unsuccessful command as an error to the user
|
||||
-- @return the result of a successfully executed command or nil
|
||||
function M.cmd(cmd, show_error)
|
||||
if vim.fn.has "win32" == 1 then cmd = { "cmd.exe", "/C", cmd } end
|
||||
local result = vim.fn.system(cmd)
|
||||
local success = vim.api.nvim_get_vvar "shell_error" == 0
|
||||
if not success and (show_error == nil or show_error) then
|
||||
vim.api.nvim_err_writeln("Error running command: " .. cmd .. "\nError message:\n" .. result)
|
||||
end
|
||||
return success and result:gsub("[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]", "") or nil
|
||||
end
|
||||
|
||||
return M
|
||||
Reference in New Issue
Block a user