app

Documentation

Index

• func AddFlags(rootCmd *cobra.Command)
• func Manifest(filePath string) *api.Documentation
• func NewCommand(ctx context.Context, cancel context.CancelFunc) *cobra.Command
• func NewReactor(ctx context.Context, options *Options) *reactor.Reactor
• func NewVersionCmd() *cobra.Command
• func WithHugo(reactorOptions *reactor.Options, o *Options)
• type Metering
• type Options
  • func NewOptions(f *cmdFlags) *Options

Functions

func AddFlags

func AddFlags(rootCmd *cobra.Command)

AddFlags adds go flags to rootCmd

func Manifest

func Manifest(filePath string) *api.Documentation

Manifest creates documentation model from configration file

func NewCommand

func NewCommand(ctx context.Context, cancel context.CancelFunc) *cobra.Command

NewCommand creates a new root command and propagates the context and cancel function to its Run callback closure

func NewReactor

func NewReactor(ctx context.Context, options *Options) *reactor.Reactor

NewReactor creates a Reactor from Options

func NewVersionCmd

func NewVersionCmd() *cobra.Command

NewVersionCmd creates a version command printing the binary version as reported by the pkg/version/Version variable

func WithHugo

func WithHugo(reactorOptions *reactor.Options, o *Options)

WithHugo adapts the reactor.Options object with Hugo-specific settings for writer and processor

Types

type Metering

type Metering struct {
	Enabled bool
}

Metering encapsulates options for setting up client-side mettering

type Options

type Options struct {
	MaxWorkersCount              int
	MinWorkersCount              int
	FailFast                     bool
	DestinationPath              string
	ResourcesPath                string
	ResourceDownloadWorkersCount int
	MarkdownFmt                  bool
	RewriteEmbedded              bool
	GitHubTokens                 map[string]string
	Metering                     *Metering
	DryRunWriter                 io.Writer
	Resolve                      bool
	Hugo                         *hugo.Options
}

Options is the set of parameters for creating reactor objects

func NewOptions

func NewOptions(f *cmdFlags) *Options

NewOptions creates an options object from flags