README.md

glob-fs-gitignore

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

Install

Install with npm:

$ npm install --save glob-fs-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.

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);
  });

About

Contributing

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

Contributors

Commits	Contributor
12	jonschlinkert
1	StefanLiebenberg

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on May 11, 2017.