glob-fs-dotfiles

glob-fs-dotfiles

glob-fs middleware for automatically ignoring dotfiles.

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-dotfiles --save

Usage

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

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

Options

• dot: include or exclude dotfiles and dotdirs
• dotdirs: include or exclude dotdirs
• dotfiles: include or exclude dotfiles

Disabling built-ins

Disable the glob-fs built-in middleware by passing builtins: false on the options.

options.b

Related projects

• glob-fs: file globbing for node.js. speedy and powerful alternative to node-glob.
• glob-fs-gitignore: glob-fs middleware for automatically ignoring files specified in .gitignore
• 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.