feat: InlayHints support

[simrat39]

Related to #40

Needs more work

Todo:

• [x] Commands to enable / disable / toggle
• [x] autocmds
• [ ] Formatting of return types vs parameters
• [x] Helper functions for the init_options
• [x] Remove the R from require
• [ ] Tests
• [x] Documentation
• [x] Configuration

[jose-elias-alvarez]

Great! Looking forward to testing this out soon. I won't have a lot of time this month but let me know if you need anything from me.

[simrat39]

This is almost done. @jose-elias-alvarez how do you think we should handle the init options utility for the user? Currently it is done like this: (note that some or all of those init_options.preferences are needed for this feature to work)

[jose-elias-alvarez]

I'm not sure how many users are modifying init_options, so maybe we could just export a table pre-filled with the required values, something like this:

lspconfig.tsserver.setup({
    init_options = require("nvim-lsp-ts-utils.init_options"),
})

And then users who need finer control can either fill the options in themselves or merge the tables manually.

[simrat39]

I'm not sure how many users are modifying init_options, so maybe we could just export a table pre-filled with the required values, something like this:

lspconfig.tsserver.setup({
    init_options = require("nvim-lsp-ts-utils.init_options"),
})

And then users who need finer control can either fill the options in themselves or merge the tables manually.

Yeah that makes sense. Do we need tests for this PR?

[jose-elias-alvarez]

Do we need tests for this PR?

No need to worry about it IMO, since this is a visual feature and is not likely to straight-up destroy a user's project. Let me know once this is 100% ready.

[simrat39]

Ready to merge from here. I'm not sure if we need to do any formatting like how rust-tools does it, IMO we should just wait for https://github.com/neovim/neovim/pull/9496

[jose-elias-alvarez]

This looks good to go, thanks again!