checklist

Documentation

Index

• func FilesExistAny(path string, tp FileType, files ...string) bool
• func FindOccurrencesInTree(path, regex, filePattern string) int
• type CheckItem
• type CheckItemParams
• type CheckList
  • func New(sourcePath string) *CheckList
  • func (c CheckList) RunTasks() (successful []string, failed []string)
• type FileType

Functions

func FilesExistAny

func FilesExistAny(path string, tp FileType, files ...string) bool

FilesExistAny checks if the given file(s) exists in the root folder.

func FindOccurrencesInTree

func FindOccurrencesInTree(path, regex, filePattern string) int

FindOccurrencesInTree tries to match the regular expression in files matching the file pattern. It returns the number of matchings.

Types

type CheckItem

type CheckItem struct {
	Name string `json:"name"`
	Desc string `json:"-"`
	// contains filtered or unexported fields
}

type CheckItemParams

type CheckItemParams func(sp, sgp string) bool

type CheckList

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

func New

func New(sourcePath string) *CheckList

func (CheckList) RunTasks

func (c CheckList) RunTasks() (successful []string, failed []string)

RunTasks is a wrapper for running all tasks from the list

type FileType

type FileType int

const (
	TypeDir FileType = iota
	TypeFile
	TypeBoth
)