filter

type CollectResult struct {
	Files        []string
	SkippedCount int
}

type Options struct {
	// BuiltinFolderRules applies the built-in directory lists (node_modules, vendor,
	// build output, …). BuiltinFileRules applies the built-in file lists: exact names,
	// extensions and name endings, which together answer one question — is this file
	// worth fingerprinting.
	//
	// Turning either off does not touch the Skip* fields below: those are the caller's
	// own rules, not part of the built-in policy. "No built-in folder lists" and "no
	// folder rules at all" are different requests, and this flag only makes the first.
	BuiltinFolderRules bool
	BuiltinFileRules   bool

	// The caller's own skip rules, layered on top of whatever the flags above admit.
	//
	// These are names, not paths and not globs: "node_modules", never "/node_modules"
	// or "src/**". A name matches at any depth. For paths and patterns use SkipPatterns.
	SkipDirs    []string // directory names
	SkipDirExts []string // directory-name suffixes, e.g. ".egg-info"
	SkipFiles   []string // exact file names
	SkipExts    []string // file extensions, leading dot: ".png"

	// Size bounds, applied as their own rule so they survive turning the built-in
	// lists off. 0 means no bound on that side; the built-in values are
	// DefaultMinFileSize / DefaultMaxFileSize.
	MinSize int64
	MaxSize int64

	GitIgnore bool // honor .gitignore

	// IncludeHidden collects entries whose name begins with a dot. They are excluded by default: a
	// scan wants the project's source, not its tooling. Setting it reaches version-control
	// metadata too — .git and friends are dotted like anything else — which matches the reference
	// implementation, where the equivalent flag has the same reach.
	IncludeHidden bool

	// SkipPatterns are gitignore-style globs: "src/**", "*.min.js". SizeRules bound the
	// size of files matching a glob. The profiles fill both from the project's
	// scanoss.json; a caller may add its own.
	//
	// Unlike the name-based fields above, these are final — KeepManifests never
	// overrides one, because a caller that named a path meant that path.
	SkipPatterns []string
	SizeRules    []SizeRule

	// KeepManifests keeps dependency manifest files (package.json, go.mod, pom.xml, …
	// — see pkg/manifests) even when a skip rule would otherwise drop them. Use it for
	// stages that consume manifests while still pruning everything else. Fingerprint
	// scanning leaves it false: a manifest is a declaration, not a file worth matching.
	KeepManifests bool
}

type SizeRule struct {
	Patterns []string
	Min      int64
	Max      int64
}