mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
3d39a94e39
Two new flags are added: '--default bool' and '--type bool' to control the visibility of Default and Type columns and section respectively in Markdown and AsciiDoc. Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
48 lines
1.8 KiB
Go
48 lines
1.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 markdown
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/terraform-docs/terraform-docs/cmd/markdown/document"
|
|
"github.com/terraform-docs/terraform-docs/cmd/markdown/table"
|
|
"github.com/terraform-docs/terraform-docs/internal/cli"
|
|
)
|
|
|
|
// NewCommand returns a new cobra.Command for 'markdown' formatter
|
|
func NewCommand(config *cli.Config) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Args: cobra.ExactArgs(1),
|
|
Use: "markdown [PATH]",
|
|
Aliases: []string{"md"},
|
|
Short: "Generate Markdown of inputs and outputs",
|
|
Annotations: cli.Annotations("markdown"),
|
|
PreRunE: cli.PreRunEFunc(config),
|
|
RunE: cli.RunEFunc(config),
|
|
}
|
|
|
|
// flags
|
|
cmd.PersistentFlags().BoolVar(&config.Settings.Anchor, "anchor", true, "create anchor links")
|
|
cmd.PersistentFlags().BoolVar(&config.Settings.Default, "default", true, "show Default column or section")
|
|
cmd.PersistentFlags().BoolVar(&config.Settings.Escape, "escape", true, "escape special characters")
|
|
cmd.PersistentFlags().IntVar(&config.Settings.Indent, "indent", 2, "indention level of Markdown sections [1, 2, 3, 4, 5]")
|
|
cmd.PersistentFlags().BoolVar(&config.Settings.Required, "required", true, "show Required column or section")
|
|
cmd.PersistentFlags().BoolVar(&config.Settings.Sensitive, "sensitive", true, "show Sensitive column or section")
|
|
cmd.PersistentFlags().BoolVar(&config.Settings.Type, "type", true, "show Type column or section")
|
|
|
|
// subcommands
|
|
cmd.AddCommand(document.NewCommand(config))
|
|
cmd.AddCommand(table.NewCommand(config))
|
|
|
|
return cmd
|
|
}
|