luacheck VS luacheck

Not directly related, but luacheck can also help with this.

Yeah. While you're at it, make a habit of running luacheck on your files as it helps catch a lot of these issues that can sneak in by mistake: https://github.com/mpeterv/luacheck

Using something like https://github.com/mpeterv/luacheck might be helpful too. Will check all the files in a directory and will let you know which one might be problematic.

I'm trying to setup luacheck (via null-ls) to run alongside sumneko-lua (via nvim-lspconfig).

Most of the time nothing is used. The thing is that iterating is so quick, that you find the problems really fast.

Although, I've been using luacheck https://github.com/mpeterv/luacheck. It is quite nice, but you have to write down the global variables by hand on the config file.

Check out luacheck. It can help spot typos or mistakes you've made and warn against anti-patterns. I'd honestly only look into setting it up locally because there's no benefit to putting it in a CI pipeline unless you have one for another reason IMO. This should be all the config you need:

Sadly the scenario that the successor feature is intended to alleviate has very much become reality. The creator of Luacheck (Peter Melnichenko) passed away a couple of years ago, and ever since then the GitHub repository has been in a state of limbo. Multiple unofficial forks have come and gone, but Peter's is still the first result on Google if you search "luacheck". It isn't even possible to change the README or pin an issue to get people's attention about the fork; to this day people are still posting issues to the old repo.

And Luacheck is "the" Lua static analysis tool that pretty much everyone uses, so it's a very significant issue.

https://github.com/mpeterv/luacheck/issues/198

You are probably right, but luacheck is well aware of which global variables are built-in and it has special comments, such as -- no global or --ignore in case you very want to overwrite them.

Calling your function self is as much bad practice as calling it print. Use luacheck to avoid such mistakes.

Luacheck is now maintained by lunarmodules.

I first started by reading some tutorials but most of those used parser combinators. For me, parser combinators always caused some issues sooner or later (at least in Lua when trying to parse recursive / nested nodes). An example project that uses this technique is vim-vsnip: https://github.com/hrsh7th/vim-vsnip/blob/master/autoload/vsnip/snippet/parser.vim. Later, I found out that Luacheck uses a different approach which I liked better: https://github.com/lunarmodules/luacheck/blob/master/src/luacheck/parser.lua. That's the project that helped me the most while writing my own parsers for different snippet engines.

I'm just a contributor to Gabe, but I use luacheck in my other projects. Install it (with hererocks+luarocks on Win and luarocks elsewhere), set it up in your editor, and you'll get warnings about typos and other potential bugs. luacheckrc lets you configure it: turn off warnings you don't care about, customize it for different files.

Use luacheck to find all global and unused variables in your project.

I’m not really really sure what exactly you’re relying on that is so specific to Python, but Lu’s appears to have a static analysis linter. https://github.com/luarocks/luacheck