feat: hide scopes in scopes window

Author: cbochs

lua/grapple.lua

@@ -577,12 +577,14 @@ function Grapple.toggle_scopes()
 end
 
 ---Open a floating window populated with all defined scopes
-function Grapple.open_scopes()
+---@param opts? { all: boolean }
+function Grapple.open_scopes(opts)
     local ScopeContent = require("grapple.scope_content")
     local App = require("grapple.app")
     local app = App.get()
 
-    local content = ScopeContent:new(app, app.settings.scope_hook, app.settings.scope_title)
+    local show_all = opts and opts.all or false
+    local content = ScopeContent:new(app, app.settings.scope_hook, app.settings.scope_title, show_all)
 
     open(content)
 end
@@ -705,7 +707,7 @@ function Grapple.initialize()
                     tag            = { args = {},              kwargs = new_kwargs },
                     toggle         = { args = {},              kwargs = tag_kwargs },
                     toggle_loaded  = { args = {},              kwargs = { "all" } },
-                    toggle_scopes  = { args = {},              kwargs = {} },
+                    toggle_scopes  = { args = {},              kwargs = { "all" } },
                     toggle_tags    = { args = {},              kwargs = window_kwargs },
                     unload         = { args = {},              kwargs = scope_kwargs },
                     untag          = { args = {},              kwargs = use_kwargs },

lua/grapple/app.lua

@@ -75,6 +75,7 @@ function App:define_scope(definition)
         desc = definition.desc,
         fallback = definition.fallback,
         cache = definition.cache,
+        hidden = definition.hidden,
     })
 end
 

lua/grapple/container_actions.lua

@@ -29,10 +29,9 @@ end
 
 ---@param opts grapple.action.container_options
 function ContainerActions.toggle_all(opts)
-    -- HACK: reduce window flickering for now by updating the content in-place
+    -- HACK: reduce window flickering by updating the content in-place
     opts.window.content.show_all = not opts.show_all
     opts.window:render()
-    -- require("grapple").open_loaded({ all = not opts.show_all })
 end
 
 function ContainerActions.open_scopes()

lua/grapple/resolved_scope.lua

@@ -11,7 +11,6 @@ ResolvedScope.__index = ResolvedScope
 ---@param name string
 ---@param id string
 ---@param path string | nil
