https://github.com/thomas-lebeau/gulp-gitignore

Exlude files defined on .gitignore from the stream
https://github.com/thomas-lebeau/gulp-gitignore

Last synced: about 2 months ago
JSON representation

Exlude files defined on .gitignore from the stream

• Host: GitHub
• URL: https://github.com/thomas-lebeau/gulp-gitignore
• Owner: thomas-lebeau
• License: mit
• Created: 2015-09-06T08:20:15.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-09T15:23:14.000Z (over 9 years ago)
• Last Synced: 2024-10-26T22:01:59.072Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 156 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# gulp-gitignore [![Build Status](https://travis-ci.org/Thomas-Lebeau/gulp-gitignore.svg?branch=master)](https://travis-ci.org/Thomas-Lebeau/gulp-gitignore)

> Exlude files defined on .gitignore from the stream

## Install

```

$ npm install --save-dev gulp-gitignore

```

## Usage

```js

var gulp = require('gulp');

var gitignore = require('gulp-gitignore');

gulp.task('default', function () {

    return gulp.src('src/**/*')

        // exclude files defined in .gitignore

        .pipe(gitignore())

        .pipe(gulp.dest('dist'));

});

```

## API

### gitignore(file, [pattern],[options])

#### file

Type: `string`

Default: `.gitignore`

The `.gitignore` file.

#### pattern

Type: `array`

You can optionally pass an additional array of patterns to exlude from the stream.

```js

gitignore('.gitignore', ['foo', 'bar']);

```

#### options

Type: `object`

##### options.dot

Type: `boolean`  

Default: `false`

Matches files prefixed with a dot (eg. `.DS_Store`).

## License

MIT © [Thomas Lebeau](https://github.com/Thomas-Lebeau)