Documentation: Opts luals Annotations

[alex-courtis]

luals annotations for all setup opts.

This will allow users to validate via luals and use autocomplete.

Expose this to user via @param on setup function and @meta

[alex-courtis]

Originally #2896

[gegoune]

Is there a way to autogenerate those?

[alex-courtis]

Is there a way to autogenerate those?

For help or other doc, yes. Some plugins have done it and it looks like nvim also.

It's really unclear to me where the source of truth for the actual types and descriptions should be. Perhaps a discrete @meta or above the default options themselves.

It would be great if all the nvim-tree-opts help was in that place too, for a single source of truth.