# gulp-displaylog

> gulp display log

Latest version **1.0.3** (published 2019-01-09) · MIT license · 0 weekly downloads

## Install

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

## 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.0.3 |
| Published | 2019-01-09 |
| First published | 2017-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 103.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ilex.h |
| Maintainers | ilex.h |
| Keywords | gulpplugin, display log |

## Links

- npm: https://www.npmjs.com/package/gulp-displaylog
- npm.io page: https://npm.io/package/gulp-displaylog

## Dependencies (6)

- [plur](https://npm.io/package/plur.md) ^2.0.0
- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [tildify](https://npm.io/package/tildify.md) ^1.1.2
- [through2](https://npm.io/package/through2.md) ^2.0.0
- [time-stamp](https://npm.io/package/time-stamp.md) ^2.2.0
- [stringify-object](https://npm.io/package/stringify-object.md) ^3.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.0.3 (latest) — 2019-01-09
- 1.0.2 — 2018-12-17
- 1.0.1 — 2017-06-03
- 1.0.0 — 2017-05-24

## README

# gulp-displaylog

by ilex.h

> default use

![Image text](default.png)

> onlyPath

![Image text](onlyPath.png)

## Install

```
$ npm install --save-dev gulp-displaylog
```

## Usage

```js
const gulp = require('gulp');
const displaylog = require('gulp-displaylog');

gulp.task('default', () =>
	gulp.src('*.js')
		.pipe(displaylog({title: 'amosg'}))
		.pipe(gulp.dest('dist'))
);
gulp.task('some', () =>
  gulp.src('*').pipe(displaylog({
    title: 'amos',
    isRelative: false
  })));
```

### use logger

```js
const displaylog = require('gulp-displaylog');

const logger = displaylog.logger;

logger('hello'); // console.log
logger.info('hello'); // console.info
logger.dir('hello'); // console.dir
logger.warn('hello'); // console.warn
logger.error('hello'); // console.error


```

## API

### displaylog([options])

#### options

|name|type|default|description|
|------|------|------|------|
|title|string|`amos-displaylog:`|Give it a custom title so it's possible to distinguish the output of multiple instances logging at once.|
|isRelative|boolean|true|By default only relative paths are shown. Turn off isRelative mode to also show `cwd`, `base`, `path`. The [`stat` property](http://nodejs.org/api/fs.html#fs_class_fs_stats) will be shown when you run gulp in verbose mode: `gulp --verbose`.|
|onlyPath|boolean|true|`only when isRelative is false, then onlyPath will worked. if onlyPath is true, will show full path, or show cwd、base、path`|
|showFiles|boolean|true|Setting this to false will skip printing the file names and only show the file count.|

### changelog

* 2019-1-9 v1.0.3

  1. `-gulplog`
  2. `add custom logger`

* 2018-12-17 v1.0.2

  1. `-gulp-util`
  2. `+gulplog`
  3. `update gulp@4.0.0`

## License

MIT

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