luacheck requires a real path to a directory? #208

Totktonada · 2020-11-11T02:40:23Z

I found that under the following circumstances I need to pass a real directory path (with resolved symlinks) to the luacheck executable in order to don't miss warnings:

.luacheckrc in a project root have include_files with some globs.
The current directory is non-real path to the project root.
The argument to luacheck is the same non-real path.

How to reproduce:

$ mkdir -p "${HOME}"/tmp/test-luacheck/aaa  # project root
$ cd "${HOME}"/tmp/test-luacheck/aaa
$ echo 'foo = 42' > foo.lua
$ echo "include_files = {'**/*.lua'}" > .luacheckrc
$ luacheck --config .luacheckrc "${HOME}"/tmp/test-luacheck/aaa
Checking /home/alex/tmp/test-luacheck/aaa/foo.lua 1 warning

    /home/alex/tmp/test-luacheck/aaa/foo.lua:1:1: setting non-standard global variable foo

Total: 1 warning / 0 errors in 1 file
$ cd ..
$ ln -s aaa bbb
$ cd bbb
$ luacheck --config .luacheckrc "${HOME}"/tmp/test-luacheck/bbb
Total: 0 warnings / 0 errors in 0 files
$ cd .. && tree
.
├── aaa
│   └── foo.lua
└── bbb -> aaa

2 directories, 1 file

I step into this problem, because I use symlinks to ease access to directories that I use often. I'm not sure this is broad approach, but I hope it is valid. At least, it seems, it does not contradict with the current luacheck documentation.

(I'm aware about the status of the repository, but I think that issues should be filed here until the repository will be properly migrated: otherwise we'll have several issue numerations.)

The text was updated successfully, but these errors were encountered:

Totktonada · 2020-11-11T03:48:52Z

I also found that even if I pass the real path, but the current working directory is different, the files are missed:

$ pwd
/home/alex/tmp/test-luacheck
$ mkdir ccc
$ cd ccc
$ luacheck --config ../aaa/.luacheckrc /home/alex/tmp/test-luacheck/aaa
Total: 0 warnings / 0 errors in 0 files

Now `make luacheck` gracefully handles different cases: in-source and out-of-source build (within the source tree or outside), current working directory as a real path or with symlink components. As result of looking into those problems I filed the issue [1] against luacheck. It seems, there are problems around absolute paths with symlinks components. [1]: mpeterv/luacheck#208

ligurio · 2020-12-08T14:22:12Z

I suggest to resolve specified path using readlink, it works:

Total: 1 warning / 0 errors in 1 file
sergeyb@pony:~/sources/MRG/ttt$ luacheck --config .luacheckrc /home/sergeyb/sources/MRG/ttt
Total: 0 warnings / 0 errors in 0 files
sergeyb@pony:~/sources/MRG/ttt$ luacheck --config .luacheckrc $(readlink /home/sergeyb/sources/MRG/ttt)
Checking /home/sergeyb/sources/MRG/tt/test.lua    1 warning

    /home/sergeyb/sources/MRG/tt/test.lua:1:1: setting non-standard global variable a

Total: 1 warning / 0 errors in 1 file
sergeyb@pony:~/sources/MRG/ttt$

Totktonada · 2020-12-14T19:49:10Z

@ligurio It seems it works only when .luacheckrc can be found by upward directories traversal. See #208 (comment).

Now `make luacheck` gracefully handles different cases: in-source and out-of-source build (within the source tree or outside), current working directory as a real path or with symlink components. As result of looking into those problems I filed the issue [1] against luacheck. It seems, there are problems around absolute paths with symlinks components. [1]: mpeterv/luacheck#208

Now `make luacheck` gracefully handles different cases[^1]: in-source and out-of-source build (within the source tree or outside), current working directory as a real path or with symlink components. As result of looking into those problems I filed the issue [1] against luacheck. It seems, there are problems around absolute paths with symlinks components. [^1]: We have the similar problems with LuaJIT's luacheck rule. They will be fixed in a separate patch. [1]: mpeterv/luacheck#208 Reviewed-by: Sergey Bronnikov <sergeyb@tarantool.org> Reviewed-by: Igor Munkin <imun@tarantool.org>

