rulespatterns

Documentation

Index

• Variables
• type Config
• type Finder
  • func NewFinder(cfg Config) (*Finder, error)
  • func (f *Finder) Find(root string, known map[string]bool, fns rules.FindHandlerFuncs) error

Variables

var ErrInvalidAction = errors.New("invalid action")

var ErrMalformedDepthPath = errors.New("malformed depth path")

var ErrMalformedPattern = errors.New("malformed pattern")

var ErrTooDeep = errors.New("too many subdirs in depth path")

Types

type Config

type Config struct {
	Patterns     []string
	EnabledPaths []string
}

type Finder

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

`rulespatterns.Finder` applies a list of patterns to identify repo candidates. Create with `NewFinder()`. Example `Patterns`:

superrepo .
superrepo foo
     repo foo/overview
    enter foo/data
     repo foo/data/*
   ignore foo/*
   ignore *

`EnabledPaths` is a list of `<depth> <path>` pairs that are prepended before the patterns as follows:

0 foo  ->  "superrepo foo"
1 foo  ->  "superrepo foo", "superrepo foo/*"
2 foo  ->  "superrepo foo", "superrepo foo/*", "superrepo foo/*/*"

func NewFinder

func NewFinder(cfg Config) (*Finder, error)

func (*Finder) Find

func (f *Finder) Find(
	root string, known map[string]bool, fns rules.FindHandlerFuncs,
) error