scan

Documentation

Index

• func LanguageForPath(path string) string
• type File
• type Ignored
• type Options
• type Result
  • func Scan(root string, cfg config.Config) (Result, error)
  • func ScanWithOptions(root string, cfg config.Config, visit func(path string, files int), ...) (Result, error)
  • func ScanWithProgress(root string, cfg config.Config, visit func(path string, files int)) (Result, error)

Functions

func LanguageForPath

func LanguageForPath(path string) string

Types

type File

type File struct {
	Path     string    `json:"path"`
	AbsPath  string    `json:"-"`
	Language string    `json:"language"`
	Size     int64     `json:"size"`
	Hash     string    `json:"hash"`
	ModTime  time.Time `json:"modifiedAt"`
}

type Ignored

type Ignored struct {
	Path   string `json:"path"`
	Reason string `json:"reason"`
}

type Options

type Options struct {
	HashCachePath string
	ForceHashing  bool
}

type Result

type Result struct {
	Root       string    `json:"root"`
	Files      []File    `json:"files"`
	Ignored    []Ignored `json:"ignored"`
	TotalBytes int64     `json:"totalBytes"`
}

func Scan

func Scan(root string, cfg config.Config) (Result, error)

func ScanWithOptions

func ScanWithOptions(root string, cfg config.Config, visit func(path string, files int), options Options) (Result, error)

ScanWithOptions scans root with optional, reconstructible file-hash caching. Callers that require a fresh content audit should use Scan or ScanWithProgress.

func ScanWithProgress

func ScanWithProgress(root string, cfg config.Config, visit func(path string, files int)) (Result, error)

ScanWithProgress scans root and reports each filesystem entry before it is inspected. The callback is optional and is intended for live CLI feedback.