https://github.com/dat-ecosystem-archive/dat-ignore

Check if you should ignore a file before adding to Dat [ DEPRECATED - More info on active projects and modules at https://dat-ecosystem.org/ ]
https://github.com/dat-ecosystem-archive/dat-ignore

Last synced: 3 months ago
JSON representation

Check if you should ignore a file before adding to Dat [ DEPRECATED - More info on active projects and modules at https://dat-ecosystem.org/ ]

• Host: GitHub
• URL: https://github.com/dat-ecosystem-archive/dat-ignore
• Owner: dat-ecosystem-archive
• License: mit
• Archived: true
• Created: 2017-03-27T05:27:59.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-06T16:27:29.000Z (about 3 years ago)
• Last Synced: 2024-06-11T20:31:00.362Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 111 KB
• Stars: 9
• Watchers: 3
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-dat - dat-ignore - check files against `.datignore` before adding to a dat archive (Dat Core Modules / CLI Utilities)

README

        
[![deprecated](http://badges.github.io/stability-badges/dist/deprecated.svg)](https://dat-ecosystem.org/) 

More info on active projects and modules at [dat-ecosystem.org](https://dat-ecosystem.org/)  

---

# dat-ignore

> default ignore for dat

[![npm][npm-image]][npm-url]

[![travis][travis-image]][travis-url]

[![standard][standard-image]][standard-url]

Check if a file should be ignored for Dat:

* Ignore `.dat` by default

* Use the `.datignore` file

* Optionally ignore all hidden files

* Add in other custom ignore matches

## Install

```

npm install dat-ignore

```

## Usage

```js

var datIgnore = require('dat-ignore')

var ignore = datIgnore('/data/dir')

console.log(ignore('.dat')) // true

console.log(ignore('.git')) // true

console.log(ignore('dat-data')) // false

console.log(ignore('cat.jpg')) // false

```

Uses [anymatch](https://github.com/es128/anymatch) to match file paths.

### Example Options

Common configuration options.

#### Add custom ignore

```js

var ignore = datIgnore('/data/dir', {

    ignore: [

      '**/node_modules/**', 

      'path/to/file.js',

      'path/anyjs/**/*.js'

    ]

  })

```

#### Allow Hidden Files

```js

var ignore = datIgnore('/data/dir', { ignoreHidden: false })

```

####  Change Dat Ignore Path

```js

var ignore = datIgnore('/data/dir', {

    datignorePath: '~/.datignore'

  })

```

#### `.datignore` as string/buffer

Pass in a string as a newline delimited list of things to ignore.

```js

var datIgnoreFile = fs.readFileSync('~/.datignore')

datIgnoreFile += '\n' + fs.readFileSync(path.join(dir, '.datignore'))

datIgnoreFile += '\n' + fs.readFileSync(path.join(dir, '.gitignore'))

var ignore = datIgnore('/data/dir', { datignore: datIgnoreFile })

```

## API

### `var ignore = datIgnore(dir, [opts])`

Returns a function that checks if a path should be ignored:

```js

ignore('.dat') // true

ignore('.git') // true

ignore('data/cats.csv') // false

```

#### `dir`

`dir` is the file root to compare to. It is also used to find `.datignore`, if not specified.

#### Options:

* `opts.ignore` - Extend custom ignore with any anymatch string or array.

* `opts.useDatIgnore` - Use the `.datignore` file in `dir` (default: true)

* `opts.ignoreHidden` - Ignore all hidden files/folders (default: true)

* `opts.datignorePath` - Path to `.datignore` file (default: `dir/.datignore`)

* `opts.datignore` - Pass `.datignore` as buffer or string

## License

[MIT](LICENSE.md)

[npm-image]: https://img.shields.io/npm/v/dat-ignore.svg?style=flat-square

[npm-url]: https://www.npmjs.com/package/dat-ignore

[travis-image]: https://img.shields.io/travis/datproject/dat-ignore.svg?style=flat-square

[travis-url]: https://travis-ci.org/datproject/dat-ignore

[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square

[standard-url]: http://npm.im/standard