Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
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.
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 49,830,847 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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.