scanner

package

v0.9.0 Latest Latest Go to latest Published: Feb 16, 2026 License: MIT Imports: 6 Imported by: 0

Details

Package scanner discovers git repositories under a projects directory, respecting .katazuke index files for grouping and ignoring subdirectories.

This section is empty.

This section is empty.

func IsExcluded(name string, patterns []string) bool

IsExcluded returns true if the given name matches any of the glob patterns.

func Scan(rootPath string, opts Options) ([]string, error)

Scan discovers git repositories under rootPath.

The algorithm:

If a .katazuke file exists in a directory, parse it for groups/ignores and recurse into group subdirectories.
If no .katazuke file exists, treat all immediate children as potential repositories.
Hidden directories (starting with ".") are always skipped.
Symlink cycles are detected via visited-path tracking.

func ToSet(items []string) map[string]bool

ToSet converts a string slice to a set (map with bool values).

type IndexFile struct {
	Groups  []string `yaml:"groups"`
	Ignores []string `yaml:"ignores"`
}

IndexFile represents the schema of a .katazuke index file.

func LoadIndex(dir string) (IndexFile, bool, error)

LoadIndex loads and validates a .katazuke file from the given directory. Returns the parsed index, whether the file existed, and any error.

type Options struct {
	ExcludePatterns []string
}

Options controls scanning behavior.