feat: add function to get visible state

[DrummyFloyd]

pretty usefull when u want to ad some stuff upon state

allow to do something like this

-- Plugin configuration
return {
  {
    "DrummyFloyd/precognition.nvim",
    event = "VeryLazy",
    branch = "add-visble-getter",
    opts = {
      startVisible = false,
    },
    keys = function()
      local p = require("precognition")
      LazyVim.toggle.map("<leader>uP", {
        name = "Precognition",
        get = function()
          return p.visibleState()
        end,
        set = function()
          p.toggle()
        end,
      })
    end,
  },
}

[tris203]

Thanks for the PR @DrummyFloyd

I don't use LazyVim the distro. Do you have any links for the benefits of this.

The toggle function returns the status so couldn't this be encapsulated with a local within the keys function within config?

[DrummyFloyd]

Thanks for the PR @DrummyFloyd

I don't use LazyVim the distro. Do you have any links for the benefits of this.

The toggle function returns the status so couldn't this be encapsulated with a local within the keys function within config?

=> yes ofc i could do this instead

it's more or less a whim (purely UI stuff, if you don't want this getter i totally understand, even if, it could be always usefull in other cases) :D

becasue Folke (Creator of Many nVim stuff ) , introduced a LazyVim.toggle function which lead to an icon for off/sate

and the get function use a bool value for the state

[tris203]

I requested changes in a previous PR about this same issue

#73 (review)

I will think about this

[tris203]

I have given this some thought and the best middle ground is to expose it via the metatable, meaning there is no additional overhead to maintain, but the function/value is available.

If you are happy to modify this PR to do it that, I would be happy to accept it. @DrummyFloyd

[DrummyFloyd]

I have given this some thought and the best middle ground is to expose it via the metatable, meaning there is no additional overhead to maintain, but the function/value is available.

If you are happy to modify this PR to do it that, I would be happy to accept it. @DrummyFloyd

so you mean somethings like this ? ( not very aware of LUA good practice )

diff --git a/lua/precognition/init.lua b/lua/precognition/init.lua
index bbd18ddf0cb1..0b51ce425050 100644
--- a/lua/precognition/init.lua
+++ b/lua/precognition/init.lua
@@ -324,7 +324,7 @@ local function create_command()
         toggle = M.toggle,
         show = M.show,
         hide = M.hide,
-        visibleState = M.visibleState,
+        visibleState = visible,
     }
 
     local function execute(args)
@@ -396,11 +396,6 @@ function M.show()
     display_marks()
 end
 
---- Return the current visibility state
-function M.visibleState()
-    return visible
-end
-
 --- Disable automatic showing of hints
 function M.hide()
     if not visible then

[tris203]

no, you would just add something like

    is_visible = function()
        return visible
    end,

around line 467

all the other changes can be reverted