Merge pull request #28 from desdic/20240105toggleterm

feature: Add group_id/count for toggleterm

README.md

@@ -31,6 +31,13 @@ Neovim 0.9+ is required
       size = nil,
     }
   },
+  toggleterm = {
+      -- default_group_id can be a number or a function that takes a string as parameter.
+      -- The string passed as parameter is the name of the plugin so its possible to do logic based
+      -- on plugin name and function should always return a number like:
+      -- default_group_id = function(plugin) return 1 end
+      default_group_id = 1,
+  },
   enable = true,
   border = "rounded", -- style for vim.ui.selector
   style = "minimal",
@@ -44,6 +51,18 @@ Neovim 0.9+ is required
 }
 ```
 
+Per default all plugins use the same terminal but this behaviour (if you are using `toggleterm`) can be overridden by either grouping the plugins to a specific `group_id` or create a function to assign number based on plugin name.
+
+So if you want all plugins to run under id `id` (default) but the `docker_compose` you would like to have another group you can configure it via
+
+```
+  extensions = {
+    docker_compose = { group_id = 2 },
+  },
+```
+
+and now all docker compose's exec is running in a secondary terminal (group_id 2) and all the others in group_id 1
+
 ## Extensions
 
 Default `greyjoy` does not have any extensions enabled.

lua/greyjoy/_extensions/cargo.lua

@@ -35,6 +35,7 @@ M.parse = function(fileinfo)
             elem["name"] = name
             elem["command"] = cmd
             elem["path"] = filepath
+            elem["plugin"] = "cargo"
 
             table.insert(elements, elem)
         end

lua/greyjoy/_extensions/docker_compose.lua

@@ -54,6 +54,11 @@ M.parse = function(fileinfo)
             elem["name"] = "docker-compose exec " .. v
             elem["command"] = { M.config["cmd"], "exec",  "-it", v,  M.config["shell"] }
             elem["path"] = filepath
+            elem["plugin"] = "docker_compose"
+
+            if M.config["group_id"] then
+                elem["group_id"] = M.config["group_id"]
+            end
 
             table.insert(elements, elem)
         end

lua/greyjoy/_extensions/generic.lua

@@ -55,6 +55,7 @@ M.parse = function(fileobj)
                 elem["name"] = k
                 elem["command"] = command
                 elem["path"] = filepath
+                elem["plugin"] = "generic"
 
                 table.insert(globalcommands, elem)
             end

lua/greyjoy/_extensions/kitchen.lua

@@ -63,6 +63,7 @@ M.parse = function(fileinfo)
                 elem["name"] = "kitchen " .. target .. " " .. v
                 elem["command"] = { "kitchen", target, v }
                 elem["path"] = filepath
+                elem["plugin"] = "kitchen"
                 table.insert(elements, elem)
             end
         end

lua/greyjoy/_extensions/makefile.lua

@@ -52,6 +52,7 @@ M.parse = function(fileinfo)
             elem["name"] = "make " .. v
             elem["command"] = { "make", v }
             elem["path"] = filepath
+            elem["plugin"] = "makefile"
 
             table.insert(elements, elem)
         end

lua/greyjoy/_extensions/vscode_tasks.lua

@@ -25,6 +25,7 @@ M.parse_v2 = function(content, filepath)
                 elem["name"] = v["label"]
                 elem["command"] = { v["command"] }
                 elem["path"] = filepath
+                elem["plugin"] = "vscode_tasks"
 
                 if v["args"] then
                     for _, value in pairs(v["args"]) do

lua/greyjoy/config.lua

@@ -15,6 +15,13 @@ local defaults = {
             size = nil,
         },
     },
+    toggleterm = {
+        -- default_group_id can be a number or a function that takes a string as parameter.
+        -- The string passed as parameter is the name of the plugin so its possible to do logic based
+        -- on plugin name and function should always return a number like:
+        -- default_group_id = function(plugin) return 1 end
+        default_group_id = 1,
+    },
     enable = true, -- enable/disable plugin
     border = "rounded", -- default borders
     style = "minimal", -- default style

lua/greyjoy/init.lua

@@ -67,6 +67,8 @@ greyjoy.menu = function(rootdir, elements)
         commands[value["name"]] = {
             command = value["command"],
             path = value["path"],
+            group_id = value["group_id"],
+            plugin = value["plugin"],
         }
     end
 
@@ -107,19 +109,37 @@ greyjoy.to_toggleterm = function(command)
         return
     end
 
+    local count = 1 -- keep old behaviour and have all run in same terminal window
+    local group_type = type(config.defaults["toggleterm"]["default_group_id"])
+    if group_type == "number" then
+        count = config.defaults["toggleterm"]["default_group_id"]
+    elseif group_type == "function" then
+        count = config.defaults["toggleterm"]["default_group_id"](command.plugin)
+    end
+
+    if command.group_id ~= nil then
+        group_type = type(command.group_id)
+        if group_type == "number" then
+            count = command.group_id
+        elseif group_type == "function" then
+            count = command.group_id(command.plugin)
+        end
+    end
+
     local commandstr = table.concat(command.command, " ")
     local exec_command = "dir='"
         .. command.path
         .. "' cmd='"
         .. commandstr
         .. "'"
+        .. " name='" .. commandstr .. "'"
     if greyjoy.ui.toggleterm.size then
         exec_command = "size="
             .. greyjoy.ui.toggleterm.size
             .. " "
             .. exec_command
     end
-    toggleterm.exec_command(exec_command)
+    toggleterm.exec_command(exec_command, count)
 end
 
 greyjoy.to_buffer = function(command)