# fstream-ignore

> A thing for ignoring files based on globs

Latest version **1.0.5** (published 2016-05-17) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install fstream-ignore
pnpm add fstream-ignore
yarn add fstream-ignore
bun add fstream-ignore
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2016-05-17 |
| First published | 2012-03-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 37 |
| Author | Isaac Z. Schlueter |
| Maintainers | isaacs, othiym23, zkat |

## Links

- npm: https://www.npmjs.com/package/fstream-ignore
- Repository: https://github.com/isaacs/fstream-ignore
- Homepage: https://github.com/isaacs/fstream-ignore#readme
- Issues: https://github.com/isaacs/fstream-ignore/issues
- npm.io page: https://npm.io/package/fstream-ignore

## Dependencies (3)

- [fstream](https://npm.io/package/fstream.md) ^1.0.0
- [inherits](https://npm.io/package/inherits.md) 2
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.0

## Recent versions

- 1.0.5 (latest) — 2016-05-17
- 1.0.4 — 2016-05-02
- 1.0.3 — 2015-10-29
- 1.0.2 — 2014-12-03
- 1.0.1 — 2014-07-31
- 1.0.0 — 2014-07-31
- 0.0.10 — 2014-07-11
- 0.0.9 — 2014-07-11
- 0.0.8 — 2014-05-19
- 0.0.7 — 2013-05-29
- 0.0.6 — 2013-01-17
- 0.0.5 — 2012-03-27
- 0.0.4 — 2012-03-27
- 0.0.3 — 2012-03-27
- 0.0.2 — 2012-03-26
- … 1 more at https://npm.io/package/fstream-ignore/versions

## README

# fstream-ignore

A fstream DirReader that filters out files that match globs in `.ignore`
files throughout the tree, like how git ignores files based on a
`.gitignore` file.

Here's an example:

```javascript
var Ignore = require("fstream-ignore")
Ignore({ path: __dirname
       , ignoreFiles: [".ignore", ".gitignore"]
       })
  .on("child", function (c) {
    console.error(c.path.substr(c.root.path.length + 1))
  })
  .pipe(tar.Pack())
  .pipe(fs.createWriteStream("foo.tar"))
```

This will tar up the files in __dirname into `foo.tar`, ignoring
anything matched by the globs in any .iginore or .gitignore file.

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