https://github.com/sindresorhus/gulp-debug

Debug Vinyl file streams to see what files are run through your Gulp pipeline
https://github.com/sindresorhus/gulp-debug

debug gulp-plugin javascript nodejs vinyl

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/sindresorhus/gulp-debug
• Owner: sindresorhus
• License: mit
• Created: 2014-01-09T06:06:38.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2023-11-03T08:41:43.000Z (about 1 year ago)
• Last Synced: 2024-04-13T21:25:24.881Z (7 months ago)
• Topics: debug, gulp-plugin, javascript, nodejs, vinyl
• Language: JavaScript
• Homepage:
• Size: 77.1 KB
• Stars: 221
• Watchers: 6
• Forks: 29
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

README

        
# gulp-debug

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



## 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.