repomgr

Documentation

Overview

Code generated by options-gen. DO NOT EDIT.

Index

• type GoDepHasNoModuleReq
• type GoDepModMinVersionReq
• type GoVersion
• type OptOptionsSetter
  • func WithPrivateKey(opt string) OptOptionsSetter
• type Options
  • func NewOptions(spec Spec, options ...OptOptionsSetter) Options
  • func (o *Options) Validate() error
• type PolicySpec
• type Repo
• type RepoManager
  • func New(opts Options) (*RepoManager, error)
  • func (m *RepoManager) Run() error
• type RepoReport
• type RepoSpec
• type Rule
• type RuleName
• type RuleSpec
• type Spec
  • func ParseSpec(filename string) (*Spec, error)

Types

type GoDepHasNoModuleReq

type GoDepHasNoModuleReq struct {
	Module string
}

type GoDepModMinVersionReq

type GoDepModMinVersionReq struct {
	Module     string
	MinVersion string
}

type GoVersion

type GoVersion struct {
	MinVersion string
}

type OptOptionsSetter

type OptOptionsSetter func(o *Options)

func WithPrivateKey

func WithPrivateKey(opt string) OptOptionsSetter

type Options

type Options struct {
	// contains filtered or unexported fields
}

func NewOptions

func NewOptions(
	spec Spec,
	options ...OptOptionsSetter,
) Options

func (*Options) Validate

func (o *Options) Validate() error

type PolicySpec

type PolicySpec struct {
	ID    string
	Name  string
	Rules []RuleSpec
}

type Repo

type Repo struct {
	AbsPath       string
	GoModFilename string
	GoModFile     modfile.File
}

type RepoManager

type RepoManager struct {
	// contains filtered or unexported fields
}

func New

func New(opts Options) (*RepoManager, error)

func (*RepoManager) Run

func (m *RepoManager) Run() error

type RepoReport

type RepoReport struct {
	RepoSpec RepoSpec
	Repo     Repo
	Warnings []string
}

type RepoSpec

type RepoSpec struct {
	Name     string
	Path     string
	Type     string
	Policies []string
}

type Rule

type Rule func(Repo) []string

type RuleName

type RuleName string

const (
	RuleNameGoDepModMinVersion RuleName = "go-dep-module-min-version"
	RuleNameGoDepHasNoModule   RuleName = "go-dep-has-no-module"
	RuleNameGoVersion          RuleName = "go-version"
)

type RuleSpec

type RuleSpec struct {
	Rule   RuleName
	Params any
}

type Spec

type Spec struct {
	Version  string
	Policies []PolicySpec
	Repos    []RepoSpec
}

func ParseSpec

func ParseSpec(filename string) (*Spec, error)