Package Exports

ignorefs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ignorefs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

IgnoreFS

Ignore common and custom patterns of the file system

Install

NPM

Install: npm install --save ignorefs
Module: require('ignorefs')

Browserify

Install: npm install --save ignorefs
Module: require('ignorefs')
CDN URL: //wzrd.in/bundle/ignorefs@1.1.1

Ender

Install: ender add ignorefs
Module: require('ignorefs')

Editions

This package is published with the following editions:

ignorefs aliases ignorefs/index.js which uses Editions to automatically select the correct edition for the consumers environment
ignorefs/source/index.js is Source + ESNext + Require
ignorefs/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

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 release 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

Contributors

These amazing people have contributed code to this project: