Pay attention that
minimatch does not work in the gitignore way. To filter filenames according to .gitignore file, I recommend this module.
- Linux + Node:
- Windows + Node:
7.x, node <
0.10is not tested due to the lack of support of appveyor.
ignore does not rely on any versions of node specially.
4.0.0, ignore will no longer support
node < 6 by default, to use in node < 6,
require('ignore/legacy'). For details, see CHANGELOG.
Table Of Main Contents
- Guide for 2.x -> 3.x
- Guide for 3.x -> 4.x
- Related Packages
glob-gitignorematches files using patterns and filters them according to gitignore rules.
const ig =
Filter the given paths
const paths ='.abc/a.js' // filtered out'.abc/d/e.js' // includedig // ['.abc/d/e.js']ig // true
As the filter function
paths; // ['.abc/d/e.js']
Win32 paths will be handled
ig// if the code above runs on windows, the result will be// ['.abc\\d\\e.js']
Why another ignore?
ignoreonly contains utility methods to filter paths according to the specified ignore rules, so
ignorenever try to find out ignore rules by traversing directories or fetching from git configurations.
ignoredon't cares about sub-modules of git projects.
Exactly according to gitignore man page, fixes some known matching issues of fstream-ignore, such as:
/*.js' should only match '
a.js', but not '
**/foo' should match '
- Prevent re-including a file if a parent directory of that file is excluded.
- Handle trailing whitespaces:
'a '(one space) should not match
'a '(two spaces).
'a \ 'matches
- All test cases are verified with the result of
String|IgnoreAn ignore pattern string, or the
Array.<pattern>Array of ignore patterns.
Adds a rule or several rules to the current manager.
Notice that a line starting with
'#'(hash) is treated as a comment. Put a backslash (
'\') in front of the first hash for patterns that begin with a hash, if you want to ignore a file with a hash at the beginning of the filename.
// false// true
pattern could either be a line of ignore pattern or a string of multiple ignore patterns, which means we could just
ignore().add() the content of a ignore file:
pattern could also be an
ignore instance, so that we could easily inherit the rules of another
3.x for now.
firstname.lastname@example.org up to
new in 3.2.0
pathname should be ignored.
ig // true
Filters the given array of pathnames, and returns the filtered array.
Array.<path>The array of
pathnames to be filtered.
pathnameshould be a string that have been
path.join()ed, or the return value of
path.relative()to the current directory.
// WRONGig// WRONG, for it will never happen.// If the gitignore rule locates at the root directory,// `'/abc'` should be changed to `'abc'`.// ```// path.relative('/', '/abc') -> 'abc'// ```ig// Rightig// Rightig // path.join('./abc') -> 'abc'
- In other words, each
pathnamehere should be a relative path to the directory of the git ignore rules.
Suppose the dir structure is:
/path/to/your/repo |-- a | |-- a.js | |-- .b | |-- .c |-- .DS_store
paths might be like this:
Usually, you could use
option.mark = true to fetch the structure of the current directory:
Creates a filter function which could filter an array of paths with
function(path) the filter function.
options.ignorecase since 4.0.0
Similar as the
core.ignorecase option of git-config,
node-ignore will be case insensitive if
options.ignorecase is set to
true (default value), otherwise case sensitive.
const ig =igig // false
Upgrade 2.x -> 3.x
optionsof 2.x are unnecessary and removed, so just remove them.
ignore()instance is no longer an
EventEmitter, and all events are unnecessary and removed.
.addIgnoreFile()is removed, see the .addIgnoreFile section for details.
Upgrade 3.x -> 4.x
ignore will no longer support node < 6, to use
ignore in node < 6:
var ignore =