Skip to content

Interface: FileScanIgnoreOptions

Options controlling built-in and repository .gitignore matching.

optional defaults?: boolean

Build artifacts, dependency dirs, caches, logs, and OS junk files.

IgnorePatternOptions.defaults


optional dot?: boolean

Hidden dot-files and dot-directories (.git, .vscode, .gitignore, etc.).

IgnorePatternOptions.dot


optional git?: boolean

Load root and nested .gitignore files using Git-compatible semantics. Defaults to false.


optional lock?: boolean | "auto"

Lockfile ignore group (package-lock.json, pnpm-lock.yaml, yarn.lock, bun.lockb, etc.).

  • true - always ignore lockfiles.
  • false - never ignore lockfiles.
  • "auto" (default) - ignore when the active npm registry is not the public npm registry (registry.npmjs.org), e.g. a company-internal registry.

IgnorePatternOptions.lock


optional temp?: boolean

Temporary directories (tmp, .tmp, scratch, etc.).

IgnorePatternOptions.temp


optional test?: boolean

Test directories and *.test.* / *.spec.* naming conventions. Scanning/watch default on; omit (false) when emitting .gitignore / .prettierignore so tests stay tracked and formatable.

IgnorePatternOptions.test