cmd/inspect-module: A command to aid with debugging root module discovery

[radeksimko]

Current Version

0.4.1

Use-cases

The server has a capability to walk through some complex hierarchies to understand where to find plugin cache (i.e. schema data) and how to match it with files being open in order to provide relevant completion candidates.

Because complexity may vary and reasons for why root module isn't discovered are many it's expectable that there will be a time period when we have to work with users to tweak the discovery & matching logic.

Providing all the feedback (reasons why root module was not discovered) is not always practical or possible at runtime, unless we would flood users with messages. Obtaining this kind of information from the logs is not trivial either, especially when users only share snippets of their logs.

We need a way of communicating the complexity of hierarchy of root modules easily.

Attempted Solutions

tree output + logs + verbal description of dependencies

Proposal

Introduce terraform-ls inspect-module [path] command which will mostly just do what the server would do on initialize, but synchronously

• walk through the [path]
• attempt to discover all root modules
• discover module manifest
• discover plugin cache
• parse module manifest
• discover Terraform executable
• discover Terraform version
• discover compatible parser
• obtain schema

and finally present all this in some consumable/share-able form that user can just paste into a gist or something.

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the context necessary to investigate further.