scanner

Documentation

Index

• type File
  • func Scan(root string, opts Options) ([]File, error)
• type Options

Types

type File

type File struct {
	Path string
	Ext  string
}

File represents a discovered source file.

func Scan

func Scan(root string, opts Options) ([]File, error)

Scan walks the directory tree and returns source files matching the extensions in opts. Paths are relative to root. Skips skipDirs, generated files (.d.ts, .min.js), and (unless opts.IncludeTests) test files by each language's naming convention. Respects .gitignore if present.

type Options

type Options struct {
	// Extensions is the set of file extensions (with leading dot) to collect,
	// e.g. [".go", ".ts", ".tsx"]. It comes from the registered language
	// processors; files with other extensions are skipped.
	Extensions []string
	// IncludeTests keeps test files (e.g. _test.go, *.test.ts, __tests__/) that
	// are skipped by default.
	IncludeTests bool
}

Options controls which files a scan collects.