Now `make luacheck` gracefully handles different cases[^1]: in-source and out-of-source build (within the source tree or outside), current working directory as a real path or with symlink components. As result of looking into those problems I filed the issue [1] against luacheck. It seems, there are problems around absolute paths with symlinks components. [^1]: We have the similar problems with LuaJIT's luacheck rule. They will be fixed in a separate patch. [1]: mpeterv/luacheck#208 Reviewed-by: Sergey Bronnikov <sergeyb@tarantool.org> Reviewed-by: Igor Munkin <imun@tarantool.org> (cherry picked from commit af44846)

Unfortunately, luacheck doesn't handle the working directory or one used in options if it is not a real path. As a result of this patch both PROJECT_SOURCE_DIR and PROJECT_BINARY_DIR are resolved prior to be used within luacheck target custom command. The issue has been already fixed in Tarantool repo after applying af448464d15f60b87f1c9ef41a7816911c889459 ('tools: fix luacheck invocation in different cases'), and this patch is necessary, since <LuaJIT-luacheck> is the dependency for Tarantool <luacheck> target. Relates to mpeterv/luacheck#208 Reported-by: Alexander Turenko <alexander.turenko@tarantool.org> Signed-off-by: Igor Munkin <imun@tarantool.org>

Unfortunately, luacheck doesn't handle the working directory or one used in options if it is not a real path. As a result of this patch both PROJECT_SOURCE_DIR and PROJECT_BINARY_DIR are resolved prior to be used within luacheck target custom command. The issue has been already fixed in Tarantool repo after applying af448464d15f60b87f1c9ef41a7816911c889459 ('tools: fix luacheck invocation in different cases'), and this patch is necessary, since <LuaJIT-luacheck> is a dependency for Tarantool <luacheck> target. Relates to mpeterv/luacheck#208 Reported-by: Alexander Turenko <alexander.turenko@tarantool.org> Reviewed-by: Alexander Turenko <alexander.turenko@tarantool.org> Reviewed-by: Sergey Kaplun <skaplun@tarantool.org> Signed-off-by: Igor Munkin <imun@tarantool.org>

Unfortunately, luacheck doesn't handle the working directory or one used in options if it is not a real path. As a result of this patch both PROJECT_SOURCE_DIR and PROJECT_BINARY_DIR are resolved prior to be used within luacheck target custom command. The issue has been already fixed in Tarantool repo after applying af448464d15f60b87f1c9ef41a7816911c889459 ('tools: fix luacheck invocation in different cases'), and this patch is necessary, since <LuaJIT-luacheck> is a dependency for Tarantool <luacheck> target. Relates to mpeterv/luacheck#208 Reported-by: Alexander Turenko <alexander.turenko@tarantool.org> Reviewed-by: Alexander Turenko <alexander.turenko@tarantool.org> Reviewed-by: Sergey Kaplun <skaplun@tarantool.org> Signed-off-by: Igor Munkin <imun@tarantool.org> (cherry picked from commit 00f82a6)

Unfortunately, luacheck doesn't handle the working directory or one used in options if it is not a real path. As a result of this patch both PROJECT_SOURCE_DIR and PROJECT_BINARY_DIR are resolved prior to be used within luacheck target custom command. The issue has been already fixed in Tarantool repo after applying af448464d15f60b87f1c9ef41a7816911c889459 ('tools: fix luacheck invocation in different cases'), and this patch is necessary, since <LuaJIT-luacheck> is a dependency for Tarantool <luacheck> target. Relates to mpeterv/luacheck#208 Reported-by: Alexander Turenko <alexander.turenko@tarantool.org> Reviewed-by: Alexander Turenko <alexander.turenko@tarantool.org> Reviewed-by: Sergey Kaplun <skaplun@tarantool.org> Signed-off-by: Igor Munkin <imun@tarantool.org>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

luacheck requires a real path to a directory? #208

luacheck requires a real path to a directory? #208

luacheck requires a real path to a directory? #208

luacheck requires a real path to a directory? #208

Comments