# gulp-vinyl-flow

> Check Vinyl files, streams or buffers, going through your Gulp™ pipeline(s).

Latest version **1.1.0** (published 2020-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-vinyl-flow
pnpm add gulp-vinyl-flow
yarn add gulp-vinyl-flow
bun add gulp-vinyl-flow
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-05-12 |
| First published | 2020-05-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ben Michaud |
| Maintainers | tigersway |
| Keywords | gulp, gulp-plugin, debug, vinyl, gulp-debug |

## Links

- npm: https://www.npmjs.com/package/gulp-vinyl-flow
- Repository: https://github.com/TigersWay/gulp-vinyl-flow
- Homepage: https://github.com/TigersWay/gulp-vinyl-flow#readme
- Issues: https://github.com/TigersWay/gulp-vinyl-flow/issues
- npm.io page: https://npm.io/package/gulp-vinyl-flow

## Dependencies (4)

- [through2](https://npm.io/package/through2.md) ^3.0.1
- [fancy-log](https://npm.io/package/fancy-log.md) ^1.3.3
- [ansi-colors](https://npm.io/package/ansi-colors.md) ^4.1.1
- [replace-homedir](https://npm.io/package/replace-homedir.md) ^1.0.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-05-12
- 1.0.0 — 2020-05-07

## README

# gulp-vinyl-flow  ![GitHub last commit](https://img.shields.io/github/last-commit/tigersway/gulp-vinyl-flow?style=flat-square) ![GitHub issues](https://img.shields.io/github/issues/tigersway/gulp-vinyl-flow?style=flat-square)

Allows you to check Vinyl files, streams or buffers, going through your Gulp™ pipeline(s).

![screenshot](./gulp-vinyl-flow.png)

### Install  [![npm](https://img.shields.io/npm/v/gulp-vinyl-flow?style=flat-square)](https://www.npmjs.com/package/gulp-vinyl-flow)

```sh
$ npm install gulp-vinyl-flow --save-dev
```

### Usage

```js
const gulp = require('gulp');
const debug = require('gulp-vinyl-flow');

exports.default = () => (
  gulp.src('static/images/**/*.{jpg,png}', {base:'static'})
    .pipe(debug('Images'))
    .pipe(gulp.dest('dist'));
);
```

### API

#### gulp-vinyl-flow([title | options])

- **title** (`string`)\
Same as `options.title`.
- **options**
  - **title** (`string` | Default: `Vinyl`)\
  Allow a custom title to distinguish outputs over potential multiple logging instances.
  - **minimal** (`boolean` | Default: `true`) **v1.1.0+**\
  By default only vinyl.relative is shown. With Minimal off will also show cwd, base & path.
  - **showFiles** (`boolean` | Default: `true`)\
  Print `vinyl.relative`.
  - **showCount** (`boolean` | Default: `true`)\
  Print the vinyl files count.

---
_Source: https://npm.io/package/gulp-vinyl-flow · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._