From 12c0a7441e6a18ee140b68cf8fc6d1c6468fd699 Mon Sep 17 00:00:00 2001 From: Luc Sinet Date: Mon, 26 Jul 2021 19:14:23 +0200 Subject: [PATCH] [Refactor] remove lv prefix (#1112) * Rename lv-utils into utils * Move commands defined in utils into core/commands.lua --- README.md | 2 +- init.lua | 5 +- lua/core/autocmds.lua | 2 +- lua/core/commands.lua | 21 +++++++ lua/core/which-key.lua | 2 +- lua/keymappings.lua | 12 ++-- lua/lsp/init.lua | 2 +- lua/{lv-utils => utils}/init.lua | 62 +++++++++------------ utils/installer/lv-config.example-no-ts.lua | 2 +- utils/installer/lv-config.example.lua | 2 +- 10 files changed, 62 insertions(+), 50 deletions(-) create mode 100644 lua/core/commands.lua rename lua/{lv-utils => utils}/init.lua (71%) diff --git a/README.md b/README.md index def17b97..09ca52bd 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ In case you want to see all the settings inside LunarVim, run the following: ```bash cd /tmp -lvim --headless +'lua require("lv-utils").generate_settings()' +qa && sort -o lv-settings.lua{,} +lvim --headless +'lua require("utils").generate_settings()' +qa && sort -o lv-settings.lua{,} ``` and then inspect `/tmp/lv-settings.lua` file diff --git a/init.lua b/init.lua index 1886e405..ae2dabe3 100644 --- a/init.lua +++ b/init.lua @@ -28,8 +28,11 @@ plugin_loader:load { plugins, lvim.plugins } vim.g.colors_name = lvim.colorscheme -- Colorscheme must get called after plugins are loaded or it will break new installs. vim.cmd("colorscheme " .. lvim.colorscheme) -local utils = require "lv-utils" +local utils = require "utils" utils.toggle_autoformat() +local commands = require "core.commands" +commands.load(commands.defaults) + require("lsp").setup_handlers() local null_status_ok, null_ls = pcall(require, "null-ls") diff --git a/lua/core/autocmds.lua b/lua/core/autocmds.lua index f4cb4369..d337f71a 100644 --- a/lua/core/autocmds.lua +++ b/lua/core/autocmds.lua @@ -27,7 +27,7 @@ lvim.autocommands = { "*", "setlocal formatoptions-=c formatoptions-=r formatoptions-=o", }, - { "BufWritePost", "lv-config.lua", "lua require('lv-utils').reload_lv_config()" }, + { "BufWritePost", "lv-config.lua", "lua require('utils').reload_lv_config()" }, { "FileType", "qf", diff --git a/lua/core/commands.lua b/lua/core/commands.lua new file mode 100644 index 00000000..c42b385d --- /dev/null +++ b/lua/core/commands.lua @@ -0,0 +1,21 @@ +local M = {} + +M.defaults = { + [[ + function! QuickFixToggle() + if empty(filter(getwininfo(), 'v:val.quickfix')) + copen + else + cclose + endif + endfunction + ]], +} + +M.load = function(commands) + for _, command in ipairs(commands) do + vim.cmd(command) + end +end + +return M diff --git a/lua/core/which-key.lua b/lua/core/which-key.lua index 55db694c..9d4e7744 100644 --- a/lua/core/which-key.lua +++ b/lua/core/which-key.lua @@ -95,7 +95,7 @@ M.config = function() name = "Packer", c = { "PackerCompile", "Compile" }, i = { "PackerInstall", "Install" }, - r = { "lua require('lv-utils').reload_lv_config()", "Reload" }, + r = { "lua require('utils').reload_lv_config()", "Reload" }, s = { "PackerSync", "Sync" }, u = { "PackerUpdate", "Update" }, }, diff --git a/lua/keymappings.lua b/lua/keymappings.lua index 5e09dc7d..c791418e 100644 --- a/lua/keymappings.lua +++ b/lua/keymappings.lua @@ -1,4 +1,4 @@ -local lv_utils = require "lv-utils" +local utils = require "utils" local opts = { nnoremap = { noremap = true, silent = true }, @@ -103,11 +103,11 @@ local function get_user_keys(mode) end end -lv_utils.add_keymap_normal_mode(opts.nnoremap, get_user_keys "normal_mode") -lv_utils.add_keymap_insert_mode(opts.inoremap, get_user_keys "insert_mode") -lv_utils.add_keymap_visual_mode(opts.vnoremap, get_user_keys "visual_mode") -lv_utils.add_keymap_visual_block_mode(opts.xnoremap, get_user_keys "visual_block_mode") -lv_utils.add_keymap_term_mode(opts.generic, get_user_keys "term_mode") +utils.add_keymap_normal_mode(opts.nnoremap, get_user_keys "normal_mode") +utils.add_keymap_insert_mode(opts.inoremap, get_user_keys "insert_mode") +utils.add_keymap_visual_mode(opts.vnoremap, get_user_keys "visual_mode") +utils.add_keymap_visual_block_mode(opts.xnoremap, get_user_keys "visual_block_mode") +utils.add_keymap_term_mode(opts.generic, get_user_keys "term_mode") -- navigate tab completion with and -- runs conditionally diff --git a/lua/lsp/init.lua b/lua/lsp/init.lua index 827753c6..75d2d3a6 100644 --- a/lua/lsp/init.lua +++ b/lua/lsp/init.lua @@ -301,7 +301,7 @@ end function lsp_config.setup(lang) local lang_server = lvim.lang[lang].lsp local provider = lang_server.provider - if require("lv-utils").check_lsp_client_active(provider) then + if require("utils").check_lsp_client_active(provider) then return end diff --git a/lua/lv-utils/init.lua b/lua/utils/init.lua similarity index 71% rename from lua/lv-utils/init.lua rename to lua/utils/init.lua index f76d0de2..94058487 100644 --- a/lua/lv-utils/init.lua +++ b/lua/utils/init.lua @@ -1,4 +1,4 @@ -local lv_utils = {} +local utils = {} -- recursive Print (structure, limit, separator) local function r_inspect_settings(structure, limit, separator) @@ -42,7 +42,7 @@ local function r_inspect_settings(structure, limit, separator) return limit - 1 end -function lv_utils.generate_settings() +function utils.generate_settings() -- Opens a file in append mode local file = io.open("lv-settings.lua", "w") @@ -57,7 +57,7 @@ function lv_utils.generate_settings() end -- autoformat -local toggle_autoformat = function() +function utils.toggle_autoformat() if lvim.format_on_save then require("core.autocmds").define_augroups { autoformat = { @@ -71,30 +71,28 @@ local toggle_autoformat = function() end if not lvim.format_on_save then - vim.cmd [[if exists('#autoformat#BufWritePre') - :autocmd! autoformat - endif]] + vim.cmd [[ + if exists('#autoformat#BufWritePre') + :autocmd! autoformat + endif + ]] end end -function lv_utils.toggle_autoformat() - toggle_autoformat() -end - -function lv_utils.reload_lv_config() +function utils.reload_lv_config() vim.cmd "source ~/.local/share/lunarvim/lvim/lua/settings.lua" vim.cmd "source ~/.config/lvim/lv-config.lua" vim.cmd "source ~/.local/share/lunarvim/lvim/lua/plugins.lua" local plugins = require "plugins" local plugin_loader = require("plugin-loader").init() - toggle_autoformat() + utils.toggle_autoformat() plugin_loader:load { plugins, lvim.plugins } vim.cmd ":PackerCompile" vim.cmd ":PackerInstall" -- vim.cmd ":PackerClean" end -function lv_utils.check_lsp_client_active(name) +function utils.check_lsp_client_active(name) local clients = vim.lsp.get_active_clients() for _, client in pairs(clients) do if client.name == name then @@ -104,38 +102,38 @@ function lv_utils.check_lsp_client_active(name) return false end -function lv_utils.add_keymap(mode, opts, keymaps) +function utils.add_keymap(mode, opts, keymaps) for _, keymap in ipairs(keymaps) do vim.api.nvim_set_keymap(mode, keymap[1], keymap[2], opts) end end -function lv_utils.add_keymap_normal_mode(opts, keymaps) - lv_utils.add_keymap("n", opts, keymaps) +function utils.add_keymap_normal_mode(opts, keymaps) + utils.add_keymap("n", opts, keymaps) end -function lv_utils.add_keymap_visual_mode(opts, keymaps) - lv_utils.add_keymap("v", opts, keymaps) +function utils.add_keymap_visual_mode(opts, keymaps) + utils.add_keymap("v", opts, keymaps) end -function lv_utils.add_keymap_visual_block_mode(opts, keymaps) - lv_utils.add_keymap("x", opts, keymaps) +function utils.add_keymap_visual_block_mode(opts, keymaps) + utils.add_keymap("x", opts, keymaps) end -function lv_utils.add_keymap_insert_mode(opts, keymaps) - lv_utils.add_keymap("i", opts, keymaps) +function utils.add_keymap_insert_mode(opts, keymaps) + utils.add_keymap("i", opts, keymaps) end -function lv_utils.add_keymap_term_mode(opts, keymaps) - lv_utils.add_keymap("t", opts, keymaps) +function utils.add_keymap_term_mode(opts, keymaps) + utils.add_keymap("t", opts, keymaps) end -function lv_utils.unrequire(m) +function utils.unrequire(m) package.loaded[m] = nil _G[m] = nil end -function lv_utils.gsub_args(args) +function utils.gsub_args(args) if args == nil or type(args) ~= "table" then return args end @@ -146,16 +144,6 @@ function lv_utils.gsub_args(args) return args end -vim.cmd [[ - function! QuickFixToggle() - if empty(filter(getwininfo(), 'v:val.quickfix')) - copen - else - cclose - endif -endfunction -]] - -return lv_utils +return utils -- TODO: find a new home for these autocommands diff --git a/utils/installer/lv-config.example-no-ts.lua b/utils/installer/lv-config.example-no-ts.lua index 9e56de51..ab12309d 100644 --- a/utils/installer/lv-config.example-no-ts.lua +++ b/utils/installer/lv-config.example-no-ts.lua @@ -18,7 +18,7 @@ lvim.leader = "space" -- {'', ':bprevious'}, -- } -- if you just want to augment the existing ones then use the utility function --- require("lv-utils").add_keymap_insert_mode({ silent = true }, { +-- require("utils").add_keymap_insert_mode({ silent = true }, { -- { "", ":w" }, -- { "", "" }, -- }) diff --git a/utils/installer/lv-config.example.lua b/utils/installer/lv-config.example.lua index f826dd7e..ef4e0645 100644 --- a/utils/installer/lv-config.example.lua +++ b/utils/installer/lv-config.example.lua @@ -26,7 +26,7 @@ lvim.leader = "space" -- {'', ':bprevious'}, -- } -- if you just want to augment the existing ones then use the utility function --- require("lv-utils").add_keymap_insert_mode({ silent = true }, { +-- require("utils").add_keymap_insert_mode({ silent = true }, { -- { "", ":w" }, -- { "", "" }, -- })