# glob-fs-dotfiles

> glob-fs middleware for automatically ignoring dotfiles.

Latest version **0.1.6** (published 2015-07-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install glob-fs-dotfiles
pnpm add glob-fs-dotfiles
yarn add glob-fs-dotfiles
bun add glob-fs-dotfiles
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2015-07-11 |
| First published | 2015-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | fs, dot, dotfiles, dotfile, gitignore, glob, glob-fs, ignore, middleware, parse, pattern, patterns |

## Links

- npm: https://www.npmjs.com/package/glob-fs-dotfiles
- Repository: https://github.com/jonschlinkert/glob-fs-dotfiles
- Issues: https://github.com/jonschlinkert/glob-fs-dotfiles/issues
- npm.io page: https://npm.io/package/glob-fs-dotfiles

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.1.6 (latest) — 2015-07-11
- 0.1.5 — 2015-07-09
- 0.1.4 — 2015-07-09
- 0.1.3 — 2015-07-09
- 0.1.2 — 2015-07-07
- 0.1.1 — 2015-07-07
- 0.1.0 — 2015-07-07

## README

# glob-fs-dotfiles [![NPM version](https://badge.fury.io/js/glob-fs-dotfiles.svg)](http://badge.fury.io/js/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](https://www.npmjs.com/)

```sh
$ npm i glob-fs-dotfiles --save
```

## Usage

```js
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](https://github.com/jonschlinkert/glob-fs): file globbing for node.js. speedy and powerful alternative to node-glob.
* [glob-fs-gitignore](https://github.com/jonschlinkert/glob-fs-gitignore): glob-fs middleware for automatically ignoring files specified in `.gitignore`
* [is-glob](https://github.com/jonschlinkert/is-glob): Returns `true` if the given string looks like a glob pattern.
* [micromatch](https://github.com/jonschlinkert/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… [more](https://github.com/jonschlinkert/micromatch)

## Running tests

Install dev dependencies:

```sh
$ npm i -d && npm test
```

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/glob-fs-dotfiles/issues/new)

## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2015 Jon Schlinkert
Released under the MIT license.

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on July 11, 2015._

---
_Source: https://npm.io/package/glob-fs-dotfiles · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._