plugprint

package

v0.0.0-...-289cda9 Latest Latest Go to latest Published: Apr 5, 2020 License: MIT Imports: 10 Imported by: 13

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/gobuffalo/plugins

Links

Open Source Insights

Documentation ¶

Index ¶

func Print(w io.Writer, main plugins.Plugin) error
type Aliaser
type CommandNamer
type Describer
type FlagPrinter
type Hider
type PluginScoper
type SubCommander
type UsagePrinter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Print ¶

func Print(w io.Writer, main plugins.Plugin) error

Print will try and print a helpful Usage printing of the plugin and any plugins that are provided.

$ buffalo
---------

Usage of buffalo:
-h, --help   print this help

Available Commands:
	buffalo fix      Attempt to fix a Buffalo application's API to match version in go.mod
	buffalo info     Print diagnostic information (useful for debugging)
	buffalo version  Print the version information

Types ¶

type Aliaser ¶

type Aliaser = plugcmd.Aliaser

type CommandNamer ¶

type CommandNamer = plugcmd.Namer

type Describer ¶

type Describer interface {
	Description() string
}

Describer is called by `Print` and can be implemented to print a short, single line, description of the plugin. `-h`

type FlagPrinter ¶

type FlagPrinter interface {
	PrintFlags(w io.Writer) error
}

type Hider ¶

type Hider interface {
	HidePlugin()
}

type PluginScoper ¶

type PluginScoper = plugins.Scoper

type SubCommander ¶

type SubCommander = plugcmd.SubCommander

type UsagePrinter ¶

type UsagePrinter interface {
	PrintUsage(w io.Writer) error
}

UsagePrinter is called by `Print` and can be implemented to print a large block of usage information after the `Describer` interface is called. This is useful for printing flag information, links, and other messages to users.

Source Files ¶

View all Source files

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