From c022140ec6a66402e405152054b6ab0141940419 Mon Sep 17 00:00:00 2001
From: Famiu Haque <famiuhaque@protonmail.com>
Date: Mon, 7 Nov 2022 22:27:37 +0600
Subject: feat(api): add command name to Lua command callback opts

Adds a `name` key to the opts dict passed to Lua command callbacks
created using `nvim_create_user_command()`. This is useful for when
multiple commands use the same callback.

Note that this kind of behavior is not as strange as one might think,
even some internal Neovim commands reuse the same internal C function,
differing their behavior by checking the command name. `substitute`,
`smagic` and `snomagic` are examples of that.

This will also be useful for generalized Lua command preview functions
that can preview a wide range of commands, in which case knowing the
command name is necessary for the preview function to actually be able
to execute the command that it's supposed to preview.
---
 test/functional/api/command_spec.lua | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'test/functional/api/command_spec.lua')

diff --git a/test/functional/api/command_spec.lua b/test/functional/api/command_spec.lua
index f19d7a362b..d0fb26edc7 100644
--- a/test/functional/api/command_spec.lua
+++ b/test/functional/api/command_spec.lua
@@ -114,6 +114,7 @@ describe('nvim_create_user_command', function()
     ]]
 
     eq({
+      name = "CommandWithLuaCallback",
       args = [[this\  is    a\ test]],
       fargs = {"this ", "is", "a test"},
       bang = false,
@@ -150,6 +151,7 @@ describe('nvim_create_user_command', function()
     ]=])
 
     eq({
+      name = "CommandWithLuaCallback",
       args = [[this   includes\ a backslash: \\]],
       fargs = {"this", "includes a", "backslash:", "\\"},
       bang = false,
@@ -186,6 +188,7 @@ describe('nvim_create_user_command', function()
     ]=])
 
     eq({
+      name = "CommandWithLuaCallback",
       args = "a\\b",
       fargs = {"a\\b"},
       bang = false,
@@ -222,6 +225,7 @@ describe('nvim_create_user_command', function()
     ]=])
 
     eq({
+      name = "CommandWithLuaCallback",
       args = 'h\tey ',
       fargs = {[[h]], [[ey]]},
       bang = true,
@@ -258,6 +262,7 @@ describe('nvim_create_user_command', function()
     ]=])
 
     eq({
+      name = "CommandWithLuaCallback",
       args = "h",
       fargs = {"h"},
       bang = false,
@@ -294,6 +299,7 @@ describe('nvim_create_user_command', function()
     ]])
 
     eq({
+      name = "CommandWithLuaCallback",
       args = "",
       fargs = {},  -- fargs works without args
       bang = false,
@@ -342,6 +348,7 @@ describe('nvim_create_user_command', function()
     ]]
 
     eq({
+      name = "CommandWithOneOrNoArg",
       args = "hello I'm one argument",
       fargs = {"hello I'm one argument"},  -- Doesn't split args
       bang = false,
@@ -379,6 +386,7 @@ describe('nvim_create_user_command', function()
 
     -- f-args is an empty table if no args were passed
     eq({
+      name = "CommandWithOneOrNoArg",
       args = "",
       fargs = {},
       bang = false,
@@ -427,6 +435,7 @@ describe('nvim_create_user_command', function()
       })
     ]]
     eq({
+      name = "CommandWithNoArgs",
       args = "",
       fargs = {},
       bang = false,
@@ -463,6 +472,7 @@ describe('nvim_create_user_command', function()
     ]])
     -- register can be specified
     eq({
+      name = "CommandWithNoArgs",
       args = "",
       fargs = {},
       bang = false,
-- 
cgit