Link to resources, data sources and module sources docs

[richeney]

Link to Terraform documentation and module repos

Enhancement summary

1. Resource type and data type become follow links to the matching documentation pages.
2. The values for a module's source argument also become follow links for known URI formats.

This would be a major productivity benefit!

Resource Type Example

For example, if I have

resource "azurerm_resource_group" "example" {
  name     = "example"
  location = "West Europe"
}

then make azurerm_resource_group a follow link (CTRL+click) to https://www.terraform.io/docs/providers/azurerm/r/resource_group.html.

If a data source then azurerm_resource_group would target https://www.terraform.io/docs/providers/azurerm/d/resource_group.html.

Module Source Example

Example module:

module "web_pool1_vms" {
  source            = "github.com/terraform-azurerm-modules/terraform-azurerm-linux-vm?ref=v0.1"
  defaults          = local.web_vm_defaults
  module_depends_on = [module.web_pool1_set]

  attachType = "ApplicationGateway"
  attach     = module.web_pool1_set.set_ids

  names           = ["web-pool1-a", "web-pool1-b", "web-pool1-c"]
  source_image_id = data.azurerm_image.ubuntu_18_04.id
}

Make github.com/terraform-azurerm-modules/terraform-azurerm-linux-vm?ref=v0.1 a follow link to https://github.com/terraform-azurerm-modules/terraform-azurerm-linux-vm?ref=v0.1.

[radeksimko]

Hi @richeney
This sounds like a feature that could likely be implemented in the language server, rather than on the client side (such as VSCode extension) - that's why I decided to transfer it here.

We do have plans to build hover support - there is already a draft PR - that isn't adding a link to docs yet, but I would imagine that would be a place where we can add it, similar to how gopls does it:

As far as clicking goes I think that is generally represented in LSP in the form of "go to definition" - something we haven't implemented yet either, but I would imagine that it's more likely we would be linking to the source code of the module cached locally.

The implementation details are not set in stone, but it will need to work within the boundaries of the LSP and conventions. With that in mind I haven't seen any language server linking directly (on click) to an external URL yet, but my view may be limited, so I would be curious to see if there are any examples of such behaviour in VSCode extension or any other IDE.

[adamrushuk]

It's great to see the hover support just come in for v0.10.0, so really looking forward to adding links to the documentation too. I believe the old Terraform extension had this functionality, but from memory I think you had to Ctrl + Click the resource name to turn it into a link.