feat: Support LuaCATS comment formatting

[UtkarshVerma]

feat: Support LuaCATS comment formatting

[JohnnyMorganz]

It will be somewhat difficult to support this. We currently don't bother formatting comments at all, since comments could consist of anything.

We could support formatting specifically doc comments, however there is no "standardised" way of defining documentation comments in Lua (luadoc, emmylua, LuaCATs, moonwave, etc.), so it isn't clear which one, if any, we should support.

[lewis6991]

At the very minimum, we could enforce consistent whitespace in doc comments:

---text1
--- text2
--- @param a
---@return string

becomes:

--- text1
--- text2
--- @param a
--- @return string

Where the padding maybe configurable.