terraform_docs failing on complex types which contains "description" about pre-commit-terraform HOT 8 CLOSED

@MaxymVlasov @antonbabenko I managed to create a fix without the requirement for terraform fmt beforehand. Can you guys give it a try:

docker run --rm \
  -v $(pwd):/data \
  cytopia/terraform-docs:0.6.0-release-0.11 \
  terraform-docs-replace-012 \
    --sort-inputs-by-required \
    --with-aggregate-type-defaults md README.md

If this works, I'll create a PR

from pre-commit-terraform.

Hello @cytopia,
Here is another bug-feature request for terraform_docs_awk.
Bug I propose fixing via patch, but it's temporaty solution and not add to README full variable type.

Feature request (and awk script) may be dissmised after implemented terraform-docs/terraform-docs#62 (comment). But when it will be...

from pre-commit-terraform.

@MaxymVlasov I was already playing around with this one, but it is kind of tough.

It could probably be much easier solved If I can assume that terraform fmt has always been applied beforehand, but not sure If that would be good.

from pre-commit-terraform.

Well, if terraform fmt will make code in a way that terraform_docs always understand we can make it as a hard requirement and ask everyone to have something like this:

repos:
  - repo: git://github.com/antonbabenko/pre-commit-terraform
    rev: v1.19.0
    hooks:
      - id: terraform_fmt
      - id: terraform_docs

from pre-commit-terraform.

What should this type evaluate to?

  type = list(
    object({
      # description = string
      cidr_blocks = string
      from_port   = number
      to_port     = number
      protocol    = string
    })
  )

Should it be just list or list(object) or list(map(object)) or something else in TF 0.11.x?

from pre-commit-terraform.

This is not valid for 0.11, so it has to be treated as type = list which is valid in both 0.11 and 0.12.

from pre-commit-terraform.

The valid types I found for 0.11 are:

• list
• list(map(string))
• list(string)

So the above case should eval to list then?

from pre-commit-terraform.

It works much better then my crutch. Thank you a lot @cytopia @antonbabenko

from pre-commit-terraform.