Skip to content

Commit d77324c

Browse files
khos2owkhos2ow
committed
Add new '--show all' and '--hide all' sections
New psuedo section `all` is added and can be used to show or hide _all_ sections. This can be used as a replacement for, now, deprecated and removed `--show-all` and `--hide-all` flags. Signed-off-by: Khosrow Moossavi <[email protected]>
1 parent 25f03b4 commit d77324c

File tree

18 files changed

+83
-80
lines changed

18 files changed

+83
-80
lines changed

‎cmd/root.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ func NewCommand() *cobra.Command {
6262
cmd.PersistentFlags().StringSliceVar(&config.Sections.Show, "show", []string{}, "show section ["+cli.AllSections+"]")
6363
cmd.PersistentFlags().StringSliceVar(&config.Sections.Hide, "hide", []string{}, "hide section ["+cli.AllSections+"]")
6464

65-
cmd.PersistentFlags().StringVar(&config.Output.File, "output-file", "", "File path to insert output into (default \"\")")
66-
cmd.PersistentFlags().StringVar(&config.Output.Mode, "output-mode", "inject", "Output to file method ["+cli.OutputModes+"]")
67-
cmd.PersistentFlags().StringVar(&config.Output.Template, "output-template", cli.OutputTemplate, "Output template")
65+
cmd.PersistentFlags().StringVar(&config.Output.File, "output-file", "", "file path to insert output into (default \"\")")
66+
cmd.PersistentFlags().StringVar(&config.Output.Mode, "output-mode", "inject", "output to file method ["+cli.OutputModes+"]")
67+
cmd.PersistentFlags().StringVar(&config.Output.Template, "output-template", cli.OutputTemplate, "output template")
6868

6969
cmd.PersistentFlags().BoolVar(&config.Sort.Enabled, "sort", true, "sort items")
7070
cmd.PersistentFlags().StringVar(&config.Sort.By, "sort-by", "name", "sort items by criteria ["+cli.SortTypes+"]")

‎docs/reference/asciidoc-document.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ terraform-docs asciidoc document [PATH] [flags]
3030
--default show Default column or section (default true)
3131
--footer-from string relative path of a file to read footer from (default "")
3232
--header-from string relative path of a file to read header from (default "main.tf")
33-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
33+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
3434
--indent int indention level of AsciiDoc sections [1, 2, 3, 4, 5] (default 2)
35-
--output-file string File path to insert output into (default "")
36-
--output-mode string Output to file method [inject, replace] (default "inject")
37-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
35+
--output-file string file path to insert output into (default "")
36+
--output-mode string output to file method [inject, replace] (default "inject")
37+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
3838
--output-values inject output values into outputs (default false)
3939
--output-values-from string inject output values from file into outputs (default "")
4040
--required show Required column or section (default true)
4141
--sensitive show Sensitive column or section (default true)
42-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
42+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
4343
--sort sort items (default true)
4444
--sort-by string sort items by criteria [name, required, type] (default "name")
4545
--type show Type column or section (default true)

‎docs/reference/asciidoc-table.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ terraform-docs asciidoc table [PATH] [flags]
3030
--default show Default column or section (default true)
3131
--footer-from string relative path of a file to read footer from (default "")
3232
--header-from string relative path of a file to read header from (default "main.tf")
33-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
33+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
3434
--indent int indention level of AsciiDoc sections [1, 2, 3, 4, 5] (default 2)
35-
--output-file string File path to insert output into (default "")
36-
--output-mode string Output to file method [inject, replace] (default "inject")
37-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
35+
--output-file string file path to insert output into (default "")
36+
--output-mode string output to file method [inject, replace] (default "inject")
37+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
3838
--output-values inject output values into outputs (default false)
3939
--output-values-from string inject output values from file into outputs (default "")
4040
--required show Required column or section (default true)
4141
--sensitive show Sensitive column or section (default true)
42-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
42+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
4343
--sort sort items (default true)
4444
--sort-by string sort items by criteria [name, required, type] (default "name")
4545
--type show Type column or section (default true)

‎docs/reference/asciidoc.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ terraform-docs asciidoc [PATH] [flags]
3434
-c, --config string config file name (default ".terraform-docs.yml")
3535
--footer-from string relative path of a file to read footer from (default "")
3636
--header-from string relative path of a file to read header from (default "main.tf")
37-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
38-
--output-file string File path to insert output into (default "")
39-
--output-mode string Output to file method [inject, replace] (default "inject")
40-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
37+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
38+
--output-file string file path to insert output into (default "")
39+
--output-mode string output to file method [inject, replace] (default "inject")
40+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
4141
--output-values inject output values into outputs (default false)
4242
--output-values-from string inject output values from file into outputs (default "")
43-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
43+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
4444
--sort sort items (default true)
4545
--sort-by string sort items by criteria [name, required, type] (default "name")
4646
```

‎docs/reference/json.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ terraform-docs json [PATH] [flags]
2929
-c, --config string config file name (default ".terraform-docs.yml")
3030
--footer-from string relative path of a file to read footer from (default "")
3131
--header-from string relative path of a file to read header from (default "main.tf")
32-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
33-
--output-file string File path to insert output into (default "")
34-
--output-mode string Output to file method [inject, replace] (default "inject")
35-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
32+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
33+
--output-file string file path to insert output into (default "")
34+
--output-mode string output to file method [inject, replace] (default "inject")
35+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
3636
--output-values inject output values into outputs (default false)
3737
--output-values-from string inject output values from file into outputs (default "")
38-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
38+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
3939
--sort sort items (default true)
4040
--sort-by string sort items by criteria [name, required, type] (default "name")
4141
```

‎docs/reference/markdown-document.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,17 @@ terraform-docs markdown document [PATH] [flags]
3131
--escape escape special characters (default true)
3232
--footer-from string relative path of a file to read footer from (default "")
3333
--header-from string relative path of a file to read header from (default "main.tf")
34-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
34+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
3535
--html use HTML tags in genereted output (default true)
3636
--indent int indention level of Markdown sections [1, 2, 3, 4, 5] (default 2)
37-
--output-file string File path to insert output into (default "")
38-
--output-mode string Output to file method [inject, replace] (default "inject")
39-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
37+
--output-file string file path to insert output into (default "")
38+
--output-mode string output to file method [inject, replace] (default "inject")
39+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
4040
--output-values inject output values into outputs (default false)
4141
--output-values-from string inject output values from file into outputs (default "")
4242
--required show Required column or section (default true)
4343
--sensitive show Sensitive column or section (default true)
44-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
44+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
4545
--sort sort items (default true)
4646
--sort-by string sort items by criteria [name, required, type] (default "name")
4747
--type show Type column or section (default true)

‎docs/reference/markdown-table.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,17 @@ terraform-docs markdown table [PATH] [flags]
3131
--escape escape special characters (default true)
3232
--footer-from string relative path of a file to read footer from (default "")
3333
--header-from string relative path of a file to read header from (default "main.tf")
34-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
34+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
3535
--html use HTML tags in genereted output (default true)
3636
--indent int indention level of Markdown sections [1, 2, 3, 4, 5] (default 2)
37-
--output-file string File path to insert output into (default "")
38-
--output-mode string Output to file method [inject, replace] (default "inject")
39-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
37+
--output-file string file path to insert output into (default "")
38+
--output-mode string output to file method [inject, replace] (default "inject")
39+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
4040
--output-values inject output values into outputs (default false)
4141
--output-values-from string inject output values from file into outputs (default "")
4242
--required show Required column or section (default true)
4343
--sensitive show Sensitive column or section (default true)
44-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
44+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
4545
--sort sort items (default true)
4646
--sort-by string sort items by criteria [name, required, type] (default "name")
4747
--type show Type column or section (default true)

‎docs/reference/markdown.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ terraform-docs markdown [PATH] [flags]
3636
-c, --config string config file name (default ".terraform-docs.yml")
3737
--footer-from string relative path of a file to read footer from (default "")
3838
--header-from string relative path of a file to read header from (default "main.tf")
39-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
40-
--output-file string File path to insert output into (default "")
41-
--output-mode string Output to file method [inject, replace] (default "inject")
42-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
39+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
40+
--output-file string file path to insert output into (default "")
41+
--output-mode string output to file method [inject, replace] (default "inject")
42+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
4343
--output-values inject output values into outputs (default false)
4444
--output-values-from string inject output values from file into outputs (default "")
45-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
45+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
4646
--sort sort items (default true)
4747
--sort-by string sort items by criteria [name, required, type] (default "name")
4848
```

‎docs/reference/pretty.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ terraform-docs pretty [PATH] [flags]
2929
-c, --config string config file name (default ".terraform-docs.yml")
3030
--footer-from string relative path of a file to read footer from (default "")
3131
--header-from string relative path of a file to read header from (default "main.tf")
32-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
33-
--output-file string File path to insert output into (default "")
34-
--output-mode string Output to file method [inject, replace] (default "inject")
35-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
32+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
33+
--output-file string file path to insert output into (default "")
34+
--output-mode string output to file method [inject, replace] (default "inject")
35+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
3636
--output-values inject output values into outputs (default false)
3737
--output-values-from string inject output values from file into outputs (default "")
38-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
38+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
3939
--sort sort items (default true)
4040
--sort-by string sort items by criteria [name, required, type] (default "name")
4141
```

‎docs/reference/terraform-docs.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ terraform-docs [PATH] [flags]
2323
--footer-from string relative path of a file to read footer from (default "")
2424
--header-from string relative path of a file to read header from (default "main.tf")
2525
-h, --help help for terraform-docs
26-
--hide strings hide section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
27-
--output-file string File path to insert output into (default "")
28-
--output-mode string Output to file method [inject, replace] (default "inject")
29-
--output-template string Output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
26+
--hide strings hide section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
27+
--output-file string file path to insert output into (default "")
28+
--output-mode string output to file method [inject, replace] (default "inject")
29+
--output-template string output template (default "<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->")
3030
--output-values inject output values into outputs (default false)
3131
--output-values-from string inject output values from file into outputs (default "")
32-
--show strings show section [data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
32+
--show strings show section [all, data-sources, footer, header, inputs, modules, outputs, providers, requirements, resources]
3333
--sort sort items (default true)
3434
--sort-by string sort items by criteria [name, required, type] (default "name")
3535
```

0 commit comments

Comments
 (0)