Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
ignore
Advanced tools
Ignore is a manager and filter for .gitignore rules.
Weekly downloads
Package description
The ignore npm package is a utility for filtering files and directories according to the particular rules specified in .gitignore files. It can be used to create ignore patterns similar to how git handles .gitignore files, allowing developers to programmatically determine which files should be ignored based on these patterns.
Add ignore rules
This feature allows you to add ignore rules, which can be a single string or an array of strings representing the patterns to ignore. The example demonstrates adding rules to ignore the .git directory and any files ending with .test.js.
const ignore = require('ignore');
const ig = ignore().add(['.git', '*.test.js']);
console.log(ig.ignores('example.test.js')); // true
Filter file paths
This feature provides a way to filter an array of file paths, removing any that match the ignore patterns. The code sample filters out 'example.test.js' because it matches the '*.test.js' pattern.
const ignore = require('ignore');
const ig = ignore().add('*.test.js');
const files = ['test.js', 'example.test.js', 'README.md'];
const filtered = files.filter(ig.createFilter());
console.log(filtered); // ['test.js', 'README.md']
Check if a file is ignored
This feature checks if a particular file would be ignored based on the current ignore rules. The code sample checks if 'example.test.js' is ignored (true) and if 'README.md' is ignored (false).
const ignore = require('ignore');
const ig = ignore().add('*.test.js');
console.log(ig.ignores('example.test.js')); // true
console.log(ig.ignores('README.md')); // false
Globby is a package that provides methods for matching files using glob patterns. It is built on top of the 'glob' package and supports multiple patterns. It is similar to ignore in that it can filter out files, but it uses glob patterns instead of .gitignore-style patterns.
Minimatch is a minimal matching utility that implements the same wildcard rules as used by gitignore. It is similar to ignore in that it can be used to test if file paths match specified patterns, but it does not directly handle .gitignore files.
Anymatch is a package that allows you to match strings against a list of patterns, which can be strings, regexes, or functions. It is similar to ignore in the sense that it can be used to determine if a string should be ignored or not, but it is more flexible in terms of the types of patterns it accepts.
Readme
ignore
is a manager and filter which implemented in pure JavaScript according to the .gitignore spec.
Pay attention that minimatch
does not work in the gitignore way. To filter filenames according to .gitignore file, I recommend this module.
npm install ignore --save
var ignore = require('ignore');
var ig = ignore(options).addPattern(['.abc/*', '!.abc/d/']);
var paths = [
'.abc/a.js', // filtered out
'.abc/d/e.js' // included
];
ig.filter(paths); // ['.abc/d/e.js']
paths.filter(ig.createFilter()); // ['.abc/d/e.js']
For most cases, we'd better use only one ignore file. We could use ignore.select
to select the first existing file.
ignore().addIgnoreFile(
ignore.select([
'.xxxignore',
'.gitignore',
'.ignore'
])
);
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, so
ignore
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.Adds a rule or several rules to the current manager.
this
String|Array.<String>
The ignore rule or a array of rules.
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.
ignore().addPattern('#abc').filter(['#abc']); // ['#abc']
ignore().addPattern('\#abc').filter(['#abc']); // []
Adds rules from a ignore file or several files
this
String|Array.<String>
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
Then the paths
might be like this:
[
'a/a.js'
'.b',
'.c/.DS_store'
]
Usually, you could use glob
to fetch the structure of the current directory:
var glob = require('glob');
glob('**', function(err, files){
var filtered;
if ( err ) {
console.log(err);
} else {
filtered = ignore().addIgnoreFile('.gitignore').filter(files);
console.log(filtered);
}
});
Creates a filter function which could filter an array of paths with Array.prototype.filter
.
function(path)
The filter function.
new ignore.Ignore(options);
ignore(options);
boolean=false
By default, all ignore rules will be treated as case-insensitive ones as well as the git does.
boolean=false
By defailt, ignoreRules
will omit every pattern that includes '**
' (two consecutive asterisks) which is not compatible cross operating systems, because the behavior of file .gitignore depends on the implementation of command fnmatch
in shell.
By the way, Mac OS doesn't support '**
'.
Array.<String>
The ignore rules to be added. Default to ['.git', '.svn', '.DS_Store']
If you want those directories to be included, you could
ignore({
ignore: []
});
You can also use .addPattern()
method to do this.
FAQs
Ignore is a manager and filter for .gitignore rules, the one used by eslint, gitbook and many others.
The npm package ignore receives a total of 44,687,837 weekly downloads. As such, ignore popularity was classified as popular.
We found that ignore demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.