Directories
¶
| Path | Synopsis |
|---|---|
|
Package annotation provides a thin internal wrapper around custom annotations that the cli package and subpackages use.
|
Package annotation provides a thin internal wrapper around custom annotations that the cli package and subpackages use. |
|
Package arity parses a small specification language describing how many positional arguments a command may accept.
|
Package arity parses a small specification language describing how many positional arguments a command may accept. |
|
Package clictx manages context storage for the CLI
|
Package clictx manages context storage for the CLI |
|
Package spec turns a declarative YAML command specification into a runnable github.com/spf13/cobra.Command tree.
|
Package spec turns a declarative YAML command specification into a runnable github.com/spf13/cobra.Command tree. |
|
spectest
Package spectest provides spec.Runner test doubles for exercising code that builds and executes command specifications.
|
Package spectest provides spec.Runner test doubles for exercising code that builds and executes command specifications. |
|
Package strcase converts strings between casing conventions such as PascalCase, camelCase, kebab-case, snake_case, and SCREAMING_SNAKE_CASE.
|
Package strcase converts strings between casing conventions such as PascalCase, camelCase, kebab-case, snake_case, and SCREAMING_SNAKE_CASE. |
|
Package template wires the CLI's output renderers to cobra.
|
Package template wires the CLI's output renderers to cobra. |
|
help
Package help renders group-organised help output for a github.com/spf13/cobra.Command.
|
Package help renders group-organised help output for a github.com/spf13/cobra.Command. |
|
help/helptest
Package helptest provides a fixed command hierarchy used to exercise the help renderer.
|
Package helptest provides a fixed command hierarchy used to exercise the help renderer. |
|
panichandler
Package panichandler renders a report describing an uncaught panic: the error message, the stack trace, and an optional invitation to file an issue.
|
Package panichandler renders a report describing an uncaught panic: the error message, the stack trace, and an optional invitation to file an issue. |
|
plain
Package plain reduces richtext markup to the text a richtext writer emits when colour is disabled.
|
Package plain reduces richtext markup to the text a richtext writer emits when colour is disabled. |
|
tag
Package tag builds the richtext markup that the CLI's output templates and renderers emit.
|
Package tag builds the richtext markup that the CLI's output templates and renderers emit. |
|
tmplfuncs
Package tmplfuncs centralizes the functions available to the CLI's output templates.
|
Package tmplfuncs centralizes the functions available to the CLI's output templates. |
|
usage
Package usage renders the short advisory shown when a command is used incorrectly.
|
Package usage renders the short advisory shown when a command is used incorrectly. |
|
usage/usagetest
Package usagetest provides the shared command fixtures used by the usage renderer's golden test and its generator.
|
Package usagetest provides the shared command fixtures used by the usage renderer's golden test and its generator. |
|
version
Package version renders the CLI's --version output.
|
Package version renders the CLI's --version output. |
|
version/versiontest
Package versiontest provides the shared fixtures used by the version renderer's golden test and its generator.
|
Package versiontest provides the shared fixtures used by the version renderer's golden test and its generator. |
|
Package term provides utilities for inspecting and controlling the terminal a command's streams are attached to.
|
Package term provides utilities for inspecting and controlling the terminal a command's streams are attached to. |
|
cursor
Package cursor provides cursor movement functionality within a terminal
|
Package cursor provides cursor movement functionality within a terminal |
|
termtest
Package termtest provides test doubles for the abstractions in the github.com/bitwizeshift/go-cli/internal/term package.
|
Package termtest provides test doubles for the abstractions in the github.com/bitwizeshift/go-cli/internal/term package. |
Click to show internal directories.
Click to hide internal directories.