statusShouldIgnore

Test if the ignore rules apply to a given file.

This function checks the ignore rules to see if they would apply to the given file. This indicates if the file would be ignored regardless of whether the file is already in the index or committed to the repository.

One way to think of this is if you were to do "git add ." on the directory containing the file, would it be added or not?

Signature

class Repository {
  statusShouldIgnore(path: string): boolean;
}

Parameters

• pathrequired · string
  

  A given file path.

Returns

• boolean
  

  Returns true if the ignore rules apply to a given file.