[Tarantool-patches] [PATCH] Fix luacheck warning W122 in extra/dist/tarantoolctl.in

[Tarantool-patches] [PATCH] Fix luacheck warning W122 in extra/dist/tarantoolctl.in

[Artem Starshov]

Changed passing global variable arg to function find_instance_name(arg) instead of passing arg[0] and arg[2] separately.
And removed exception in .luacheckrc for file /extra/dist/tarantoolctl.in.

This change only solves linter warning, nothing else
---
 .luacheckrc                |  6 ------
 extra/dist/tarantoolctl.in | 16 ++++++++--------
 2 files changed, 8 insertions(+), 14 deletions(-)

diff --git a/.luacheckrc b/.luacheckrc
index 994d29956..2a652cd06 100644
--- a/.luacheckrc
+++ b/.luacheckrc
@@ -37,12 +37,6 @@ exclude_files = {
     ".git/**/*.lua",
 }
 
-files["extra/dist/tarantoolctl.in"] = {
-    ignore = {
-        -- https://github.com/tarantool/tarantool/issues/4929
-        "122",
-    },
-}
 files["src/lua/help.lua"] = {
     -- Globals defined for interactive mode.
     globals = {"help", "tutorial"},
diff --git a/extra/dist/tarantoolctl.in b/extra/dist/tarantoolctl.in
index 90caf58ad..0726e7f46 100755
--- a/extra/dist/tarantoolctl.in
+++ b/extra/dist/tarantoolctl.in
@@ -202,19 +202,19 @@ end
 -- In case there is no explicit instance name, check whether arg[0] is a
 -- symlink. In that case, the name of the symlink is the instance name.
 --
-local function find_instance_name(arg0, arg2)
-    if arg2 ~= nil then
-        return fio.basename(arg2, '.lua')
+local function find_instance_name(arg)
+    if arg[2] ~= nil then
+        return fio.basename(arg[2], '.lua')
     end
-    local istat = fio.lstat(arg0)
+    local istat = fio.lstat(arg[0])
     if istat == nil then
-        log.error("Can't stat %s: %s", arg0, errno.strerror())
+        log.error("Can't stat %s: %s", arg[0], errno.strerror())
         os.exit(1)
     end
     if not istat:is_link() then usage(command_name) end
-    arg[2] = arg0
+    arg[2] = arg[0]
     linkmode = true
-    return fio.basename(arg0, '.lua')
+    return fio.basename(arg[0], '.lua')
 end
 
 local function mkdir(dirname)
@@ -971,7 +971,7 @@ local function process_remote(cmd_function)
 end
 
 local function process_local(cmd_function)
-    instance_name = find_instance_name(arg[0], arg[2])
+    instance_name = find_instance_name(arg)
 
     default_file = find_default_file()
     load_default_file(default_file)
-- 
2.28.0

Re: [Tarantool-patches] [PATCH] Fix luacheck warning W122 in extra/dist/tarantoolctl.in

[Leonid Vasiliev]

Hi! Thank you for the patch.
Code changes are ok. See some comments on the decoration of the patch
below:

According to 
https://github.com/tarantool/tarantool/wiki/Code-review-procedure#commit-message:
- "Description is what the patch does, started from lowercase letter..."
- "Commit title should be of a form <subsystem>: <description>."
   (luacheck:...)

I guess nobody remembers the luacheck warning codes. You can describe
the warning in detail in the "body" of a commit message, don't need to
put it in the "header".
I think the file name will be enough, don't need to write the full path.


On 07.10.2020 16:33, Artem Starshov wrote:
> Changed passing global variable arg to function find_instance_name(arg) instead of passing arg[0] and arg[2] separately.

According to 
https://github.com/tarantool/tarantool/wiki/Code-review-procedure#commit-message:
- "Commit message should fit 72 symbols line width."

> And removed exception in .luacheckrc for file /extra/dist/tarantoolctl.in.
> 
> This change only solves linter warning, nothing else

- Add link on the ticket (Fixed #number_of_the_ticket).

> ---

Please add a link to the ticket and your branch.

>   .luacheckrc                |  6 ------
>   extra/dist/tarantoolctl.in | 16 ++++++++--------
>   2 files changed, 8 insertions(+), 14 deletions(-)
> 
> diff --git a/.luacheckrc b/.luacheckrc
> index 994d29956..2a652cd06 100644
> --- a/.luacheckrc
> +++ b/.luacheckrc
> @@ -37,12 +37,6 @@ exclude_files = {
>       ".git/**/*.lua",
>   }
>   
> -files["extra/dist/tarantoolctl.in"] = {
> -    ignore = {
> -        -- https://github.com/tarantool/tarantool/issues/4929
> -        "122",
> -    },
> -}
>   files["src/lua/help.lua"] = {
>       -- Globals defined for interactive mode.
>       globals = {"help", "tutorial"},
> diff --git a/extra/dist/tarantoolctl.in b/extra/dist/tarantoolctl.in
> index 90caf58ad..0726e7f46 100755
> --- a/extra/dist/tarantoolctl.in
> +++ b/extra/dist/tarantoolctl.in
> @@ -202,19 +202,19 @@ end
>   -- In case there is no explicit instance name, check whether arg[0] is a
>   -- symlink. In that case, the name of the symlink is the instance name.
>   --
> -local function find_instance_name(arg0, arg2)
> -    if arg2 ~= nil then
> -        return fio.basename(arg2, '.lua')
> +local function find_instance_name(arg)
> +    if arg[2] ~= nil then
> +        return fio.basename(arg[2], '.lua')
>       end
> -    local istat = fio.lstat(arg0)
> +    local istat = fio.lstat(arg[0])
>       if istat == nil then
> -        log.error("Can't stat %s: %s", arg0, errno.strerror())
> +        log.error("Can't stat %s: %s", arg[0], errno.strerror())
>           os.exit(1)
>       end
>       if not istat:is_link() then usage(command_name) end
> -    arg[2] = arg0
> +    arg[2] = arg[0]
>       linkmode = true
> -    return fio.basename(arg0, '.lua')
> +    return fio.basename(arg[0], '.lua')
>   end
>   
>   local function mkdir(dirname)
> @@ -971,7 +971,7 @@ local function process_remote(cmd_function)
>   end
>   
>   local function process_local(cmd_function)
> -    instance_name = find_instance_name(arg[0], arg[2])
> +    instance_name = find_instance_name(arg)
>   
>       default_file = find_default_file()
>       load_default_file(default_file)
>