finki-main
main
|
Last change
on this file since 81bc7da was 81bc7da, checked in by Klimentina Efremova <klimentina08642@…>, 3 months ago |
|
Initial commit
|
-
Property mode
set to
100644
|
|
File size:
680 bytes
|
| Line | |
|---|
| 1 | # ignore-by-default
|
|---|
| 2 |
|
|---|
| 3 | This is a package aimed at Node.js development tools. It provides a list of
|
|---|
| 4 | directories that should probably be ignored by such tools, e.g. when watching
|
|---|
| 5 | for file changes.
|
|---|
| 6 |
|
|---|
| 7 | It's used by [AVA](https://www.npmjs.com/package/ava) and
|
|---|
| 8 | [nodemon](https://www.npmjs.com/package/nodemon).
|
|---|
| 9 |
|
|---|
| 10 | [Please contribute!](./CONTRIBUTING.md)
|
|---|
| 11 |
|
|---|
| 12 | ## Installation
|
|---|
| 13 |
|
|---|
| 14 | ```
|
|---|
| 15 | npm install --save ignore-by-default
|
|---|
| 16 | ```
|
|---|
| 17 |
|
|---|
| 18 | ## Usage
|
|---|
| 19 |
|
|---|
| 20 | The `ignore-by-default` module exports a `directories()` function, which will
|
|---|
| 21 | return an array of directory names. These are the ones you should ignore.
|
|---|
| 22 |
|
|---|
| 23 | ```js
|
|---|
| 24 | // ['.git', '.sass_cache', …]
|
|---|
| 25 | var ignoredDirectories = require('ignore-by-default').directories()
|
|---|
| 26 | ```
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
