Diagnostic for functions that are not fully annotated

[PinewoodPip]

Sometimes for one reason or another I end up forgetting to fully annotate the params or return values of a function. It would be helpful if there was a diagnostic that warned about functions whose parameters or returns are not fully annotated.

The example below is missing annotations for rows, columns params; it would be helpful to have a warning such as "Unannotated parameters: rows, columns"

[mikuhl-dev]

I want this really bad!

[AndreaWalchshoferSCCH]

Please try out the diagnostic incomplete-signature-doc, it is deactivated per default but should do what you look for!

[mikuhl-dev]

Either this diagnostic is not implemented or it is impossible to enable in vscode. I have tried everything.

[AndreaWalchshoferSCCH]

Which version of the LuaLS are you using? The last fix on the diagnostic was on 3.6.23, so your LuaLS VSCode Extension should be at least that (or latest)

To enable, try to override both the filestatus and the severity of the specific diagnostic in your settings.json or .luarc.json

"diagnostics.neededFileStatus": {
  "incomplete-signature-doc": "Any!"
},
"diagnostics.severity": {
  "incomplete-signature-doc": "Warning!"
}

I'm actually using the diagnostic in both VSCode and CI via the CLI tool, so there still has to be something missing in your setup..

[mikuhl-dev]

Thanks, this worked for me in VSCode settings.json, but I changed "diagnostics" to "Lua.diagnostics".

[carsakiller]

@AndreaWalchshoferSCCH this is my first time hearing of this diagnostic. Would you be able to add it to the wiki or open an issue for it?