generators

Documentation

Index

• Constants
• Variables
• func FormatCommand(c *Command)
• func FormatDescription(input string) string
• func FormatExample(input string) string
• func GenerateFiles()
• func NormalizeSpec(spec *PulsarctlSpec)
• func WriteCategoryFile(c Category)
• func WriteCommandFile(manifest *Manifest, t *template.Template, params TopLevelCommand)
• func WriteCommandFiles(manifest *Manifest, toc ToC, params PulsarctlSpec)
• func WriteManifest(manifest *Manifest)
• type Category
• type Command
  • func NewCommand(c *cobra.Command, path string) *Command
• type Commands
  • func NewSubCommands(c *cobra.Command, path string) Commands
  • func (a Commands) Len() int
  • func (a Commands) Less(i, j int) bool
  • func (a Commands) Swap(i, j int)
• type Doc
• type Manifest
• type Option
• type Options
  • func NewOptions(flags *pflag.FlagSet) Options
  • func (a Options) Len() int
  • func (a Options) Less(i, j int) bool
  • func (a Options) Swap(i, j int)
• type PulsarctlSpec
  • func GetSpec() PulsarctlSpec
  • func NewPulsarctlSpec(c *cobra.Command) PulsarctlSpec
• type ToC
• type TopLevelCommand
  • func NewTopLevelCommand(c *cobra.Command) TopLevelCommand
• type TopLevelCommands
  • func NewTopLevelCommands(cs []*cobra.Command) TopLevelCommands
  • func (a TopLevelCommands) Len() int
  • func (a TopLevelCommands) Less(i, j int) bool
  • func (a TopLevelCommands) Swap(i, j int)

Constants

const JSONOutputFile = "manifest.json"

Variables

var CategoryTemplate = `
# <strong>{{.Name}}</strong>
`

var CommandTemplate = `
------------

# {{.MainCommand.Name}}

{{.MainCommand.Example}}

{{.MainCommand.Description}}

### Usage

` + "`" + `$ {{.MainCommand.Usage}}` + "`" + `

{{if .MainCommand.Options}}

### Flags

Name | Shorthand | Default | Usage
---- | --------- | ------- | ----- {{range $option := .MainCommand.Options}}
{{$option.Name}} | {{$option.Shorthand}} | {{$option.DefaultValue}} | {{$option.Usage}} {{end}}
{{end}}
{{range $sub := .SubCommands}}
------------

## <em>{{$sub.Path}}</em>

{{$sub.Example}}

{{$sub.Description}}

### Usage

` + "`" + `$ {{$sub.Usage}}` + "`" + `

{{if $sub.Options}}

### Flags

Name | Shorthand | Default | Usage
---- | --------- | ------- | ----- {{range $option := $sub.Options}}
{{$option.Name}} | {{$option.Shorthand}} | {{$option.DefaultValue}} | {{$option.Usage}} {{end}}
{{end}}

{{end}}

`

var GenPulsarctlDir = flag.String("gen-pulsarctl-dir", "site/gen-pulsarctldocs/generators",
	"Directory containing pulsarctl files")

var PulsarVersion = flag.String("pulsar-version", "", "Version of Pulsar to generate docs for.")

Functions

func FormatCommand

func FormatCommand(c *Command)

func FormatDescription

func FormatDescription(input string) string

func FormatExample

func FormatExample(input string) string

func GenerateFiles

func GenerateFiles()

func NormalizeSpec

func NormalizeSpec(spec *PulsarctlSpec)

func WriteCategoryFile

func WriteCategoryFile(c Category)

func WriteCommandFile

func WriteCommandFile(manifest *Manifest, t *template.Template, params TopLevelCommand)

func WriteCommandFiles

func WriteCommandFiles(manifest *Manifest, toc ToC, params PulsarctlSpec)

func WriteManifest

func WriteManifest(manifest *Manifest)

Types

type Category

type Category struct {
	Name     string   `yaml:",omitempty"`
	Commands []string `yaml:",omitempty"`
	Include  string   `yaml:",omitempty"`
}

type Command

type Command struct {
	Name             string   `yaml:",omitempty"`
	Path             string   `yaml:",omitempty"`
	Synopsis         string   `yaml:",omitempty"`
	Description      string   `yaml:",omitempty"`
	Options          Options  `yaml:",omitempty"`
	InheritedOptions Options  `yaml:"inherited_options,omitempty"`
	Example          string   `yaml:",omitempty"`
	SeeAlso          []string `yaml:"see_also,omitempty"`
	Usage            string   `yaml:",omitempty"`
}

func NewCommand

func NewCommand(c *cobra.Command, path string) *Command

type Commands

type Commands []*Command

func NewSubCommands

func NewSubCommands(c *cobra.Command, path string) Commands

Parse the Commands

func (Commands) Len

func (a Commands) Len() int

func (Commands) Less

func (a Commands) Less(i, j int) bool

func (Commands) Swap

func (a Commands) Swap(i, j int)

type Doc

type Doc struct {
	Filename string `json:"filename,omitempty"`
}

type Manifest

type Manifest struct {
	Docs      []Doc  `json:"docs,omitempty"`
	Title     string `json:"title,omitempty"`
	Copyright string `json:"copyright,omitempty"`
}

type Option

type Option struct {
	Name         string `yaml:",omitempty"`
	Shorthand    string `yaml:",omitempty"`
	DefaultValue string `yaml:"default_value,omitempty"`
	Usage        string `yaml:",omitempty"`
}

type Options

type Options []*Option

func NewOptions

func NewOptions(flags *pflag.FlagSet) Options

Parse the Options

func (Options) Len

func (a Options) Len() int

func (Options) Less

func (a Options) Less(i, j int) bool

func (Options) Swap

func (a Options) Swap(i, j int)

type PulsarctlSpec

type PulsarctlSpec struct {
	TopLevelCommandGroups []TopLevelCommands `yaml:",omitempty"`
}

func GetSpec

func GetSpec() PulsarctlSpec

func NewPulsarctlSpec

func NewPulsarctlSpec(c *cobra.Command) PulsarctlSpec

type ToC

type ToC struct {
	Categories []Category `yaml:",omitempty"`
}

type TopLevelCommand

type TopLevelCommand struct {
	MainCommand *Command `yaml:",omitempty"`
	SubCommands Commands `yaml:",omitempty"`
}

func NewTopLevelCommand

func NewTopLevelCommand(c *cobra.Command) TopLevelCommand

type TopLevelCommands

type TopLevelCommands struct {
	Commands []TopLevelCommand `yaml:",omitempty"`
}

func NewTopLevelCommands

func NewTopLevelCommands(cs []*cobra.Command) TopLevelCommands

func (TopLevelCommands) Len

func (a TopLevelCommands) Len() int

func (TopLevelCommands) Less

func (a TopLevelCommands) Less(i, j int) bool

func (TopLevelCommands) Swap

func (a TopLevelCommands) Swap(i, j int)