isPathIgnored

무시 규칙이 주어진 경로에 적용되는지 테스트해요.

이 함수는 무시 규칙을 확인하여 주어진 파일에 적용되는지 확인해요. 이는 파일이 이미 인덱스에 있거나 리포지토리에 커밋되었는지 여부와 관계없이 파일이 무시될지를 나타내요.

시그니처

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

파라미터

• path필수 · string
  

  확인할 경로

반환 값

• boolean
  

  - 경로가 무시되면 true, 그렇지 않으면 false

예제

import { openRepository } from 'es-git';

const repo = await openRepository('./path/to/repo');
const isIgnored = repo.isPathIgnored("node_modules/some-package");
console.log(`Path is ${isIgnored ? "ignored" : "not ignored"}`);