glob-fs-gitignore

glob-fs middleware for automatically ignoring files specified in .gitignore

This is currently a built-in middleware with glob-fs, but it can also be used directly if the default middleware stack is disabled.

Install

Install with npm

$ npm i glob-fs-gitignore --save

Usage

var gitignore = require('glob-fs-gitignore');

Middleware is defined the same way with all readdir methods (e.g. glob.readdir, glob.readdirSync, glob.readdirStream and glob.readdirPromise):

var glob = require('glob-fs')({ dotfiles: true })
  .use(gitignore()) // <= middleware
  .readdir('*', function (err, files) {
    console.log(files);
  });

Related projects

• glob-fs: file globbing for node.js. speedy and powerful alternative to node-glob.
• glob-fs-dotfiles: glob-fs middleware for automatically ignoring dotfiles.
• is-glob: Returns true if the given string looks like a glob pattern.
• micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… more

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on July 11, 2015.