luacheck VS StyLua

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.

Use and enforce a style with StyLua) or LuaFormatte and neovim can autoformat for ya.

stylua.toml is the config file of Stylua not of sumneko-lua

Starting from version 0.14.0, StyLua (the Lua code formatter in Neovim world) implements option collapse_simple_statement. From release notes:

Check out StyLua if you want a code formatter.

Here is the instruction how to install and config.

RUN wget -O stylua-0.11.0-linux.zip https://github.com/JohnnyMorganz/StyLua/releases/download/v0.11.0/stylua-0.11.0-linux.zip && \ unzip stylua-0.11.0-linux.zip && \ rm stylua-0.11.0-linux.zip && \ chmod +x stylua

If your function call has only one argument and it happens to be a literal string or a table, then you might want to eliminate the parenthesis. Use whatever style you prefer, the later is useful for some DSLs. Let stylua auto format it anyway.

Have you tried any external programs to format your code instead? That's what I usually do. Just set 'formatprg', and use gq to format the code. With a quick search I found LuaFormatter, and StyLua, but I can't say if they format the code the way you want. In my experience, external code formaters will do a better job, and they have more options to tweak as well.

Have a look at https://github.com/JohnnyMorganz/StyLua together with https://github.com/jose-elias-alvarez/null-ls.nvim

I personally use https://github.com/JohnnyMorganz/StyLua and I am seeing it a lot in some popular projects like telescope.nvim, nvim-lspconfig and ther is also a PR to include it into neovim itself to format the lua files.