# gulp-david-stylish

> A stylish reporter for the gulp-david Gulp plugin

Latest version **1.0.2** (published 2017-01-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-david-stylish
pnpm add gulp-david-stylish
yarn add gulp-david-stylish
bun add gulp-david-stylish
```

## 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.2 |
| Published | 2017-01-05 |
| First published | 2016-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andrew Powell |
| Maintainers | shellscape |
| Keywords | gulp, david, stylish, reporter |

## Links

- npm: https://www.npmjs.com/package/gulp-david-stylish
- Repository: https://github.com/shellscape/gulp-david-stylish
- Homepage: https://github.com/shellscape/gulp-david-stylish#readme
- Issues: https://github.com/shellscape/gulp-david-stylish/issues
- npm.io page: https://npm.io/package/gulp-david-stylish

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2017-01-05
- 1.0.1 — 2016-12-14
- 1.0.0 — 2016-12-14

## README

# gulp-david-stylish [![Build Status](https://travis-ci.org/shellscape/gulp-david-stylish.svg?branch=master)](https://travis-ci.org/shellscape/gulp-david-stylish)
> A stylish reporter for the gulp-david Gulp plugin

![gulp-david-stylish](gulp-david-stylish.png)

## Installing

The reporter can be installed via NPM:

```bash
npm install gulp-david-stylish --save-dev
```

## Usage

Setup is rather easy. Please refer to the [gulp-david](https://github.com/cedx/gulp-david)
documentation for getting started with the plugin. To use gulp-david-stylish,
use the following pattern, or similar:

```js
const { david } = require('@cedx/gulp-david');
const stylish = require('gulp-david-stylish');

gulp.task('deps', (done) => {

  const glob = [
    'package.json',
    '!node_modules'
  ];

  gulp.src(glob)
    .pipe(david({
      reporter: new stylish.Reporter(done)
    }));
});
```

This breaks from reporter export styles such as jshint-stylish, but follows the
patterns set in the [default reporter](https://github.com/cedx/gulp-david/blob/master/src/reporter.js)
of gulp-david.

You'll notice that we're using a gulp task callback with the `done` parameter.
That parameter is a function which lets gulp know a task is complete. Contrary
to just returning the stream, using the `done` callback will block a task from
finishing until it's called. Since gulp-david [runs the david module async](https://github.com/cedx/gulp-david/issues/12)
the task will finish before the reporter has an opportunity to display the results.
To combat this (until or if gulp-david is modified) we can pass the `done`
callback to `gulp-david-stylish` which will call the function when the reporter
has completed logging the results.

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