Language Server for Terragrunt

[kevcube]

Language servers are helpful in development. A language server for Terragrunt that is aware of a whole directory of terragrunt components would be nice.

possible features

• includes
  • ctrl+click path to open
  • directory suggestions when typing
• dependency
  • output suggestion
  • config_path suggestions
• inputs
  • awareness of variables in source module by reading terraform
• terragrunt remote_state and generate key/value support

Describe alternatives you've considered I am not currently ready to start development on this so I am suggesting it

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for raising this issue.

[Chilinot]

Not stale, still desired

[josh-padnick]

@Chilinot Does the solution at https://github.com/gruntwork-io/terragrunt/issues/2931#issuecomment-1930004840 address your need?

[kevcube]

Does the solution at #2931 (comment) address your need?

@josh-padnick as another user desiring this I can say no, not for me

I’m looking for some language server implementation that does more than just syntax highlighting. It would be great to resolve imports/includes, resolve dependencies and their outputs, resolve inputs for a module, and more.

[josh-padnick]

Got it, and that makes sense. Some initial research led us to conclude that LSP implementations are surprisingly expensive, and our current Terragrunt plate is already quite full, so we'd be open to sponsoring this work, both for initial development and potentially for ongoing maintenance.

Given that, we'd welcome guidance on either who might be interested in contributing (and possibly maintaining) this, potentially with Gruntwork sponsorship, or if there's a less expensive way to get something shipped here.

Thanks as always for your feedback.

[jowharshamshiri]

Hey guys, I had this same problem and was googling and landed on this issue page, so I put something quick together which works on my own Terragrunt projects and helps me navigate the dependencies but is by no means feature-complete, and has no test coverage yet.

Check it out. I will work more on this when I get the time to implement more features and all contributions are welcome. I am open to working more closely on this per your requirements.

Currently supported features include:

• Valid top-level block declarations.
• Generate and follow link for dependency blocks with relative paths(open the implicit terragrunt.hcl)
• Recognize Heredocs in generate blocks and ignore the content.
• Checking for invalid content outside blocks.
• Number of and type of args after block name(one mandatory string arg for generate and dependecy, an optional string arg for include)
• Mandatory path attribute for include blocks.
• Warning on non-git terraform source paths.
• Reject terraform blocks(module, variable, etc...) in hcl files.
• Some suggestions for remote state and generate blocks and others(WIP)