ignorefs

Ignore common and custom patterns of the file system

IgnoreFS

Ignore common and custom patterns of the file system

Node, Browserify

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

Ender

  • Use: require('ignorefs')
  • Install: ender add ignorefs
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 

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

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

These amazing people are maintaining this project:

  • Benjamin Lupton b@lupton.cc (https://github.com/balupton)

No sponsors yet! Will you be the first?

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

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Bevry Pty Ltd us@bevry.me (http://bevry.me)
Copyright © 2011 Benjamin Lupton b@lupton.cc (http://balupton.com)