ignore

Tested on

Table Of Main Contents

Install

Usage

Filter the given paths

As the filter function

Win32 paths will be handled

Why another ignore?

Methods

.add(pattern: string | Ignore): this

.add(patterns: Array): this

.add({pattern: string, mark?: string}): this since 7.0.0

.ignores(pathname: Pathname): boolean

`Pathname` Conventions:

1. `Pathname` should be a `path.relative()`d pathname

2. filenames and dirnames

.filter(paths: Array): Array

.createFilter()

.test(pathname: Pathname): TestResult

.checkIgnore(target: string): TestResult

static `isPathValid(pathname): boolean` since 5.0.0

.addIgnoreFile(path)

ignore(options)

`options.ignorecase` since 4.0.0

`options.ignoreCase?: boolean` since 5.2.0

`options.allowRelativePaths?: boolean` since 5.2.0

Upgrade Guide

Upgrade 4.x -> 5.x

Upgrade 3.x -> 4.x

Upgrade 2.x -> 3.x

Collaborators