# gulp-standard

> gulp plugin for checking JavaScript code with the standard syntax

Latest version **14.0.0** (published 2019-08-25) · MIT license · 0 weekly downloads

## Install

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

## 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 | 14.0.0 |
| Published | 2019-08-25 |
| First published | 2015-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31 |
| Author | Matt Green |
| Maintainers | emgeee |
| Keywords | standard, gulpplugin |

## Links

- npm: https://www.npmjs.com/package/gulp-standard
- Repository: https://github.com/emgeee/gulp-standard
- Issues: https://github.com/emgeee/gulp-standard/issues
- npm.io page: https://npm.io/package/gulp-standard

## Dependencies (7)

- [path](https://npm.io/package/path.md) ^0.12.7
- [colors](https://npm.io/package/colors.md) ^1.2.4
- [standard](https://npm.io/package/standard.md) ^14.0.0
- [through2](https://npm.io/package/through2.md) ^3.0.1
- [log-symbols](https://npm.io/package/log-symbols.md) ^3.0.0
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.0
- [app-root-path](https://npm.io/package/app-root-path.md) ^2.0.0

## Recent versions

- 14.0.0 (latest) — 2019-08-25
- 13.1.0 — 2019-07-30
- 12.0.0 — 2018-09-12
- 11.0.0 — 2018-05-06
- 10.1.2 — 2018-01-31
- 10.1.1 — 2017-08-23
- 10.1.0 — 2017-08-09
- 10.0.0 — 2017-04-07
- 9.0.0 — 2017-03-01
- 8.0.4 — 2017-02-16
- 8.0.3 — 2016-12-12
- 8.0.2 — 2016-08-25
- 8.0.1 — 2016-08-24
- 8.0.0 — 2016-08-24
- 7.0.1 — 2016-05-16
- … 7 more at https://npm.io/package/gulp-standard/versions

## README

#gulp-standard
[![Build Status](https://travis-ci.org/emgeee/gulp-standard.png?branch=master)](https://travis-ci.org/emgeee/gulp-standard)
[![NPM version](https://badge.fury.io/js/gulp-standard.png)](http://badge.fury.io/js/gulp-standard)

> [Standard](https://github.com/feross/standard/) linter for gulp

## Information

<table>
<tr>
<td>Package</td><td>gulp-standard</td>
</tr>
<tr>
<td>Description</td>
<td>Standard plugin for gulp</td>
</tr>
<tr>
<td>Node version</td>
<td>>=6 </td>
</tr>
<tr>
<td>gulp version</td>
<td>3.x</td>
</tr>
</table>

## Usage

#### Install

```sh
$ npm install --save-dev gulp-standard
```

## Examples

```javascript
// include the required packages.
var gulp = require('gulp')
var standard = require('gulp-standard')

gulp.task('standard', function () {
  return gulp.src(['./app.js'])
    .pipe(standard())
    .pipe(standard.reporter('default', {
      breakOnError: true,
      quiet: true
    }))
})
```

## Reporters

#### Built-in

You can choose a reporter when you call
````javascript
stuff
  .pipe(standard())
  .pipe(standard.reporter('default', opts))
External
````

You can also use some other custom made reporter
````javascript
var reporter = require(<SOME_REPORTER>)

stuff
  .pipe(standard())
  .pipe(standard.reporter(reporter, opts))
````
OR -
````javascript
stuff
  .pipe(standard())
  .pipe(standard.reporter(<REPORTER NAME>, opts))
````
#### Reporter options

##### breakOnError

Type: `boolean`
Default: `false`

Emit gulp error on reported error

##### breakOnWarning

Type: `boolean`
Default: `false`

Emit gulp error on reported warning

##### quiet

Type: `boolean`
Default: `false`

Suppress success messages, only show errors

##### showRuleNames

Type: `boolean`
Default: `false`

Show rule names for errors/warnings (to ignore specific rules)

##### showFilePath

Type: `boolean`
Default: `false`

Show the full file path with the line and column numbers (useful for IDEs that will link to that location)

## LICENSE [MIT](LICENSE)

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