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

ElDoc? #5

Open
jrab89 opened this issue Jul 5, 2018 · 2 comments
Open

ElDoc? #5

jrab89 opened this issue Jul 5, 2018 · 2 comments

Comments

@jrab89
Copy link

jrab89 commented Jul 5, 2018

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
Copy link
Author

jrab89 commented Jul 5, 2018

@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
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants