gulp-print/README.md

# gulp-print

[![NPM downloads](https://img.shields.io/npm/dt/gulp-print.svg)](https://npmjs.org/package/gulp-print)
[![GitTip](http://img.shields.io/gittip/alexgorbatchev.svg)](https://gittip.com/alexgorbatchev)
[![Dependency status](https://img.shields.io/david/alexgorbatchev/gulp-print.svg)](https://david-dm.org/alexgorbatchev/gulp-print)
[![devDependency Status](https://img.shields.io/david/dev/alexgorbatchev/gulp-print.svg)](https://david-dm.org/alexgorbatchev/gulp-print#info=devDependencies)
[![Build Status](https://img.shields.io/travis/alexgorbatchev/gulp-print.svg)](https://travis-ci.org/alexgorbatchev/gulp-print)

This is a very basic [gulp](http://gulpjs.com) plugin that prints names of files. It's useful as a debugging tool to see which files are moving through the pipe or as a status printout.

## Installation

```sh
npm install gulp-print
```

## Usage Example

```js
// CommonJS
const gulp = require('gulp');
const print = require('gulp-print').default;

// ... or ES modules
import * as gulp from 'gulp';
import print from 'gulp-print';

gulp.task('print', () => {
  gulp.src('test/*.js')
    .pipe(print())
});

// ... or using custom formatter:

gulp.task('print', () => {
  gulp.src('test/*.js')
    .pipe(print(filepath => `built: ${filepath}`))
});

// ... change log function
import { setLogFunction } from 'gulp-print';

setLogFunction(message => console.log('LOG', message));
```

## API

### print(formatter)

* `formatter` is a callback format function that passes in filepath to be printed. Callback should return a string which will be printed.

## Testing

```sh
npm test
```

## License

The MIT License (MIT)

Copyright 2014 Alex Gorbatchev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.