cmd

Documentation

Index

• Constants
• Variables
• func DocFilePrepender(filename string) string
• func Execute()
• func WriteItems(items []*api.Item, opts WriteItemsOption) error
• type ConvertCommand
  • func NewConvertCommand() *ConvertCommand
  • func (c *ConvertCommand) Execute(_ *cobra.Command, args []string) error
• type DocsCommand
  • func NewDocsCommand() *DocsCommand
  • func (c *DocsCommand) Execute(_ *cobra.Command, _ []string) error
• type MigrateCommand
  • func NewMigrateCommand() *MigrateCommand
  • func (mc *MigrateCommand) Execute(_ *cobra.Command, _ []string) error
• type SyncCommand
  • func NewSyncCommand() *SyncCommand
  • func (c *SyncCommand) RunE(cmd *cobra.Command, args []string) error
• type SyncCommandOptions
• type WriteItemsOption

Constants

const (
	ArgOutput          = "output"
	ArgOutputShorthand = "o"

	ArgFormat          = "format"
	ArgFormatShorthand = "f"

	ArgPretty          = "pretty"
	ArgPrettyShorthand = "p"

	ArgSingleFile          = "single-file"
	ArgSingleFileShorthand = "s"

	FormatJSON = "json"
	FormatYAML = "yaml"

	TitleProperty = "title"
)

const (
	ArgsVerbose          = "verbose"
	ArgsVerboseShorthand = "v"
)

const (
	ArgSourceType = "source-type"
	ArgLiveMode   = "live"
	ArgServerURL  = "server"
)

const (
	DocsCommandsFolder = "./docs/commands"
)

Variables

var (
	ErrArgumentInvalid = errors.New("argument is invalid")
	ErrInvalidFormat   = errors.New("invalid format")
)

Functions

func DocFilePrepender

func DocFilePrepender(filename string) string

TODO: Consider moving this to package.

func Execute

func Execute()

func WriteItems

func WriteItems(items []*api.Item, opts WriteItemsOption) error

Types

type ConvertCommand

type ConvertCommand struct {
	*cobra.Command
	// contains filtered or unexported fields
}

func NewConvertCommand

func NewConvertCommand() *ConvertCommand

func (*ConvertCommand) Execute

func (c *ConvertCommand) Execute(_ *cobra.Command, args []string) error

type DocsCommand

type DocsCommand struct {
	Command *cobra.Command
}

func NewDocsCommand

func NewDocsCommand() *DocsCommand

NewDocsCommand creates a new cobra.Command for `docs` which generates documentation for the application.

func (*DocsCommand) Execute

func (c *DocsCommand) Execute(_ *cobra.Command, _ []string) error

type MigrateCommand

type MigrateCommand struct {
	Command *cobra.Command
	// contains filtered or unexported fields
}

func NewMigrateCommand

func NewMigrateCommand() *MigrateCommand

func (*MigrateCommand) Execute

func (mc *MigrateCommand) Execute(_ *cobra.Command, _ []string) error

type SyncCommand

type SyncCommand struct {
	*cobra.Command
	// contains filtered or unexported fields
}

func NewSyncCommand

func NewSyncCommand() *SyncCommand

NewSyncCommand returns a new sync command.

func (*SyncCommand) RunE

func (c *SyncCommand) RunE(cmd *cobra.Command, args []string) error

type SyncCommandOptions

type SyncCommandOptions struct {
	LiveMode  bool
	ServerURL string
}

type WriteItemsOption

type WriteItemsOption struct {
	Output     string // Output specifies the output directory or file path.
	Format     string // Format specifies the format of the output (e.g., JSON, XML).
	Pretty     bool   // Pretty specifies whether to format the output in a human-readable way.
	SingleFile bool   // SingleFile specifies whether to write all items into a single file.
}

WriteItemsOption represents the options for writing items.