mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
8c531b6544
As of `v0.13.0` flags `--show-all` and `--hide-all` are deprecated in
favor of explicit use of `--show` and `--hide`. In other words when
`--show <section>` is used, only `<section>` will be shown. If you want
to show multiple sections and hide the rest you can specify multiple
`--show` flags. The same logic is also applied to `--hide`.
# show 'inputs' and hide everything else
$ terraform-docs --show inputs <formatter>
# show 'inputs' and show 'outputs' and hide everything else
$ terraform-docs --show inputs --show outputs <formatter>
# hide 'header' and show everything else
$ terraform-docs --hide header <formatter>
# hide 'header' and hide 'providers' and show everything else
$ terraform-docs --hide header --hide providers <formatter>
Note: Using `--show` or `--hide` CLI flag will completely override the
values from `.terraform-docs.yml`. Example:
$ cat .terraform-docs.yml
sections:
show:
- inputs
- outputs
# example 1: this will only show 'providers'
$ terraform-docs --show providers .
# example 2: this will hide 'inputs' and hide 'providers' and show everything else
$ terraform-docs --hide inputs --hide providers .
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
105 lines
4.8 KiB
Go
105 lines
4.8 KiB
Go
/*
|
|
Copyright 2021 The terraform-docs Authors.
|
|
|
|
Licensed under the MIT license (the "License"); you may not
|
|
use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at the LICENSE file in
|
|
the root directory of this source tree.
|
|
*/
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/terraform-docs/terraform-docs/cmd/asciidoc"
|
|
"github.com/terraform-docs/terraform-docs/cmd/completion"
|
|
"github.com/terraform-docs/terraform-docs/cmd/json"
|
|
"github.com/terraform-docs/terraform-docs/cmd/markdown"
|
|
"github.com/terraform-docs/terraform-docs/cmd/pretty"
|
|
"github.com/terraform-docs/terraform-docs/cmd/tfvars"
|
|
"github.com/terraform-docs/terraform-docs/cmd/toml"
|
|
"github.com/terraform-docs/terraform-docs/cmd/version"
|
|
"github.com/terraform-docs/terraform-docs/cmd/xml"
|
|
"github.com/terraform-docs/terraform-docs/cmd/yaml"
|
|
"github.com/terraform-docs/terraform-docs/internal/cli"
|
|
)
|
|
|
|
// Execute adds all child commands to the root command and sets flags appropriately.
|
|
// This is called by main.main(). It only needs to happen once to the rootCmd.
|
|
func Execute() error {
|
|
if err := NewCommand().Execute(); err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error: %s\n", err.Error())
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// NewCommand returns a new cobra.Command for 'root' command
|
|
func NewCommand() *cobra.Command {
|
|
config := cli.DefaultConfig()
|
|
cmd := &cobra.Command{
|
|
Args: cobra.MaximumNArgs(1),
|
|
Use: "terraform-docs [PATH]",
|
|
Short: "A utility to generate documentation from Terraform modules in various output formats",
|
|
Long: "A utility to generate documentation from Terraform modules in various output formats",
|
|
Version: version.Full(),
|
|
SilenceUsage: true,
|
|
SilenceErrors: true,
|
|
Annotations: cli.Annotations("root"),
|
|
PreRunE: cli.PreRunEFunc(config),
|
|
RunE: cli.RunEFunc(config),
|
|
}
|
|
|
|
// flags
|
|
cmd.PersistentFlags().StringVarP(&config.File, "config", "c", ".terraform-docs.yml", "config file name")
|
|
|
|
cmd.PersistentFlags().StringSliceVar(&config.Sections.Show, "show", []string{}, "show section ["+cli.AllSections+"]")
|
|
cmd.PersistentFlags().StringSliceVar(&config.Sections.Hide, "hide", []string{}, "hide section ["+cli.AllSections+"]")
|
|
|
|
cmd.PersistentFlags().StringVar(&config.Output.File, "output-file", "", "File in module directory to insert output into (default \"\")")
|
|
cmd.PersistentFlags().StringVar(&config.Output.Mode, "output-mode", "inject", "Output to file method ["+cli.OutputModes+"]")
|
|
cmd.PersistentFlags().StringVar(&config.Output.Template, "output-template", cli.OutputTemplate, "Output template")
|
|
|
|
cmd.PersistentFlags().BoolVar(&config.Sort.Enabled, "sort", true, "sort items")
|
|
cmd.PersistentFlags().StringVar(&config.Sort.By, "sort-by", "name", "sort items by criteria ["+cli.SortTypes+"]")
|
|
|
|
// deprecated flags ==>
|
|
cmd.PersistentFlags().BoolVar(new(bool), "show-all", true, "show all sections")
|
|
cmd.PersistentFlags().BoolVar(new(bool), "hide-all", false, "hide all sections (default false)")
|
|
cmd.PersistentFlags().MarkDeprecated("show-all", "more information: https://terraform-docs.io/user-guide/how-to/#visibility-of-sections\n\n") //nolint:errcheck,gosec
|
|
cmd.PersistentFlags().MarkDeprecated("hide-all", "more information: https://terraform-docs.io/user-guide/how-to/#visibility-of-sections\n\n") //nolint:errcheck,gosec
|
|
|
|
cmd.PersistentFlags().BoolVar(&config.Sort.Criteria.Required, "sort-by-required", false, "sort items by name and print required ones first (default false)")
|
|
cmd.PersistentFlags().BoolVar(&config.Sort.Criteria.Type, "sort-by-type", false, "sort items by type of them (default false)")
|
|
cmd.PersistentFlags().MarkDeprecated("sort-by-required", "use '--sort-by required' instead\n\n") //nolint:errcheck,gosec
|
|
cmd.PersistentFlags().MarkDeprecated("sort-by-type", "use '--sort-by type' instead\n\n") //nolint:errcheck,gosec
|
|
// <==
|
|
|
|
cmd.PersistentFlags().StringVar(&config.HeaderFrom, "header-from", "main.tf", "relative path of a file to read header from")
|
|
cmd.PersistentFlags().StringVar(&config.FooterFrom, "footer-from", "", "relative path of a file to read footer from (default \"\")")
|
|
|
|
cmd.PersistentFlags().BoolVar(&config.OutputValues.Enabled, "output-values", false, "inject output values into outputs (default false)")
|
|
cmd.PersistentFlags().StringVar(&config.OutputValues.From, "output-values-from", "", "inject output values from file into outputs (default \"\")")
|
|
|
|
// formatter subcommands
|
|
cmd.AddCommand(asciidoc.NewCommand(config))
|
|
cmd.AddCommand(json.NewCommand(config))
|
|
cmd.AddCommand(markdown.NewCommand(config))
|
|
cmd.AddCommand(pretty.NewCommand(config))
|
|
cmd.AddCommand(tfvars.NewCommand(config))
|
|
cmd.AddCommand(toml.NewCommand(config))
|
|
cmd.AddCommand(xml.NewCommand(config))
|
|
cmd.AddCommand(yaml.NewCommand(config))
|
|
|
|
// other subcommands
|
|
cmd.AddCommand(completion.NewCommand())
|
|
cmd.AddCommand(version.NewCommand())
|
|
|
|
return cmd
|
|
}
|