help

Documentation

Overview

Package help contains functions responsible for generating help output for asdf and asdf plugins.

Index

• func Print(asdfVersion string, plugins []plugins.Plugin) error
• func PrintTool(conf config.Config, toolName string) error
• func PrintToolVersion(conf config.Config, toolName, toolVersion string) error
• func Write(asdfVersion string, allPlugins []plugins.Plugin, writer io.Writer) error
• func WriteToolHelp(conf config.Config, toolName string, writer io.Writer, errWriter io.Writer) error
• func WriteToolVersionHelp(conf config.Config, toolName, toolVersion string, writer io.Writer, ...) error

Functions

func Print

func Print(asdfVersion string, plugins []plugins.Plugin) error

Print help output to STDOUT

func PrintTool

func PrintTool(conf config.Config, toolName string) error

PrintTool write tool help output to STDOUT

func PrintToolVersion

func PrintToolVersion(conf config.Config, toolName, toolVersion string) error

PrintToolVersion write help for specific tool version to STDOUT

func Write

func Write(asdfVersion string, allPlugins []plugins.Plugin, writer io.Writer) error

Write help output to an io.Writer

func WriteToolHelp

func WriteToolHelp(conf config.Config, toolName string, writer io.Writer, errWriter io.Writer) error

WriteToolHelp output to an io.Writer

func WriteToolVersionHelp

func WriteToolVersionHelp(conf config.Config, toolName, toolVersion string, writer io.Writer, errWriter io.Writer) error

WriteToolVersionHelp output to an io.Writer