sfcode
An Online Competing and Development Environment
|
Linux
OS X
Windows
Coverage
Downloads </thead><tbody>
ignore
is a manager, filter and parser which implemented in pure JavaScript according to the .gitignore spec 2.22.1.
ignore
is used by eslint, gitbook and many others.
Pay ATTENTION that minimatch
(which used by fstream-ignore
) does not follow the gitignore spec.
To filter filenames according to a .gitignore file, I recommend this npm package, ignore
.
To parse an .npmignore
file, you should use minimatch
, because an .npmignore
file is parsed by npm using minimatch
and it does not work in the .gitignore way.
ignore
is fully tested, and has more than five hundreds of unit tests.
0.8
- 7.x
0.10
- 7.x
, node < 0.10
is not tested due to the lack of support of appveyor.Actually, ignore
does not rely on any versions of node specially.
Since 4.0.0
, ignore will no longer support node < 6
by default, to use in node < 6, ‘require('ignore/legacy’)`. For details, see CHANGELOG.
Pathname
Conventionsglob-gitignore
matches files using patterns and filters them according to gitignore rules.ignore
is a standalone module, and is much simpler so that it could easy work with other programs, unlike isaacs's fstream-ignore which must work with the modules of the fstream family.ignore
only contains utility methods to filter paths according to the specified ignore rules, soignore
never try to find out ignore rules by traversing directories or fetching from git configurations.ignore
don't cares about sub-modules of git projects./*.js
' should only match 'a.js
', but not 'abc/a.js
'.**/foo
' should match 'foo
' anywhere.(one space) should not match
'a '(two spaces). -
'a \ 'matches
'a '
All test cases are verified with the result of
git check-ignore`.String | Ignore
An ignore pattern string, or the Ignore
instanceArray<String | Ignore>
Array of ignore patterns.Adds a rule or several rules to the current manager.
Returns this
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.
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 Ignore
instance.
REMOVED in 3.x
for now.
To upgrade ignore@2.x
up to 3.x
, use
instead.
Filters the given array of pathnames, and returns the filtered array.
Array.<Pathname>
The array of pathname
s to be filtered.Pathname
should be a string that have been path.join()
ed, or the return value of path.relative()
to the current directory,
// path.relative('/', '/abc') -> 'abc' // ``‘ ig.ignores(’/abc')
// WRONG, that it is an absolute path on Windows, an error will be thrown ig.ignores('C:\abc')
// Right ig.ignores('abc')
// Right ig.ignores(path.join('./abc')) // path.join('./abc') -> 'abc'
/path/to/your/repo |– a | |– a.js | |– .b | |– .c |– .DS_store
node-ignore
does NO fs.stat
during path matching, so for the example below:
Specially for people who develop some library based on node-ignore
, it is important to understand that.
Usually, you could use glob
with option.mark = true
to fetch the structure of the current directory:
new in 3.2.0
Returns Boolean
whether pathname
should be ignored.
Creates a filter function which could filter an array of paths with Array.prototype.filter
.
Returns function(path)
the filter function.
Returns TestResult
{ignored: true, unignored: false}
: the pathname
is ignored{ignored: false, unignored: true}
: the pathname
is unignored{ignored: false, unignored: false}
: the pathname
is never matched by any ignore rules.Similar as the core.ignorecase
option of git-config, node-ignore
will be case insensitive if options.ignorecase
is set to true
(the default value), otherwise case sensitive.
Check whether the pathname
is an valid path.relative()
d path according to the convention.
This method is NOT used to check if an ignore pattern is valid.
Since 5.0.0
, if an invalid Pathname
passed into ig.ignores()
, an error will be thrown, while ignore < 5.0.0
did not make sure what the return value was, as well as
See the convention here for details.
If there are invalid pathnames, the conversion and filtration should be done by users.
Since 4.0.0
, ignore
will no longer support node < 6, to use ignore
in node < 6:
options
of 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.