app

Documentation

Index

• Constants
• func NewCommand(ctx context.Context) *cobra.Command
• type Config
• type Options
• type Writers

Constants

const (
	// DefaultConfigFileName default configuration filename under docforge home folder
	DefaultConfigFileName = "config"
	// DocforgeHomeDir defines the docforge home location
	DocforgeHomeDir = ".docforge"
)

Functions

func NewCommand

func NewCommand(ctx context.Context) *cobra.Command

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

Types

type Config

type Config struct {
	Options
	Writers
	hugo.Hugo
	RepositoryHosts []repositoryhost.Interface
}

Config configuration of the reactor

type Options

type Options struct {
	DocumentWorkersCount         int      `mapstructure:"document-workers"`
	ValidationWorkersCount       int      `mapstructure:"validation-workers"`
	FailFast                     bool     `mapstructure:"fail-fast"`
	DestinationPath              string   `mapstructure:"destination"`
	ResourcesDownloadPath        string   `mapstructure:"resources-download-path"`
	ResourcesWebsitePath         string   `mapstructure:"resources-website-path"`
	ManifestPath                 string   `mapstructure:"manifest"`
	ResourceDownloadWorkersCount int      `mapstructure:"download-workers"`
	GhInfoDestination            string   `mapstructure:"github-info-destination"`
	DryRun                       bool     `mapstructure:"dry-run"`
	ContentFileFormats           []string `mapstructure:"content-files-formats"`
	HostsToReport                []string `mapstructure:"hosts-to-report"`
	SkipLinkValidation           bool     `mapstructure:"skip-link-validation"`
}

Options encapsulates the parameters for creating new Reactor objects

type Writers

type Writers struct {
	ResourceDownloadWriter writers.Writer
	GitInfoWriter          writers.Writer
	Writer                 writers.Writer
}

Writers struct that collects all the writesr