Support for dynamic block

[radeksimko]

Use-cases

Terraform supports a dynamic "meta" block within resource data, provider and provisioner blocks, for example:

resource "aws_elastic_beanstalk_environment" "example" {
  name                = "example"
  application         = "example-app"
  solution_stack_name = "64bit Amazon Linux 2018.03 v2.11.4 running Go 1.12.6"

  dynamic "setting" {
    for_each = var.settings
    content {
      namespace = setting.value["namespace"]
      name      = setting.value["name"]
      value     = setting.value["value"]
    }
  }
}

variable "settings" {
  type = list(object({
    namespace = string
    name      = string
    value     = string
  }))
}

Language server currently does not support this block, which in practice means that e.g.

• dynamic doesn't come up as candidate when completing resource data, provider or provisioner body
• no completion is provided within an existing dynamic block
• no data is provided when user hovers over dynamic block or any block/attribute/value within it
• no tokens are reported for the dynamic block itself or anything within it

Expected UX

Completion

Screen.Recording.2022-06-01.at.10.59.59.mov

Hover

Screen.Recording.2022-06-01.at.10.57.39.mov

Semantic Tokens

TODO

Proposal

• hashicorp/hcl-lang
  • Introduce BodyExtensions{DynamicBlocks bool} into schema.BodySchema
  • Reflect DynamicBlocks in decoder.PathDecoder.CandidatesAtPos()
  • Reflect DynamicBlocks in decoder.PathDecoder.HoverAtPos()
  • Reflect DynamicBlocks in decoder.PathDecoder.SemanticTokensInFile()
  • Reflect DynamicBlocks in decoder.Decoder.Symbols()
• hashicorp/terraform-schema
  • Add BodyExtensions{DynamicBlocks: true} dynamically to resource, data, provider and provisioner block bodies where the body has any blocks
• hashicorp/terraform-ls
  • bump terraform-schema & hcl-lang

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