Provide workspace-wide symbols for variables in tfvars files

[radeksimko]

Use-cases

When navigating through the whole module (represented as "workspace" in LSP) we currently provide navigation through any symbols representing blocks and/or attributes in *.tf files - such as providers, resources and data sources.

Users would benefit from being able to quickly navigate to variables defined in *.tfvars and *.tfvars.json (see also #519)

Proposal

The WorkspaceSymbol (representing workspace/symbol RPC method) will need to be updated, specifically this part

terraform-ls/internal/langserver/handlers/workspace_symbol.go

Lines 31 to 42 in 8840e7b

	d, err := decoder.DecoderForModule(ctx, mod)
	if err != nil {
	return symbols, err
	}
	modSymbols, err := d.Symbols(params.Query)
	if err != nil {
	continue
	}
	symbols = append(symbols, ilsp.SymbolInformation(mod.Path, modSymbols,
	cc.Workspace.Symbol)...)

We can reuse this function

terraform-ls/internal/decoder/decoder.go

Lines 43 to 55 in 8840e7b

	func DecoderForVariables(varsFiles ast.VarsFiles) (*decoder.Decoder, error) {
	d := decoder.NewDecoder()
	for name, f := range varsFiles {
	err := d.LoadFile(name.String(), f)
	if err != nil {
	// skip unreadable files
	continue
	}
	}
	return d, nil
	}

and call the same Symbols method on the decoder and append found symbols to the slice.

[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.