Class ForceIgnore

constructor

• new ForceIgnore(forceIgnorePath?: string): ForceIgnore

  Parameters

  • forceIgnorePath: string = ''

  Returns ForceIgnore

Static ReadonlyFILE_NAME

accepts

• accepts(fsPath: string): boolean

  Parameters

  • fsPath: string

  Returns boolean

denies

• denies(fsPath: string): boolean

  Parameters

  • fsPath: string

  Returns boolean

StaticclearCacheForTest

• clearCacheForTest(): void
  Internal

  clears module cache; for unit tests only

  Returns void

StaticfindAndCreate

• findAndCreate(seed: string): ForceIgnore

  Performs an upward directory search for a .forceignore file and returns a ForceIgnore object based on the result. If there is no .forceignore file, the returned ForceIgnore object will accept everything.

  Parsed files are cached by absolute path and invalidated when mtime or size changes on disk.

  Parameters

  • seed: string

    Path to begin the .forceignore search from

  Returns ForceIgnore