PATCH Brings pattern matching closer to git:

• PATCH A backslash now makes the next character a literal, exactly as git does: \* matches a literal * rather than acting as a wildcard, \? matches a literal ?, and \d, \b, \/ and the like are the plain characters instead of regular-expression escapes.
• PATCH Only a trailing run of spaces is stripped from a pattern — never tabs or other whitespace — and a line of only tabs is treated as a pattern rather than a blank line, matching git.

An upgrade is recommended for all dependents.

7.0.5: fixes #152

• PATCH Allows files named .{3,}, such as ... for Linux / macOS (#68)

ig.ignores('...')
ig.ignores('....')
// It will throw a RangeError in versions prior to 7.0.4, but it is ok if >= 7.0.4

An upgrade is recommended for all dependents

7.0.3: #146, #147: adds more test cases and temporarily adds ignore.d…

#146: only tests module resolution 16 if not windows

Minor feature

The primary feature introduced by 7.0.0 is the .checkIgnore() method, which is most equivalent to git check-ignore -v. And also it allows to pass {pattern, mark?} as the parameter of .add() so that we could imitate the mechanism of git check-ignore as:

ig.add({
  pattern: 'foo/*',
  mark: '60'
})

const {
  ignored,
  rule
} = checkIgnore('foo/')

if (ignored) {
  console.log(`.gitignore:${result}:${rule.mark}:${rule.pattern} foo/`)
}

// .gitignore:60:foo/* foo/

Potential Incompatibilities

The only situation that 7.0.0 might bring incompatibility is to .add() a < 7.0.0 instance into a >= 7.0.0 instance, which might occur when the current workspace has multiple node-ignore versions installed, please be careful.

const {anotherIgnoreInstance} = require('./ignore-6.0-instance')

// A 7.0.0 instance
ignore().add(anotherIgnoreInstance)

// It will break your code

Otherwise, in most cases, if you never do something above or there is only one version of node-ignore installed in the current workspace, it is quite safe to upgrade to 7.0.0.

6.x

• The release of 6.x is due to a mistake.
• Making an upgrade from 5.x to 6.x for now actually changes nothing and does no harm, everyone could just upgrade or ignore the version.
  • Actually 6.0.2 is 5.3.2
• The next major release will be 7.0.0

6.0.0: #96: try to fix typescript moduleResolution Node16

6.x

• The release of 6.x is due to a mistake.
• Making an upgrade from 5.x to 6.x for now actually changes nothing and does no harm, everyone could just upgrade or ignore the version.
  • Actually 6.0.2 is 5.3.2
• The next major release will be 7.0.0

5.3.1: #108: remove BOM before processing .gitignore rules

5.3.0

• MINOR export Options interface (#105)

An upgrade is safe for all dependents

It allows typing external methods which expect Options as a param, by importing the Options interface.

import {Options} from 'ignore'

• PATCH fixes normal single asterisk and normal consecutive asterisks defined in gitignore spec (#57)
• PATCH invalid trailing backslash will not throw unexpectedly

An upgrade is recommended for all dependents

The following rules could be not properly parsed with previous ignore versions

**foo
*bar
qu*ux
abc\   # `ignore` would throw if no whitespace after `\`

• PATCH support readonly arrays of typescript. (#70)
• MINOR bring backward compatibility with relative paths. (#75)

An upgrade is recommended for all dependents.

ignore().ignores('../foo/bar.js') // will throw

And the code below will not throw, however it is not recommended

ignore({
  allowRelativePaths: true
}).ignores('../foo/bar.js')

Recommend:

ignore().ignores('foo/bar.js')

• PATCH fixes ignorecase when internal cache is hit. (#74)

An upgrade is recommended for all dependents.

• PATCH fixes escaping for square brackets (#59)

An upgrade is recommended for all dependents.

• PATCH apply the changes of gitignore rules 2.22.1 and fix #56

An upgrade is recommended for all dependents.

• PATCH fixes isPathValid on Windows (#54)

On Windows, if path is an absolute path, ig.ignores(path), ig.test(path) and related methods will now throw an error as expected.

• FEATURE: Typescript: export interface Ignore (#53)

• PATCH: fixes isPathValid in windows (#47)

• PATCH: fixes for windows.
• PATCH: improves tests for typescript and windows.

• SEMVER-MAJOR: #20: it will throw if an invalid pathname passes into .ignores(pathname), see Upgrade 4.x -> 5.x.
• FEATURE: #31: adds a new method .test(pathname).
• BENCHMARK: improves performance by 26%.

• PATCH: Object.prototype methods will not ruin the result any more.