aboutsummaryrefslogtreecommitdiff
path: root/node_modules/ignore-by-default/README.md
blob: ee7719119afd01fae8a44ce7d6ffd24c8b1e9ca0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# 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 --save 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', …]
var ignoredDirectories = require('ignore-by-default').directories()
```