custom lint rules for Lua code

[justinmk]

Problem

We have clint.py for defining custom C lint rules, but we don't have a way to define custom rules for Lua code.

Expected behavior

Introduce a build/CI task that allows us to define custom lint rules. Examples:

• disallow use of assert.truthy, recommend ok() / eq() / etc
• check it() descriptions
• comment format
• naming conventions
• ...

Related

• https://github.com/Kampfkarren/selene claims to be "Easy to extend and modify".
• gen_vimdoc.lua (based on lpeg) has a partial Lua parser.
• gen_help_html.lua (based on treesitter) has some hacky custom rules for help files.
• Allow to enhance luacheck with custom checks lunarmodules/luacheck#37 describes a way to "extend" Luacheck by forking/vendoring it.
• Related issue proposing LuaLS CI check: CI: replace luacheck with luals (for headless/automated linting) #24563

[clason]

To be clear, these are semantic rules on top of Stylua's syntactic linting (which will have to be agreed on).

[CppCXY]

Although my project is not well-known and has only recently started testing, but I have extensive experience in developing lua tool. I hope you will also consider implementing CI based on my project(my project will attempt to be 100% compatible with luals syntax, as well as provide a more friendly API)