feat: unload scopes

Author: cbochs

README.md

@@ -821,12 +821,13 @@ require("grapple").open_scopes()
 
 <img width="1080" alt="image" src="https://github.com/cbochs/grapple.nvim/assets/2467016/8b91222f-cf5e-43b9-9286-56379a6a80f0">
 
-Open a floating window with all loaded scopes. This buffer is not modifiable. Some basic actions are available by default:
+Open a floating window with all loaded scope IDs. This buffer is not modifiable. Some basic actions are available by default:
 
-- **Selection** (`<cr>`): open the [tags window](#tags-window) for the loaded scope under the cursor
-- **Quick select** (default: `1-9`): open tags window for the loaded scope at a given index
-- **Deletion** (`x`): reset the tags for the loaded scope under the cursor
-- **Toggle** (`<s-cr>`): toggle showing both loaded and unloaded scopes
+- **Selection** (`<cr>`): open the [tags window](#tags-window) for the loaded scope ID under the cursor
+- **Quick select** (default: `1-9`): open tags window for the loaded scope ID at a given index
+- **Toggle** (`<s-cr>`): toggle showing both loaded and unloaded scope IDs
+- **Unload** (`x`): unload the tags for the scope ID under the cursor
+- **Deletion** (`X`): reset the tags for the scope ID under the cursor
 - **Go up** (`-`): navigate across to the [scopes window](#scopes-window)
 - **Help** (`?`): open the help window
 

lua/grapple.lua

@@ -378,19 +378,50 @@ function Grapple.statusline(opts)
     return statusline
 end
 
+---@param opts? { scope?: string, id?: string, notify?: boolean }
+---@return string? error
+function Grapple.unload(opts)
+    local App = require("grapple.app")
+    local app = App.get()
+
+    opts = opts or {}
+
+    local err = app:unload(opts)
+    if err then
+        if opts.notify then
+            return vim.notify(err, vim.log.levels.ERROR)
+        else
+            return err
+        end
+    end
+
+    if opts.notify then
+        vim.notify(string.format("Scope unloaded: %s", opts.scope or opts.id), vim.log.levels.INFO)
+    end
+end
+
 ---Reset tags for a given (scope) name or loaded scope (id)
 ---By default, uses the current scope
----@param opts? { scope?: string, id?: string }
+---@param opts? { scope?: string, id?: string, notify?: boolean }
+---@return string? error
 function Grapple.reset(opts)
     local App = require("grapple.app")
     local app = App.get()
 
+    opts = opts or {}
+
     local err = app:reset(opts)
     if err then
-        return vim.notify(err, vim.log.levels.ERROR)
+        if opts.notify then
+            return vim.notify(err, vim.log.levels.ERROR)
+        else
+            return err
+        end
     end
 
-    vim.notify(string.format("Scope reset: %s", opts.scope or opts.id), vim.log.levels.INFO)
+    if opts.notify then
+        vim.notify(string.format("Scope reset: %s", opts.scope or opts.id), vim.log.levels.INFO)
+    end
 end
 
 ---Create a user-defined scope
@@ -412,20 +443,20 @@ function Grapple.delete_scope(scope)
 end
 
 ---Change the currently selected scope
----@param scope string
-function Grapple.use_scope(scope)
+---@param scope_name string
+function Grapple.use_scope(scope_name)
     local App = require("grapple.app")
     local app = App.get()
 
-    local resolved, err = app.scope_manager:get(scope)
-    if not resolved then
+    local scope, err = app.scope_manager:get(scope_name)
+    if not scope then
         ---@diagnostic disable-next-line: param-type-mismatch
         return vim.notify(err, vim.log.levels.ERROR)
     end
 
-    if resolved.name ~= app.settings.scope then
-        app.settings:update({ scope = resolved.name })
-        vim.notify(string.format("Changing scope: %s", resolved.name))
+    if scope.name ~= app.settings.scope then
+        app.settings:update({ scope = scope.name })
+        vim.notify(string.format("Changing scope: %s", scope.name))
     end
 end
 
@@ -499,9 +530,9 @@ function Grapple.open_tags(opts)
     -- stylua: ignore
     local content = TagContent:new(
         scope,
-        app.settings.styles[opts.style or app.settings.style],
         app.settings.tag_hook,
-        app.settings.tag_title
+        app.settings.tag_title,
+        app.settings.styles[opts.style or app.settings.style]
     )
 
     open(content)
@@ -642,6 +673,7 @@ function Grapple.initialize()
                     toggle_loaded  = { args = {},              kwargs = { "all" } },
                     toggle_scopes  = { args = {},              kwargs = {} },
                     toggle_tags    = { args = {},              kwargs = window_kwargs },
+                    unload         = { args = {},              kwargs = scope_kwargs },
                     untag          = { args = {},              kwargs = use_kwargs },
                     use_scope      = { args = { "scope" },     kwargs = {} },
                 }

lua/grapple/app.lua

@@ -89,11 +89,9 @@ function App:current_scope()
     return self.scope_manager:get_resolved(self.settings.scope)
 end
 
----Reset tags for a given scope (name) or loaded scope (id)
----By default, uses the current scope
 ---@param opts? { scope?: string, id?: string }
----@return string? error
-function App:reset(opts)
+---@return string | nil id, string | nil name, string? error
+function App:lookup(opts)
     opts = vim.tbl_extend("keep", opts or {}, {
         scope = self.settings.scope,
     })
@@ -113,26 +111,52 @@ function App:reset(opts)
         local scope, err = app.scope_manager:get_resolved(opts.scope)
         if not scope then
             ---@diagnostic disable-next-line: param-type-mismatch
-            return err
+            return nil, nil, err
         end
 
         id = scope.id
         name = scope.name
     end
 
     if not id then
-        return string.format("must provide a valid scope or id: %s", vim.inspect(opts))
+        return nil, nil, string.format("must provide a valid scope or id: %s", vim.inspect(opts))
+    end
+
+    return id, name, nil
+end
+
+---Unload tags for a given scope (name) or loaded scope (id)
+---By default, uses the current scope
+---@param opts? { scope?: string, id?: string }
+---@return string? error
+function App:unload(opts)
+    local id, name, err = self:lookup(opts)
+    if not id then
+        return err
     end
 
     if name then
         self.scope_manager.cache:unwatch(name)
     end
 
-    ---@diagnostic disable-next-line: redefined-local
-    local err = self.tag_manager:reset(id)
-    if err then
+    self.tag_manager:unload(id)
+end
+
+---Reset tags for a given scope (name) or loaded scope (id)
+---By default, uses the current scope
+---@param opts? { scope?: string, id?: string }
+---@return string? error
+function App:reset(opts)
+    local id, name, err = self:lookup(opts)
+    if not id then
         return err
     end
+
+    if name then
+        self.scope_manager.cache:unwatch(name)
+    end
+
+    self.tag_manager:reset(id)
 end
 
 ---@param scope_name? string

lua/grapple/container_actions.lua

@@ -16,9 +16,14 @@ function ContainerActions.select(opts)
     require("grapple").open_tags({ id = opts.id })
 end
 
+function ContainerActions.unload(opts)
+    require("grapple").unload({ id = opts.id, notify = true })
+    opts.window:render()
+end
+
 ---@param opts grapple.action.container_options
 function ContainerActions.reset(opts)
-    require("grapple").reset({ id = opts.id })
+    require("grapple").reset({ id = opts.id, notify = true })
     opts.window:render()
 end
 

lua/grapple/scope_manager.lua

@@ -1,3 +1,4 @@
+local ResolvedScope = require("grapple.resolved_scope")
 local Scope = require("grapple.scope")
 
 ---@class grapple.scope_manager
@@ -63,11 +64,25 @@ end
 ---@return grapple.resolved_scope | nil, string? error
 function ScopeManager:lookup(id)
     local resolved = self.resolved_lookup[id]
-    if not resolved then
-        return nil, string.format("could not find resolved scope for id: %s", id)
+
+    if resolved then
+        return resolved, nil
+    end
+
+    ---@param item grapple.tag_container_item
+    ---@return string id
+    local to_id = function(item)
+        return item.id
+    end
+
+    -- TODO: This lookup is using the tag_manager. Maybe it should be moved
+    -- 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)
     end
 
-    return self.resolved_lookup[id], nil
+    return nil, string.format("could not find resolved scope for id: %s", id)
 end
 
 ---@param name string

lua/grapple/settings.lua

@@ -318,8 +318,15 @@ local DEFAULT_SETTINGS = {
             window:perform_retain(ContainerActions.toggle_all)
         end, { desc = "Toggle show all" })
 
-        -- Reset
+        -- Unload
         window:map("n", "x", function()
+            local entry = window:current_entry()
+            local id = entry.data.id
+            window:perform_retain(ContainerActions.unload, { id = id })
+        end)
+
+        -- Reset
+        window:map("n", "X", function()
             local entry = window:current_entry()
             local id = entry.data.id
             window:perform_retain(ContainerActions.reset, { id = id })

lua/grapple/tag_content.lua

@@ -3,24 +3,24 @@ local Util = require("grapple.util")
 
 ---@class grapple.tag_content
 ---@field scope grapple.resolved_scope
----@field style_fn grapple.style_fn
 ---@field hook_fn grapple.hook_fn
 ---@field title_fn grapple.title_fn
+---@field style_fn grapple.style_fn
 ---@field current_selection string | nil path of the current buffer
 local TagContent = {}
 TagContent.__index = TagContent
 
 ---@param scope grapple.resolved_scope
----@param style_fn grapple.style_fn
 ---@param hook_fn? grapple.hook_fn
 ---@param title_fn? grapple.title_fn
+---@param style_fn grapple.style_fn
 ---@return grapple.tag_content
-function TagContent:new(scope, style_fn, hook_fn, title_fn)
+function TagContent:new(scope, hook_fn, title_fn, style_fn)
     return setmetatable({
         scope = scope,
-        style_fn = style_fn,
         hook_fn = hook_fn,
         title_fn = title_fn,
+        style_fn = style_fn,
         current_selection = nil,
     }, self)
 end

lua/grapple/tag_manager.lua

@@ -134,10 +134,15 @@ function TagManager:load(id)
     return container, nil
 end
 
+---@param id string
+function TagManager:unload(id)
+    self.containers[id] = nil
+end
+
 ---@param id string
 ---@return string? error
 function TagManager:reset(id)
-    self.containers[id] = nil
+    self:unload(id)
 
     if self.state:exists(id) then
         local err = self.state:remove(id)