Merge pull request #18431 from famiu/feat/api/nvim_get_autocmds/group_name

feat(api): add `group_name` to `nvim_get_autocmds`

3 files changed, 6 insertions, 0 deletions

diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index bb7a238468..242546f87d 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -3509,6 +3509,7 @@ nvim_get_autocmds({*opts})                               *nvim_get_autocmds()*
                     • id (number): the autocommand id (only when defined with
                       the API).
                     • group (integer): the autocommand group id.
+                    • group_name (string): the autocommand group name.
                     • desc (string): the autocommand description.
                     • event (string): the autocommand event.
                     • command (string): the autocommand command.
diff --git a/src/nvim/api/autocmd.c b/src/nvim/api/autocmd.c
index 6f262ebfa0..76e531e7aa 100644
--- a/src/nvim/api/autocmd.c
+++ b/src/nvim/api/autocmd.c
@@ -64,6 +64,7 @@ static int64_t next_autocmd_id = 1;
 ///         containing the following fields:
 ///             - id (number): the autocommand id (only when defined with the API).
 ///             - group (integer): the autocommand group id.
+///             - group_name (string): the autocommand group name.
 ///             - desc (string): the autocommand description.
 ///             - event (string): the autocommand event.
 ///             - command (string): the autocommand command.
@@ -269,6 +270,7 @@ Array nvim_get_autocmds(Dict(get_autocmds) *opts, Error *err)
 
         if (ap->group != AUGROUP_DEFAULT) {
           PUT(autocmd_info, "group", INTEGER_OBJ(ap->group));
+          PUT(autocmd_info, "group_name", CSTR_TO_OBJ(augroup_name(ap->group)));
         }
 
         if (ac->id > 0) {
diff --git a/test/functional/api/autocmd_spec.lua b/test/functional/api/autocmd_spec.lua
index a30af63ba1..41de308a2c 100644
--- a/test/functional/api/autocmd_spec.lua
+++ b/test/functional/api/autocmd_spec.lua
@@ -444,6 +444,7 @@ describe('autocmd api', function()
 
         eq(1, #aus)
         eq([[:echo "GroupOne:1"]], aus[1].command)
+        eq("GroupOne", aus[1].group_name)
       end)
 
       it('should return only the group specified, multiple values', function()
@@ -454,7 +455,9 @@ describe('autocmd api', function()
 
         eq(2, #aus)
         eq([[:echo "GroupTwo:2"]], aus[1].command)
+        eq("GroupTwo", aus[1].group_name)
         eq([[:echo "GroupTwo:3"]], aus[2].command)
+        eq("GroupTwo", aus[2].group_name)
       end)
     end)