From 4befaca8f80b51e2b5b3936ed74dd173bfb6e5f9 Mon Sep 17 00:00:00 2001 From: Rob Wilson Date: Sat, 12 Aug 2023 01:49:57 +0100 Subject: [PATCH] Breaking: Rename plugin --- README.md | 32 +++++++++---------- .../init.lua | 14 ++++---- 2 files changed, 23 insertions(+), 23 deletions(-) rename lua/{statusline-action-hints => action-hints}/init.lua (88%) diff --git a/README.md b/README.md index a683b05..a074bcf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# :zap: Statusline Action Hints +# :zap: Action Hints -![statusline-action-hints screenshot](https://user-images.githubusercontent.com/226654/217480442-ae97682d-c2e1-4dc3-a9d6-7d646ca4d025.gif) +![action-hints screenshot](https://user-images.githubusercontent.com/226654/217480442-ae97682d-c2e1-4dc3-a9d6-7d646ca4d025.gif) -A Neovim plugin to show statusline information about the word under the cursor. +A Neovim plugin to show information about the word under the cursor. -Available statusline hints: +Available hints: - go-to-definition (`gd`) is available - reference list (`gr`) available / number of references @@ -15,9 +15,9 @@ Available statusline hints: ```lua { - "roobert/statusline-action-hints.nvim", + "roobert/action-hints.nvim", config = function() - require("statusline-action-hints").setup() + require("action-hints").setup() end, }, ``` @@ -26,9 +26,9 @@ Available statusline hints: ```lua use({ - "roobert/statusline-action-hints.nvim", + "roobert/action-hints.nvim", config = function() - require("statusline-action-hints").setup() + require("action-hints").setup() end, }) ``` @@ -37,12 +37,12 @@ use({ ```lua { - "roobert/statusline-action-hints.nvim", + "roobert/action-hints.nvim", config = function() - require("statusline-action-hints").setup({ + require("action-hints").setup({ template = { - { " ⊛", "StatuslineActionHintsDefinition" }, - { " ↱%s", "StatuslineActionHintsReferences" }, + { " ⊛", "ActionHintsDefinition" }, + { " ↱%s", "ActionHintsReferences" }, }, use_virtual_text = true, }) @@ -53,8 +53,8 @@ use({ Adjust highlight colours for virtual text: ``` -highlight StatuslineActionHintsDefinition guifg=#add8e6 -highlight StatuslineActionHintsReferences guifg=#ff6666 +highlight ActionHintsDefinition guifg=#add8e6 +highlight ActionHintsReferences guifg=#ff6666 ``` ## Usage @@ -62,12 +62,12 @@ highlight StatuslineActionHintsReferences guifg=#ff6666 Note that for now the component must be included in the lualine for the virtual text to be updated. -As a lualine statusline component: +As a lualine component: ```lua require('lualine').setup { sections = { - lualine_x = { require("statusline-action-hints").statusline }, + lualine_x = { require("action-hints").statusline }, } } ``` diff --git a/lua/statusline-action-hints/init.lua b/lua/action-hints/init.lua similarity index 88% rename from lua/statusline-action-hints/init.lua rename to lua/action-hints/init.lua index 73b28b3..306e0ed 100644 --- a/lua/statusline-action-hints/init.lua +++ b/lua/action-hints/init.lua @@ -2,8 +2,8 @@ local M = {} M.config = { template = { - { " ⊛", "StatuslineActionHintsDefinition" }, - { " ↱%s", "StatuslineActionHintsReferences" }, + { " ⊛", "ActionHintsDefinition" }, + { " ↱%s", "ActionHintsReferences" }, }, use_virtual_text = false, } @@ -133,8 +133,8 @@ M.statusline = function() local definition_status = M.definition_available and " ⊛" or "" local reference_status = M.reference_count > 0 and " ↱" .. tostring(M.reference_count) or "" local chunks = { - { definition_status, "StatuslineActionHintsDefinition" }, - { reference_status, "StatuslineActionHintsReferences" }, + { definition_status, "ActionHintsDefinition" }, + { reference_status, "ActionHintsReferences" }, } if M.config.use_virtual_text then @@ -161,9 +161,9 @@ M.setup = function(options) M.config[k] = v end - -- Set default colors for StatuslineActionHintsDefinition and StatuslineActionHintsReferences - vim.api.nvim_command("highlight StatuslineActionHintsDefinition guifg=#add8e6") - vim.api.nvim_command("highlight StatuslineActionHintsReferences guifg=#ff6666") + -- Set default colors for ActionHintsDefinition and ActionHintsReferences + vim.api.nvim_command("highlight ActionHintsDefinition guifg=#add8e6") + vim.api.nvim_command("highlight ActionHintsReferences guifg=#ff6666") end return M