terraform modules cmd human view
#36062
Conversation
Maed223
force-pushed
the
TF-19313/modules-cmd-human-view
branch
from
0778f7a
to
2f7081c
Compare
Maed223
force-pushed
the
TF-19313/modules-cmd-human-view
branch
from
2f7081c
to
272130e
Compare
Maed223
changed the title
terraform modules cmd human view
|
The equivalence tests will be updated. Please verify the changes here. |
|
The equivalence tests will be updated. Please verify the changes here. |
Maed223
force-pushed
the
TF-19313/modules-cmd-human-view
branch
from
272130e
to
4cba6bb
Compare
|
The equivalence tests will be updated. Please verify the changes here. |
Maed223
force-pushed
the
TF-19313/modules-cmd-human-view
branch
from
4cba6bb
to
e4b4aa8
Compare
| The following example is a representation of the human readable output that `terraform modules` returns. The nested structure represents the | ||
| module composition/heirarchy within your configuration. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Should this be shell? Or something like it? We wanna make sure we get syntax highlighting if we can!
| ``` | |
| ```shell-session |
|
|
||
| We will introduce new major versions only within the bounds of | ||
| [the Terraform 1.0 Compatibility Promises](/terraform/language/v1-compatibility-promises). | ||
|
|
||
| ## Output Format | ||
|
|
||
| The following example is a representation of the human readable output that `terraform modules` returns. The nested structure represents the |
There was a problem hiding this comment.
I like putting the "what" first before diving into the example, but let me know what you think!
| The following example is a representation of the human readable output that `terraform modules` returns. The nested structure represents the | |
| The `terraform modules` command returns a nested structure, representing module composition and hierarchy within your configuration. | |
| The following example demonstrates what the `terraform modules` command returns without any additional flags: |
There was a problem hiding this comment.
(make sure to remove the line below if you accept this suggestion!
There was a problem hiding this comment.
Great job!
One inconsistency I was noticing between this cmd and other similar cmds that have have a json view is that when we pass the wrong argument for "-json", then we get different types of outputs. See picture:
I think the most accurate output from those 3 is the one for the "schema" cmd. The one for "show" is completely off, and the one for "modules" is slightly deceiving. Though the good thing is that it mentions that you can run "-help" and that is how the user can figure out that the proper argument is "-json".
But I was curious if you have a suggestion for a better error we could output instead "Too many command line arguments". This is not a blocker by the way. Aside from this question, I am happy with the output you have implemented, and I really like how the tree presents nested modules.
| Key string | ||
| Source addrs.ModuleSource | ||
| Version *version.Version | ||
| VersionConstraints version.Constraints |
| Children: manifest.Records, | ||
| }) | ||
|
|
||
| v.view.streams.Println(fmt.Sprintf("Modules declared by configuration:\n\n%s", printRoot.String())) |
There was a problem hiding this comment.
I noticed that this has one extra new line that the "providers" command. But that's okay. I kind of prefer two new lines than a single one.
Implements a human view for what was previously a machine readable view only command
terraform modules -json. The human view shows the nested hierarchy/composition of modules in configuration rather than the flat list given by the json alternative, as well as additional info about the provided version constraints for the module. Documentation and the command's help output has been updated in accordance with this addition.To accommodate this nested format, some reworking of
resolver.gohas been done to produce a manifest with a nested structure of records (whereas before a flat list was given).Target Release
1.11.x
Draft CHANGELOG entry
NEW FEATURES
terraform modulescommand.