Go to variable definition (from local module arg)

[radeksimko]

Problem Statement

Users which call modules with any arguments may benefit from being able to jump quickly to the definition of the variable from the module call.

User Impact

Any users which use modules with any variables would likely benefit.

Expected User Experience

Cmd/Ctrl+click

For example by clicking to myvar in the following snippet

module "example" {
  source = "./foo-submodule"

  myvar = "test"
}

they would get to the relevant variable block within the ./foo-submodule module:

variable "myvar" {
  type = string
}

See also https://code.visualstudio.com/docs/editor/editingevolved#_go-to-definition

Context menu

AND/OR

(see below)

Blocking Questions

LSP recognizes two concepts that are relevant here - definition and declaration:

• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_definition
• https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_declaration

For variables in other languages declaration ~= data type and definition ~= value.

Strictly speaking this should therefore probably be implemented as "Go to declaration" unless the variable also has a default, but it's unclear how either of these two methods are surfaced in the VS Code UI, especially when both are in use.

Proposal

• Introduce lang.ExtReference{ DirPath string, Addr []lang.AddrStep } to hcl-lang
• Add NameRefersTo *lang.ExtReference to hcl-lang/schema.AttributeSchema
• Populate NameRefersTo of attributes within DependentBody of module blocks within terraform-schema

[github-actions]

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 details necessary to investigate further.