ignore

method add

add: (
    patterns: string | Ignore | readonly (string | Ignore)[] | PatternParams
) => this;

• Adds one or several rules to the current manager.

  Parameter patterns

  Returns

  IgnoreBase

method checkIgnore

checkIgnore: (pathname: Pathname) => TestResult;

• Debugs ignore rules and returns the checking result, which is equivalent to git check-ignore -v.

  Returns

  TestResult

method createFilter

createFilter: () => (pathname: Pathname) => boolean;

• Creates a filter function which could filter an array of paths with Array.prototype.filter.

method filter

filter: (pathnames: readonly Pathname[]) => Pathname[];

• Filters the given array of pathnames, and returns the filtered array. NOTICE that each path here should be a relative path to the root of your repository.

  Parameter paths

  the array of paths to be filtered.

  Returns

  The filtered array of paths

method ignores

ignores: (pathname: Pathname) => boolean;

• Returns Boolean whether pathname should be ignored.

  Parameter pathname

  a path to check

  Returns

  boolean

method test

test: (pathname: Pathname) => TestResult;

• Tests the pathname against the rules. ignored and unignored can both be false: see TestResult.unignored for the two cases.

  Parameter pathname

  a path to check

  Returns

  TestResult

property mark

mark?: string;

• Carried through from PatternParams.mark.

property negative

negative: boolean;

• Whether the pattern is a negative one, such as !foo.

property pattern

pattern: string;

• The original pattern.

property allowRelativePaths

allowRelativePaths?: boolean;

property ignorecase

ignorecase?: boolean;

property ignoreCase

ignoreCase?: boolean;

property mark

mark?: string;

• Carried through to IgnoreRule.mark, for packages that build upon ignore.

property pattern

pattern: string;

property ignored

ignored: boolean;

• Whether the pathname is ignored, by a rule or because a parent directory of it is.

property rule

rule?: IgnoreRule;

• The rule that ignores the pathname, or the parent directory it is ignored with: the last rule to match, which is the rule git check-ignore -v reports. Present exactly when ignored is true.

property unignored

unignored: boolean;

• True if a negative pattern matched the pathname itself, and no parent directory of it is ignored.

  Only ignored passes down from a parent directory, so a pathname that is not ignored only because a parent directory was unignored keeps this false, as does one no rule applies to at all. To tell those two apart, test the parent directories, each with a trailing slash.