----@param tag_manager grapple.tag_manager
 ---@return grapple.resolved_scope
 function ResolvedScope:new(app, name, id, path)
     return setmetatable({

lua/grapple/scope.lua

@@ -6,6 +6,7 @@ local ResolvedScope = require("grapple.resolved_scope")
 ---@field desc string
 ---@field resolver grapple.scope_resolver
 ---@field fallback grapple.scope | nil
+---@field hidden boolean
 local Scope = {}
 Scope.__index = Scope
 
@@ -14,17 +15,18 @@ Scope.__index = Scope
 ---@param app grapple.app
 ---@param name string
 ---@param resolver grapple.scope_resolver
----@param opts? { desc?: string, fallback?: grapple.scope }
+---@param opts? { desc?: string, fallback?: grapple.scope, hidden?: boolean }
 ---@return grapple.scope
 function Scope:new(app, name, resolver, opts)
     opts = opts or {}
 
     return setmetatable({
         app = app,
         name = name,
-        desc = opts.desc,
+        desc = opts.desc or "",
         resolver = resolver,
         fallback = opts.fallback,
+        hidden = opts.hidden,
     }, self)
 end
 
@@ -36,9 +38,9 @@ function Scope:resolve()
     if not id then
         if self.fallback then
             return self.fallback:resolve()
-        else
-            return nil, err
         end
+
+        return nil, err
     end
 
     return ResolvedScope:new(self.app, self.name, id, path), nil

lua/grapple/scope_actions.lua

@@ -5,6 +5,9 @@ local ScopeActions = {}
 ---Provided by Window
 ---@field window grapple.window
 ---
+---Provided by ScopeContent
+---@field show_all boolean
+---
 ---User-provided information
 ---@field name? string
 
@@ -23,4 +26,10 @@ function ScopeActions.open_loaded()
     require("grapple").open_loaded()
 end
 
+function ScopeActions.toggle_all(opts)
+    -- HACK: reduce window flickering by updating the content in-place
+    opts.window.content.show_all = not opts.show_all
+    opts.window:render()
+end
+
 return ScopeActions

lua/grapple/scope_content.lua

@@ -4,18 +4,21 @@ local Util = require("grapple.util")
 ---@field app grapple.app
 ---@field hook_fn grapple.hook_fn
 ---@field title_fn grapple.title_fn
+---@field show_all boolean
 local ScopeContent = {}
 ScopeContent.__index = ScopeContent
 
 ---@param app grapple.app
 ---@param hook_fn? grapple.hook_fn
 ---@param title_fn? grapple.title_fn
+---@param show_all boolean
 ---@return grapple.scope_content
-function ScopeContent:new(app, hook_fn, title_fn)
+function ScopeContent:new(app, hook_fn, title_fn, show_all)
     return setmetatable({
         app = app,
         hook_fn = hook_fn,
         title_fn = title_fn,
+        show_all = show_all,
     }, self)
 end
 
@@ -77,19 +80,26 @@ function ScopeContent:entities()
         return string.lower(scope_a.name) < string.lower(scope_b.name)
     end
 
+    ---@type grapple.scope[]
     local scopes = vim.tbl_values(self.app.scope_manager.scopes)
     table.sort(scopes, by_name)
 
     local entities = {}
 
     for _, scope in ipairs(scopes) do
+        if not self.show_all and scope.hidden then
+            goto continue
+        end
+
         ---@class grapple.scope_content.entity
         local entity = {
             scope = scope,
             current = scope.name == app.settings.scope,
         }
 
         table.insert(entities, entity)
+
+        ::continue::
     end
 
     return entities, nil
@@ -191,6 +201,10 @@ end
 ---@param opts? grapple.action.options
 ---@return string? error
 function ScopeContent:perform(action, opts)
+    opts = vim.tbl_extend("force", opts or {}, {
+        show_all = self.show_all,
+    })
+
     return action(opts)
 end
 

lua/grapple/scope_manager.lua

@@ -79,15 +79,15 @@ function ScopeManager:lookup(id)
     -- somewhere else? Looks like an opportunity for refactoring
     local ids = vim.tbl_map(to_id, self.app.tag_manager:list())
     if vim.tbl_contains(ids, id) then
-        return ResolvedScope:new(self.app, "unknown", id, nil)
+        return ResolvedScope:new(self.app, "unknown", id, nil), nil
     end
 
     return nil, string.format("could not find resolved scope for id: %s", id)
 end
 
 ---@param name string
 ---@param resolver grapple.scope_resolver
----@param opts? { force?: boolean, desc?: string, fallback?: string, cache?: grapple.cache.options | boolean }
+---@param opts? { force?: boolean, desc?: string, fallback?: string, cache?: grapple.cache.options | boolean, hidden?: boolean }
 ---@return string? error
 function ScopeManager:define(name, resolver, opts)
     opts = opts or {}
@@ -116,6 +116,7 @@ function ScopeManager:define(name, resolver, opts)
     local scope = Scope:new(self.app, name, resolver, {
         desc = opts.desc,
         fallback = fallback,
+        hidden = opts.hidden,
     })
 
     self.scopes[name] = scope

lua/grapple/settings.lua

@@ -281,6 +281,11 @@ local DEFAULT_SETTINGS = {
             window:perform_close(ScopeActions.open_loaded)
         end, { desc = "Go to loaded scopes" })
 
+        -- Toggle
+        window:map("n", "g.", function()
+            window:perform_retain(ScopeActions.toggle_all)
+        end, { desc = "Toggle show hidden" })
+
         -- Help
         window:map("n", "?", function()
             local WindowActions = require("grapple.window_actions")
@@ -323,11 +328,6 @@ local DEFAULT_SETTINGS = {
             end, { desc = string.format("Quick select %d", i) })
         end
 
-        -- Toggle
-        window:map("n", "<s-cr>", function()
-            window:perform_retain(ContainerActions.toggle_all)
-        end, { desc = "Toggle show all" })
-
         -- Unload
         window:map("n", "x", function()
             local entry = window:current_entry()
@@ -347,6 +347,11 @@ local DEFAULT_SETTINGS = {
             window:perform_close(ContainerActions.open_scopes)
         end, { desc = "Go to scopes" })
 
+        -- Toggle
+        window:map("n", "g.", function()
+            window:perform_retain(ContainerActions.toggle_all)
+        end, { desc = "Toggle show unloaded" })
+
         -- Help
         window:map("n", "?", function()
             local WindowActions = require("grapple.window_actions")
@@ -499,23 +504,15 @@ function Settings:scopes()
             definition = { delete = true }
         end
 
-        definition = vim.tbl_extend("keep", definition, {
-            name = name,
-            desc = "",
-        })
-
+        definition = vim.tbl_extend("keep", definition, { name = name })
         assert(type(definition.name) == "string")
 
         table.insert(scopes, definition)
     end
 
     -- Add user-defined scopes
     for name, definition in pairs(self.inner.scopes) do
-        definition = vim.tbl_extend("keep", definition, {
-            name = name,
-            desc = "",
-        })
-
+        definition = vim.tbl_extend("keep", definition, { name = name })
         assert(type(definition.name) == "string")
 
         if definition.fallback then

lua/grapple/tag_manager.lua

@@ -72,8 +72,11 @@ function TagManager:transaction(id, callback, opts)
     return nil
 end
 
----@alias grapple.tag_container_item { container: grapple.tag_container | nil, loaded: boolean}
----
+---@class grapple.tag_container_item
+---@field id string
+---@field loaded boolean
+---@field container? grapple.tag_container
+
 ---@return grapple.tag_container_item[]
 function TagManager:list()
     local list = {}