https://github.com/gucong3000/gulp-reporter
Error report for: CSSLint/EditorConfig/ESLint/HTMLHint/JSCS/JSHint/PostCSS/Standard/TSLint/XO
https://github.com/gucong3000/gulp-reporter
author blame eslint git gulp jscs jshint postcss reporter tslint
Last synced: 7 months ago
JSON representation
Error report for: CSSLint/EditorConfig/ESLint/HTMLHint/JSCS/JSHint/PostCSS/Standard/TSLint/XO
- Host: GitHub
- URL: https://github.com/gucong3000/gulp-reporter
- Owner: gucong3000
- License: mit
- Created: 2016-12-26T03:13:09.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-01T01:17:51.000Z (over 5 years ago)
- Last Synced: 2024-03-15T07:48:15.714Z (over 1 year ago)
- Topics: author, blame, eslint, git, gulp, jscs, jshint, postcss, reporter, tslint
- Language: JavaScript
- Homepage:
- Size: 1.56 MB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
gulp-reporter
======
[](https://www.npmjs.com/package/gulp-reporter)
[](https://travis-ci.org/gucong3000/gulp-reporter)
[](https://ci.appveyor.com/project/gucong3000/gulp-reporter)
[](https://codecov.io/gh/gucong3000/gulp-reporter)
[](https://david-dm.org/gucong3000/gulp-reporter)
Error report for:
[CSSLint](https://github.com/lazd/gulp-csslint)
[EditorConfig](https://github.com/jedmao/eclint)
[ESLint](https://github.com/adametry/gulp-eslint)
[HTMLHint](https://github.com/bezoerb/gulp-htmlhint)
[JSCS](https://github.com/jscs-dev/gulp-jscs)
[JSHint](https://github.com/spalger/gulp-jshint)
[JSONLint](https://github.com/rogeriopvl/gulp-jsonlint)
[PostCSS](https://github.com/StartPolymer/gulp-html-postcss)
[Standard](https://github.com/emgeee/gulp-standard)
[StyLint](https://github.com/danielhusar/gulp-stylint)
[TSLint](https://github.com/panuhorsmalahti/gulp-tslint)
[XO](https://github.com/sindresorhus/gulp-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));
```
## API
```js
reporter(options)
```
or
```js
reporter((file) => options)
```
### options.browser
Type: `boolean`
Default: `false`
[Report error messages right in your browser.](http://postcss.github.io/postcss-browser-reporter/screenshot.png)
### options.output
Type: `boolean|function|WritableStream`
Default: `true` and `false` for [Special output format](#special-output-format)
Report error messages in [fancy-log](https://www.npmjs.com/package/fancy-log) or your `function|WritableStream`
### options.sort
Type: `boolean|function`
Default: `true`
Messages will be sorted by fileName/severity/line/column, [or your function](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Parameters).
### options.author
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`
### options.expires
Type: `string` for [time periods](https://www.npmjs.com/package/to-time#usage), `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`
### options.maxLineLength
Type: `number`
Default: 512
Hide each error in lines that length greater than this threshold.
### options.mapper
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
}
}
}
})
```
### options.fail
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.
### options.blame
Type: `boolean`
Default: `true`
Enable or disable [git-blame](https://git-scm.com/docs/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`](http://www.gnu.org/software/libc/manual/html_node/Locale-Categories.html#Locale-Categories) 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](https://www.appveyor.com/docs/build-worker-api/#add-compilation-message)
- CircleCI
> Output as junit format to directory that defined in [`$CIRCLE_TEST_REPORTS` ](https://circleci.com/docs/1.0/test-metadata/) or [`store_test_results`](https://circleci.com/docs/2.0/collect-test-data/).
- Jenkins
> Output as [checkstyle](http://checkstyle.sourceforge.net) format to directory defined in `$CI_REPORTS`, you need to install [Checkstyle Plugin](https://plugins.jenkins.io/checkstyle) to view it.
## Related
- [eclint](https://github.com/jedmao/eclint)
- [gulp-csslint](https://github.com/lazd/gulp-csslint)
- [gulp-eslint](https://github.com/adametry/gulp-eslint)
- [gulp-html-postcss](https://github.com/StartPolymer/gulp-html-postcss)
- [gulp-htmlhint](https://github.com/bezoerb/gulp-htmlhint)
- [gulp-jscs](https://github.com/jscs-dev/gulp-jscs)
- [gulp-jshint](https://github.com/spalger/gulp-jshint)
- [gulp-jsonlint](https://github.com/rogeriopvl/gulp-jsonlint)
- [gulp-standard](https://github.com/emgeee/gulp-standard)
- [gulp-stylint](https://github.com/danielhusar/gulp-stylint)
- [gulp-tslint](https://github.com/panuhorsmalahti/gulp-tslint)
- [gulp-xo](https://github.com/sindresorhus/gulp-xo)