Ignore is a manager and filter for .gitignore rules.
Pay attention that
minimatch does not work in the gitignore way. To filter filenames according to .gitignore file, I recommend this module.
5.x, node <
0.10is not tested due to the lack of support of appveyor.
const ignore = require'ignore'var ig = ignoreadd'.abc/*' '!.abc/d/'
var paths ='.abc/a.js' // filtered out'.abc/d/e.js' // includedigfilterpaths // ['.abc/d/e.js']
pathsfilterigcreateFilter; // ['.abc/d/e.js']
igfilter'.abc\\a.js' '.abc\\d\\e.js'// if the code above runs on windows, the result will be// ['.abc\\d\\e.js']
ignore only 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.
/*.js' should only match '
a.js', but not '
**/foo' should match '
'a '(one space) should not match
'a '(two spaces).
'a \ 'matches
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.
ignoreadd'#abc'filter'#abc' // ['#abc']ignoreadd'\#abc'filter'#abc' // 
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.
email@example.com up to
const fs = require'fs'if fsexistsSyncfilenameignoreaddfsreadFileSyncfilenametoString
Filters the given array of pathnames, and returns the filtered array.
Array.<path>The array of paths to be filtered.
NOTICE that each
path here should be a relative path to the root of your repository. 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:
const glob = require'glob'glob'**'// Adds a / character to directory matches.mark: trueerr files =>if errreturn console.errorerrvar filtered = ignoreaddpatternsfilterfilesconsole.logfiltered
Creates a filter function which could filter an array of paths with
function(path) the filter function.
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.
The code of
node-ignore is based on es6 and babel, but babel and its preset is not included in the
dependencies field of package.json, so that the installation process of test cases will not fail in older versions of node.
bash install.sh to install dependencies and
bash test.sh to run test cases in your local machine.