cmds

package
v0.4.26 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2023 License: MIT Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
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)
	},
}
View Source
var MarkdownCmd = &cobra.Command{
	Use:   "markdown",
	Short: "Convert markdown data",
}

Functions

This section is empty.

Types

type CsvCommand added in v0.2.25

type CsvCommand struct {
	*cmds.CommandDescription
}

func NewCsvCommand added in v0.2.25

func NewCsvCommand() (*CsvCommand, error)

func (*CsvCommand) Run added in v0.2.25

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

type ExampleCommand added in v0.3.8

type ExampleCommand struct {
	*cmds.CommandDescription
}

func NewExampleCommand added in v0.3.8

func NewExampleCommand() (*ExampleCommand, error)

func (*ExampleCommand) Run added in v0.3.8

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 added in v0.2.10

type JsonCommand struct {
	*cmds.CommandDescription
}

func NewJsonCommand added in v0.2.10

func NewJsonCommand() (*JsonCommand, error)

func (*JsonCommand) Run added in v0.2.10

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

type YamlCommand added in v0.2.10

type YamlCommand struct {
	*cmds.CommandDescription
}

func NewYamlCommand added in v0.2.10

func NewYamlCommand() (*YamlCommand, error)

func (*YamlCommand) Run added in v0.2.10

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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