cmds

Documentation

Index

• Variables
• type CsvCommand
  • func NewCsvCommand() (*CsvCommand, error)
  • func (c *CsvCommand) Run(ctx context.Context, parsedLayers map[string]*layers.ParsedParameterLayer, ...) error
• type ExampleCommand
  • func NewExampleCommand() (*ExampleCommand, error)
  • func (c *ExampleCommand) Run(ctx context.Context, parsedLayers map[string]*layers.ParsedParameterLayer, ...) error
• type ExtensionFlag
• type JsonCommand
  • func NewJsonCommand() (*JsonCommand, error)
  • func (j *JsonCommand) Run(ctx context.Context, parsedLayers map[string]*layers.ParsedParameterLayer, ...) error
• type YamlCommand
  • func NewYamlCommand() (*YamlCommand, error)
  • func (y *YamlCommand) Run(ctx context.Context, _ map[string]*layers.ParsedParameterLayer, ...) error

Variables

var DocsCmd = &cobra.Command{
	Use:   "docs [flags] file [file...]",
	Short: "Work with help documents",
	Args:  cobra.MinimumNArgs(1),
	Run: func(cmd *cobra.Command, args []string) {
		ctx := cmd.Context()
		gp, _, err := cli.CreateGlazedProcessorFromCobra(cmd)
		cobra.CheckErr(err)

		for _, arg := range args {

			s, err := os.ReadFile(arg)
			cobra.CheckErr(err)

			var metaData types.Row
			inputReader := bytes.NewReader(s)
			_, err = frontmatter.Parse(inputReader, &metaData)
			cobra.CheckErr(err)

			metaData.Set("path", arg)

			err = gp.AddRow(ctx, metaData)
			cobra.CheckErr(err)
		}

		err = gp.Close(ctx)
		if _, ok := err.(*cmds.ExitWithoutGlazeError); ok {
			os.Exit(0)
		}
		cobra.CheckErr(err)
	},
}

var MarkdownCmd = &cobra.Command{
	Use:   "markdown",
	Short: "Convert markdown data",
}

Types

type CsvCommand

type CsvCommand struct {
	*cmds.CommandDescription
}

func NewCsvCommand

func NewCsvCommand() (*CsvCommand, error)

func (*CsvCommand) Run

func (c *CsvCommand) Run(
	ctx context.Context,
	parsedLayers map[string]*layers.ParsedParameterLayer,
	ps map[string]interface{},
	gp middlewares.Processor,
) error

type ExampleCommand

type ExampleCommand struct {
	*cmds.CommandDescription
}

func NewExampleCommand

func NewExampleCommand() (*ExampleCommand, error)

func (*ExampleCommand) Run

func (c *ExampleCommand) Run(
	ctx context.Context,
	parsedLayers map[string]*layers.ParsedParameterLayer,
	ps map[string]interface{},
	gp middlewares.Processor,
) error

Run is called to actually execute the command.

parsedLayers contains the result of parsing each layer that has been registered with the command description. These layers can be glazed structured data flags, database connection parameters, application specification parameters.

ps is a convenience map containing *all* parsed flags.

gp is a GlazeProcessor that can be used to emit rows. Each row is an ordered map.

type ExtensionFlag

type ExtensionFlag struct {
	FlagName string
	FlagDesc string
	Extender goldmark.Extender
}

type JsonCommand

type JsonCommand struct {
	*cmds.CommandDescription
}

func NewJsonCommand

func NewJsonCommand() (*JsonCommand, error)

func (*JsonCommand) Run

func (j *JsonCommand) Run(
	ctx context.Context,
	parsedLayers map[string]*layers.ParsedParameterLayer,
	ps map[string]interface{},
	gp middlewares.Processor,
) error

type YamlCommand

type YamlCommand struct {
	*cmds.CommandDescription
}

func NewYamlCommand

func NewYamlCommand() (*YamlCommand, error)

func (*YamlCommand) Run

func (y *YamlCommand) Run(
	ctx context.Context,
	_ map[string]*layers.ParsedParameterLayer,
	ps map[string]interface{},
	gp middlewares.Processor,
) error