command

package

v0.12.0 Latest Latest Go to latest Published: Mar 6, 2024 License: MPL-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bflad/tfproviderdocs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Commands(ui cli.Ui) map[string]cli.CommandFactory
func ConfigureLogging(loggerName string, logLevel string)
func LogLevelFlag(flagSet *flag.FlagSet, varToSave *string)
func LogLevelFlagHelp(w *tabwriter.Writer)
type CheckCommand
type CheckCommandConfig
type VersionCommand

Constants ¶

View Source

const (
	LogLevelFlagHelpDefinition  = `-log-level=[TRACE|DEBUG|INFO|WARN|ERROR]`
	LogLevelFlagHelpDescription = `Log output level.`
)

View Source

const CommandHelpOptionFormat = "  %s\t%s\t\n"

Variables ¶

This section is empty.

Functions ¶

func Commands ¶

func Commands(ui cli.Ui) map[string]cli.CommandFactory

func ConfigureLogging ¶

func ConfigureLogging(loggerName string, logLevel string)

func LogLevelFlag ¶

func LogLevelFlag(flagSet *flag.FlagSet, varToSave *string)

func LogLevelFlagHelp ¶

func LogLevelFlagHelp(w *tabwriter.Writer)

Types ¶

type CheckCommand ¶

type CheckCommand struct {
	Ui cli.Ui
}

CheckCommand is a Command implementation

func (*CheckCommand) Help ¶

func (*CheckCommand) Help() string

func (*CheckCommand) Name ¶

func (c *CheckCommand) Name() string

func (*CheckCommand) Run ¶

func (c *CheckCommand) Run(args []string) int

func (*CheckCommand) Synopsis ¶

func (c *CheckCommand) Synopsis() string

type CheckCommandConfig ¶

type CheckCommandConfig struct {
	AllowedGuideSubcategories        string
	AllowedGuideSubcategoriesFile    string
	AllowedResourceSubcategories     string
	AllowedResourceSubcategoriesFile string
	EnableContentsCheck              bool
	IgnoreCdktfMissingFiles          bool
	IgnoreFileMismatchDataSources    string
	IgnoreFileMismatchFunctions      string
	IgnoreFileMismatchResources      string
	IgnoreFileMissingDataSources     string
	IgnoreFileMissingFunctions       string
	IgnoreFileMissingResources       string
	LogLevel                         string
	Path                             string
	ProviderName                     string
	ProviderSource                   string
	ProvidersSchemaJson              string
	RequireGuideSubcategory          bool
	RequireResourceSubcategory       bool
	RequireSchemaOrdering            bool
}

type VersionCommand ¶

type VersionCommand struct {
	Version *version.VersionInfo
	Ui      cli.Ui
}

VersionCommand is a Command implementation prints the version.

func (*VersionCommand) Help ¶

func (c *VersionCommand) Help() string

func (*VersionCommand) Name ¶

func (c *VersionCommand) Name() string

func (*VersionCommand) Run ¶

func (c *VersionCommand) Run(_ []string) int

func (*VersionCommand) Synopsis ¶

func (c *VersionCommand) Synopsis() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL