v7.0.0

Compare Source

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.