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;

• Returns whether pathname should be ignored or unignored

  Parameter pathname

  a path to check

  Returns

  TestResult

property allowRelativePaths

allowRelativePaths?: boolean;

property ignorecase

ignorecase?: boolean;

property ignoreCase

ignoreCase?: boolean;