tiyn/action-hints.nvim
1
0
Fork 0
mirror of https://github.com/tiyn/action-hints.nvim.git synced 2025-11-13 13:59:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Breaking: Rename plugin

Browse Source
This commit is contained in:
Rob Wilson
2023-08-12 01:49:57 +01:00
parent 24fdc0a15c
commit 4befaca8f8
2 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -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 - go-to-definition (`gd`) is available
- reference list (`gr`) available / number of references - reference list (`gr`) available / number of references
@@ -15,9 +15,9 @@ Available statusline hints:
```lua ```lua
{ {
"roobert/statusline-action-hints.nvim", "roobert/action-hints.nvim",
config = function() config = function()
require("statusline-action-hints").setup() require("action-hints").setup()
end, end,
}, },
``` ```
@@ -26,9 +26,9 @@ Available statusline hints:
```lua ```lua
use({ use({
"roobert/statusline-action-hints.nvim", "roobert/action-hints.nvim",
config = function() config = function()
require("statusline-action-hints").setup() require("action-hints").setup()
end, end,
}) })
``` ```
@@ -37,12 +37,12 @@ use({
```lua ```lua
{ {
"roobert/statusline-action-hints.nvim", "roobert/action-hints.nvim",
config = function() config = function()
require("statusline-action-hints").setup({ require("action-hints").setup({
template = { template = {
{ " ⊛", "StatuslineActionHintsDefinition" }, { " ⊛", "ActionHintsDefinition" },
{ " ↱%s", "StatuslineActionHintsReferences" }, { " ↱%s", "ActionHintsReferences" },
}, },
use_virtual_text = true, use_virtual_text = true,
}) })
@@ -53,8 +53,8 @@ use({
Adjust highlight colours for virtual text: Adjust highlight colours for virtual text:
``` ```
highlight StatuslineActionHintsDefinition guifg=#add8e6 highlight ActionHintsDefinition guifg=#add8e6
highlight StatuslineActionHintsReferences guifg=#ff6666 highlight ActionHintsReferences guifg=#ff6666
``` ```
## Usage ## 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 Note that for now the component must be included in the lualine for the virtual text to
be updated. be updated.
As a lualine statusline component: As a lualine component:
```lua ```lua
require('lualine').setup { require('lualine').setup {
sections = { sections = {
lualine_x = { require("statusline-action-hints").statusline }, lualine_x = { require("action-hints").statusline },
} }
} }
``` ```

14
lua/statusline-action-hints/init.lua → lua/action-hints/init.lua
View File

@@ -2,8 +2,8 @@ local M = {}
M.config = { M.config = {
template = { template = {
{ " ⊛", "StatuslineActionHintsDefinition" }, { " ⊛", "ActionHintsDefinition" },
{ " ↱%s", "StatuslineActionHintsReferences" }, { " ↱%s", "ActionHintsReferences" },
}, },
use_virtual_text = false, use_virtual_text = false,
} }
@@ -133,8 +133,8 @@ M.statusline = function()
local definition_status = M.definition_available and " ⊛" or "" local definition_status = M.definition_available and " ⊛" or ""
local reference_status = M.reference_count > 0 and " ↱" .. tostring(M.reference_count) or "" local reference_status = M.reference_count > 0 and " ↱" .. tostring(M.reference_count) or ""
local chunks = { local chunks = {
{ definition_status, "StatuslineActionHintsDefinition" }, { definition_status, "ActionHintsDefinition" },
{ reference_status, "StatuslineActionHintsReferences" }, { reference_status, "ActionHintsReferences" },
} }
if M.config.use_virtual_text then if M.config.use_virtual_text then
@@ -161,9 +161,9 @@ M.setup = function(options)
M.config[k] = v M.config[k] = v
end end
-- Set default colors for StatuslineActionHintsDefinition and StatuslineActionHintsReferences -- Set default colors for ActionHintsDefinition and ActionHintsReferences
vim.api.nvim_command("highlight StatuslineActionHintsDefinition guifg=#add8e6") vim.api.nvim_command("highlight ActionHintsDefinition guifg=#add8e6")
vim.api.nvim_command("highlight StatuslineActionHintsReferences guifg=#ff6666") vim.api.nvim_command("highlight ActionHintsReferences guifg=#ff6666")
end end
return M return M