Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lsp: Inlay Hint Support #627

Open
hmnd opened this issue Mar 18, 2024 · 1 comment
Open

lsp: Inlay Hint Support #627

hmnd opened this issue Mar 18, 2024 · 1 comment
Labels
enhancement New feature or request lsp NeedsImplementation Needs implementation

Comments

@hmnd
Copy link

hmnd commented Mar 18, 2024

It would be great if the templ LSP supported inlay hints.

Currently, I tend to lean toward providing an options struct as a single param to my templ components, because it can be difficult to figure out what a bunch of strings args are supposed to represent. That comes with the caveat of structs not enforcing that all params are provided, leading to unintentional defaults.

Inlay hints would allow one to efficiently parse what each arg means, without the sacrifices in explicitness that a struct requires.

Thanks for your work on this awesome lib!

@joerdav joerdav changed the title Feature Request: Inlay Hint Support lsp: Inlay Hint Support Mar 19, 2024
@joerdav joerdav added enhancement New feature or request lsp NeedsInvestigation Issue needs some investigation before being fixed labels Mar 19, 2024
@joerdav
Copy link
Collaborator

joerdav commented Jun 5, 2024

Just to outline the steps involved to get this off the ground:

  1. Update the protocol package to support the textDocument/inlayHint command.
  2. Implement the command in the server proxy, mapping the positions in the response from go to templ (the inverse of updatePosition).
  3. Add a configuration option to the lsp enable the various hints gopls provides, as gopls doesn't provide them by default therefore we shouldn't.
  4. Add configuration options to the editor plugins to configure hints (vscode, nvim).

@joerdav joerdav added NeedsImplementation Needs implementation and removed NeedsInvestigation Issue needs some investigation before being fixed labels Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lsp NeedsImplementation Needs implementation
Projects
None yet
Development

No branches or pull requests

2 participants