ignorefs

IgnoreFS

Ignore common and custom patterns of the file system

Install

Node, Browserify

• Use: require('ignorefs')
• Install: npm install --save ignorefs

Ender

• Use: require('ignorefs')
• Install: ender add ignorefs

Usage

var isIgnored = require('ignorefs').isIgnoredPath(path, {
	ignorePaths: false, // array of paths to ignore
	ignoreHiddenFiles: false, // whether or not we should ignore files that start with a dot
	ignoreCommonPatterns: true, // whether or not we should common patterns like "thumbs.db" etc, uses https://github.com/bevry/ignorepatterns
	ignoreCustomPatterns: false, // can be a regex that is tested against the basename of the file and the file's path
});
console.log(isIgnored);  // true or false

History

Discover the change history by heading on over to the History.md file.

Contribute

Discover how you can contribute by heading on over to the Contributing.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton [e-mail] (https://github.com/balupton)

Sponsors

No sponsors yet! Will you be the first?

Contributors

No contributors yet! Will you be the first? Discover how you can contribute by heading on over to the Contributing.md file.

License

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Bevry Pty Ltd [e-mail] (http://bevry.me)
Copyright © 2011 Benjamin Lupton [e-mail] (http://balupton.com)