Skip to content

Type Alias: IgnorePatternOptions

IgnorePatternOptions = object

Toggles for each built-in ignore group; omitted flags default to true.

optional defaults?: boolean

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


optional dot?: boolean

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


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.

optional temp?: boolean

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


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.