search

rafalcieslak / emacs-company-terraform

Company backend for terraform files
zlib License
38 stars 11 forks source link

ElDoc? #5

Open jrab89 opened 6 years ago

jrab89 commented 6 years ago

First, thanks for making this package, it's really helpful!

ElDoc integration would be really nice for reading existing Terraform code, e.g. having resource and argument documentation show up in the echo area for where the point is at.

I'm thinking that having the all the documentation already parsed in company-terraform-data.el would help in implementing this. Or maybe ElDoc support for Terraform belongs in a different package?

jrab89 commented 6 years ago

@rafalcieslak if you think this would be a good feature to have and you'd like help, please let me know. I'd be happy to send you a PR!

rafalcieslak commented 6 years ago

I am not sure if this package is he right place to implement eldoc integration, it feels out-of-scope for a completion plugin. I do agree, however, that the resource data (as well as context detection and similar utilities) might be useful for many packages, not just company-terraform and for that reason it might deserve to be separated into a shared package. As far as I can tell, development on terraform-mode is pretty much stopped, so maybe I need to consider creating a separate "terraform-data" provider, on which both company-terraform and documentation packages might depend on. Or I could just evolve this package into a multi-featured terraform IDE. So there are multiple ways to go forward. I'll thing about these options.

In the meantime I will investigate how to integrate with eldoc. You can also use company-quickhelp to display the documentation on completion.