# ignore-by-default

> A list of directories you should ignore by default

Latest version **2.1.0** (published 2022-05-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install ignore-by-default
pnpm add ignore-by-default
yarn add ignore-by-default
bun add ignore-by-default
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2022-05-02 |
| First published | 2016-02-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/ignore-by-default) |
| Module format | CommonJS |
| Node | >=10 <11 \|\| >=12 <13 \|\| >=14 |
| Dependencies | 0 |
| Unpacked size | 3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Author | Mark Wubben |
| Maintainers | novemberborn |
| Keywords | ignore, chokidar, watcher, exclude, glob, pattern |

## Links

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

## 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

- 2.1.0 (latest) — 2022-05-02
- 2.0.0 — 2020-06-13
- 1.0.1 — 2016-02-26
- 1.0.0 — 2016-02-05

## README

# ignore-by-default

This is a package aimed at Node.js development tools. It provides a list of
directories that should probably be ignored by such tools, e.g. when watching
for file changes.

It's used by [AVA](https://www.npmjs.com/package/ava) and
[nodemon](https://www.npmjs.com/package/nodemon).

[Please contribute!](./CONTRIBUTING.md)

## Installation

```
npm install ignore-by-default
```

## Usage

The `ignore-by-default` module exports a `directories()` function, which will
return an array of directory names. These are the ones you should ignore.

```js
// ['.git', '.sass_cache', …]
const ignoredDirectories = require('ignore-by-default').directories()
```

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