Feat(#643) show provider source in requirements section

[edgarsandi]

Description of your changes

Hi there!

This pull request adds to the requirements section the source value

name	source	version
template	hashicorp/template	~> 2.2.0

All the outputs will be:

ASCII document format - requirements

- [[requirement_terraform]] <<requirement_terraform,terraform>> - hashicorp/terraform (>= 0.12)

- [[requirement_aws]] <<requirement_aws,aws>> - hashicorp/aws (>= 2.15.0)

- [[requirement_foo]] <<requirement_foo,foo>> - https://registry.acme.com/foo (>= 1.0)

- [[requirement_random]] <<requirement_random,random>> - hashicorp/random (>= 2.2.0)

ASCII table format - requirements

== Requirements

[cols="a,a,a",options="header,autowidth"]
|===
|Name |Source |Version
|[[requirement_terraform]] <<requirement_terraform,terraform>> |hashicorp/terraform |>= 0.12
|[[requirement_aws]] <<requirement_aws,aws>> |hashicorp/aws |>= 2.15.0
|[[requirement_foo]] <<requirement_foo,foo>> |https://registry.acme.com/foo |>= 1.0
|[[requirement_random]] <<requirement_random,random>> |hashicorp/random |>= 2.2.0
|===

json format - requirements

"requirements": [
  {
    "name": "terraform",
    "source": "hashicorp/terraform",
    "version": "\u003e= 0.12"
  },
  {
    "name": "aws",
    "source": "hashicorp/aws",
    "version": "\u003e= 2.15.0"
  },
  {
    "name": "foo",
    "source": "https://registry.acme.com/foo",
    "version": "\u003e= 1.0"
  },
  {
    "name": "random",
    "source": "hashicorp/random",
    "version": "\u003e= 2.2.0"
  }
],

Markdown document format - requirements

    - <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) - hashicorp/terraform (>= 0.12)

    - <a name="requirement_aws"></a> [aws](#requirement\_aws) - hashicorp/aws (>= 2.15.0)

    - <a name="requirement_foo"></a> [foo](#requirement\_foo) - https://registry.acme.com/foo (>= 1.0)

    - <a name="requirement_random"></a> [random](#requirement\_random) - hashicorp/random (>= 2.2.0)

Markdown table format - requirements

## Requirements

| Name | Source | Version |
|------|--------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | hashicorp/terraform | >= 0.12 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | hashicorp/aws | >= 2.15.0 |
| <a name="requirement_foo"></a> [foo](#requirement\_foo) | https://registry.acme.com/foo | >= 1.0 |
| <a name="requirement_random"></a> [random](#requirement\_random) | hashicorp/random | >= 2.2.0 |

Pretty format - requirements

requirement.terraform - hashicorp/terraform (>= 0.12)
requirement.aws - hashicorp/aws (>= 2.15.0)
requirement.foo - https://registry.acme.com/foo (>= 1.0)
requirement.random - hashicorp/random (>= 2.2.0)

TOML format - requirements

[[requirements]]
  name = "terraform"
  source = "hashicorp/terraform"
  version = ">= 0.12"

[[requirements]]
  name = "aws"
  source = "hashicorp/aws"
  version = ">= 2.15.0"

[[requirements]]
  name = "foo"
  source = "https://registry.acme.com/foo"
  version = ">= 1.0"

[[requirements]]
  name = "random"
  source = "hashicorp/random"
  version = ">= 2.2.0"

TOML format - requirements

[[requirements]]
  name = "terraform"
  source = "hashicorp/terraform"
  version = ">= 0.12"

[[requirements]]
  name = "aws"
  source = "hashicorp/aws"
  version = ">= 2.15.0"

[[requirements]]
  name = "foo"
  source = "https://registry.acme.com/foo"
  version = ">= 1.0"

[[requirements]]
  name = "random"
  source = "hashicorp/random"
  version = ">= 2.2.0"

XML format - requirements

<requirements>
  <requirement>
    <name>terraform</name>
    <source>hashicorp/terraform</source>
    <version>&gt;= 0.12</version>
  </requirement>
  <requirement>
    <name>aws</name>
    <source>hashicorp/aws</source>
    <version>&gt;= 2.15.0</version>
  </requirement>
  <requirement>
    <name>foo</name>
    <source>https://registry.acme.com/foo</source>
    <version>&gt;= 1.0</version>
  </requirement>
  <requirement>
    <name>random</name>
    <source>hashicorp/random</source>
    <version>&gt;= 2.2.0</version>
  </requirement>
</requirements>

YAML format - requirements

requirements:
  - name: terraform
    source: hashicorp/terraform
    version: '>= 0.12'
  - name: aws
    source: hashicorp/aws
    version: '>= 2.15.0'
  - name: foo
    source: https://registry.acme.com/foo
    version: '>= 1.0'
  - name: random
    source: hashicorp/random
    version: '>= 2.2.0'

Fixes #643

I have:

• Read and followed terraform-docs' contribution process.
• All tests pass when I run make test.

[nitrocode]

Thank you @edgarsandi. It would be nice to also add a link to the terraform registry as well.

cc @khos2ow what do you think of this change? Please review when you have time

[budgester]

This is exactly what I need. But it looks like it's been over a year since the last release, do we know when open PR's are likely to get merged and a version 0.17 will be released ? Is there anyway we can support this effort ?

[edgarsandi]

@khos2ow hi!

Have some adjust that I need to do here?