# gulp-debug

> Debug Vinyl file streams to see what files are run through your Gulp pipeline

Latest version **5.0.1** (published 2023-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-debug
pnpm add gulp-debug
yarn add gulp-debug
bun add gulp-debug
```

## Health

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

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.1 |
| Published | 2023-11-03 |
| First published | 2014-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/gulp-debug) |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 5 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 220 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | gulpplugin, debug, debugging, inspect, log, logger, vinyl, file, fs |

## Links

- npm: https://www.npmjs.com/package/gulp-debug
- Repository: https://github.com/sindresorhus/gulp-debug
- Homepage: https://github.com/sindresorhus/gulp-debug#readme
- Issues: https://github.com/sindresorhus/gulp-debug/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/gulp-debug

## Dependencies (5)

- [plur](https://npm.io/package/plur.md) ^5.1.0
- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [tildify](https://npm.io/package/tildify.md) ^3.0.0
- [stringify-object](https://npm.io/package/stringify-object.md) ^5.0.0
- [gulp-plugin-extras](https://npm.io/package/gulp-plugin-extras.md) ^0.3.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 5.0.1 (latest) — 2023-11-03
- 5.0.0 — 2023-11-02
- 4.0.0 — 2018-04-29
- 3.2.0 — 2017-12-31
- 3.1.0 — 2017-02-13
- 3.0.0 — 2016-11-08
- 2.1.2 — 2015-10-09
- 2.1.1 — 2015-10-04
- 2.1.0 — 2015-08-10
- 2.0.1 — 2015-02-24
- 2.0.0 — 2014-12-30
- 1.0.1 — 2014-09-02
- 1.0.0 — 2014-07-25
- 0.3.1 — 2014-07-25
- 0.3.0 — 2014-03-28
- … 4 more at https://npm.io/package/gulp-debug/versions

## README

# gulp-debug

> Debug [Vinyl](https://github.com/gulpjs/vinyl) file streams to see what files are run through your Gulp pipeline

<img src="screenshot.png" width="415">

## Install

```sh
npm install --save-dev gulp-debug
```

## Usage

```js
import gulp from 'gulp';
import debug from 'gulp-debug';

export default () => (
	gulp.src('foo.js')
		.pipe(debug({title: 'unicorn:'}))
		.pipe(gulp.dest('dist'))
);
```

## API

### debug(options?)

#### options

Type: `object`

##### title

Type: `string`\
Default: `'gulp-debug:'`

Give it a custom title so it's possible to distinguish the output of multiple instances logging at once.

##### minimal

Type: `boolean`\
Default: `true`

By default only relative paths are shown. Turn off minimal mode to also show `cwd`, `base`, `path`.

The [`stat` property](https://nodejs.org/api/fs.html#fs_class_fs_stats) will be shown when you run gulp in verbose mode: `gulp --verbose`.

##### showFiles

Type: `boolean`\
Default: `true`

Print filenames.

##### showCount

Type: `boolean`\
Default: `true`

Print the file count.

##### logger(message)

Type: `Function`\
Default: `console.log`

Provide your own logging utility.

The message is passed as a string in the first argument. Note that [ANSI colors](https://github.com/chalk/chalk) may be used in the message.

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