gulp-reporter

gulp-reporter
======


Error report for:
CSSLint
EditorConfig
ESLint
HTMLHint
JSCS
JSHint
JSONLint
PostCSS
Standard
StyLint
TSLint
XO

Analyzing blame of the error, only fail for errors that belong to current GIT user.

Install

``bash
npm install gulp-reporter
`

Usage

`js
gulp.src('test/fixtures/eslint/invalid.js')
.pipe(eslint())
.pipe(reporter(options));
`

!demo

API

`js
reporter(options)
`
or

`js
reporter((file) => options)
`

$3

Type: boolean

Default: false

Report error messages right in your browser.

$3

Type: boolean|function|WritableStream

Default: true and false for Special output format

Report error messages in fancy-log or your function|WritableStream

$3

Type: boolean|function

Default: true

Messages will be sorted by fileName/severity/line/column, or your function.




$3


Type: {name?: string|RegExp, email?: string|RegExp}

Default: Read from GIT pre-commit environment and fallbacks with GIT commad git log --max-count=1 --no-merges

Do not fail for errors that not belong to specified author.

> Do not work when options.blame set to false

$3

Type: string for time periods, number of unix timestamp, Date

Do not fail for old errors that create early specified time.

> Do not work when options.blame set to false

$3

Type: number

Default: 512

Hide each error in lines that length greater than this threshold.

$3

Type: function|null

Default: null

Convert errors.

`
reporter({
mapper: file => {
const path = file.path;
return error => {
// Do not report unrelated errors.
if (error.fileName === path) {
return error
}
}
}
})
`

$3

Type: boolean|function

Default: true

Stop a task/stream if an error has been reported for any file, but wait for all of them to be processed first.

$3

Type: boolean

Default: true

Enable or disable git-blame related features (options.author, options.expires).

Language localization support for HTMLHint JSHint EditorConfig:

- en
- zh_CN
- zh_TW

> POSIX systems: The returned locale refers to the LC_MESSAGE category, suitable for selecting the language used in the user interface for message translation.

Special output format

- AppVeyor
> Output as compilation message use Build Worker API
- CircleCI
> Output as junit format to directory that defined in $CIRCLE_TEST_REPORTS or store_test_results.
- Jenkins
> Output as checkstyle format to directory defined in $CI_REPORTS`, you need to install Checkstyle Plugin to view it.

Related

- eclint
- gulp-csslint
- gulp-eslint
- gulp-html-postcss
- gulp-htmlhint
- gulp-jscs
- gulp-jshint
- gulp-jsonlint
- gulp-standard
- gulp-stylint
- gulp-tslint
- gulp-xo