{"id":16716328,"url":"https://github.com/gucong3000/gulp-reporter","last_synced_at":"2025-03-15T13:30:54.990Z","repository":{"id":57258723,"uuid":"77354554","full_name":"gucong3000/gulp-reporter","owner":"gucong3000","description":"Error report for: CSSLint/EditorConfig/ESLint/HTMLHint/JSCS/JSHint/PostCSS/Standard/TSLint/XO","archived":false,"fork":false,"pushed_at":"2020-06-01T01:17:51.000Z","size":1635,"stargazers_count":17,"open_issues_count":43,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-03-15T07:48:15.714Z","etag":null,"topics":["author","blame","eslint","git","gulp","jscs","jshint","postcss","reporter","tslint"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gucong3000.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-26T03:13:09.000Z","updated_at":"2020-03-17T22:56:37.000Z","dependencies_parsed_at":"2022-08-28T21:50:45.958Z","dependency_job_id":null,"html_url":"https://github.com/gucong3000/gulp-reporter","commit_stats":null,"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucong3000%2Fgulp-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucong3000%2Fgulp-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucong3000%2Fgulp-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucong3000%2Fgulp-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gucong3000","download_url":"https://codeload.github.com/gucong3000/gulp-reporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243735798,"owners_count":20339531,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["author","blame","eslint","git","gulp","jscs","jshint","postcss","reporter","tslint"],"created_at":"2024-10-12T21:12:59.488Z","updated_at":"2025-03-15T13:30:54.647Z","avatar_url":"https://github.com/gucong3000.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"gulp-reporter\n======\n\n[![NPM version](https://img.shields.io/npm/v/gulp-reporter.svg?style=flat-square)](https://www.npmjs.com/package/gulp-reporter)\n[![Travis](https://img.shields.io/travis/gucong3000/gulp-reporter.svg?label=Linux)](https://travis-ci.org/gucong3000/gulp-reporter)\n[![AppVeyor](https://img.shields.io/appveyor/ci/gucong3000/gulp-reporter.svg?label=Windows)](https://ci.appveyor.com/project/gucong3000/gulp-reporter)\n[![Codecov](https://img.shields.io/codecov/c/github/gucong3000/gulp-reporter.svg)](https://codecov.io/gh/gucong3000/gulp-reporter)\n[![David](https://img.shields.io/david/gucong3000/gulp-reporter.svg)](https://david-dm.org/gucong3000/gulp-reporter)\n\nError report for:\n[CSSLint](https://github.com/lazd/gulp-csslint)\n[EditorConfig](https://github.com/jedmao/eclint)\n[ESLint](https://github.com/adametry/gulp-eslint)\n[HTMLHint](https://github.com/bezoerb/gulp-htmlhint)\n[JSCS](https://github.com/jscs-dev/gulp-jscs)\n[JSHint](https://github.com/spalger/gulp-jshint)\n[JSONLint](https://github.com/rogeriopvl/gulp-jsonlint)\n[PostCSS](https://github.com/StartPolymer/gulp-html-postcss)\n[Standard](https://github.com/emgeee/gulp-standard)\n[StyLint](https://github.com/danielhusar/gulp-stylint)\n[TSLint](https://github.com/panuhorsmalahti/gulp-tslint)\n[XO](https://github.com/sindresorhus/gulp-xo)\n\nAnalyzing blame of the error, only fail for errors that belong to current GIT user.\n\n## Install\n\n```bash\nnpm install gulp-reporter\n```\n\n## Usage\n\n```js\ngulp.src('test/fixtures/eslint/invalid.js')\n  .pipe(eslint())\n  .pipe(reporter(options));\n```\n\n![demo](demo.png)\n\n## API\n\n```js\nreporter(options)\n```\nor\n\n```js\nreporter((file) =\u003e options)\n```\n\n### options.browser\n\nType: `boolean`\n\nDefault: `false`\n\n[Report error messages right in your browser.](http://postcss.github.io/postcss-browser-reporter/screenshot.png)\n\n### options.output\n\nType: `boolean|function|WritableStream`\n\nDefault: `true` and `false` for [Special output format](#special-output-format)\n\nReport error messages in [fancy-log](https://www.npmjs.com/package/fancy-log) or your `function|WritableStream`\n\n### options.sort\n\nType: `boolean|function`\n\nDefault: `true`\n\nMessages 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).\n\n\n### options.author\nType: `{name?: string|RegExp, email?: string|RegExp}`\n\nDefault: Read from GIT pre-commit environment and fallbacks with GIT commad `git log --max-count=1 --no-merges`\n\nDo not fail for errors that not belong to specified author.\n\n\u003e Do not work when `options.blame` set to `false`\n\n### options.expires\n\nType: `string` for [time periods](https://www.npmjs.com/package/to-time#usage), `number` of unix timestamp, `Date`\n\nDo not fail for old errors that create early specified time.\n\n\u003e Do not work when `options.blame` set to `false`\n\n### options.maxLineLength\n\nType: `number`\n\nDefault: 512\n\nHide each error in lines that length greater than this threshold.\n\n### options.mapper\n\nType: `function|null`\n\nDefault: `null`\n\nConvert errors.\n\n```\nreporter({\n  mapper: file =\u003e {\n    const path = file.path;\n    return error =\u003e {\n      // Do not report unrelated errors.\n      if (error.fileName === path) {\n        return error\n      }\n    }\n  }\n})\n```\n\n### options.fail\n\nType: `boolean|function`\n\nDefault: `true`\n\nStop a task/stream if an error has been reported for any file, but wait for all of them to be processed first.\n\n### options.blame\n\nType: `boolean`\n\nDefault: `true`\n\nEnable or disable [git-blame](https://git-scm.com/docs/git-blame) related features (options.author, options.expires).\n\n## Language localization support for HTMLHint JSHint EditorConfig:\n\n- en\n- zh_CN\n- zh_TW\n\n\u003e 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.\n\n## Special output format\n\n- AppVeyor\n  \u003e Output as compilation message use [Build Worker API](https://www.appveyor.com/docs/build-worker-api/#add-compilation-message)\n- CircleCI\n  \u003e 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/).\n- Jenkins\n  \u003e 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.\n\n## Related\n\n- [eclint](https://github.com/jedmao/eclint)\n- [gulp-csslint](https://github.com/lazd/gulp-csslint)\n- [gulp-eslint](https://github.com/adametry/gulp-eslint)\n- [gulp-html-postcss](https://github.com/StartPolymer/gulp-html-postcss)\n- [gulp-htmlhint](https://github.com/bezoerb/gulp-htmlhint)\n- [gulp-jscs](https://github.com/jscs-dev/gulp-jscs)\n- [gulp-jshint](https://github.com/spalger/gulp-jshint)\n- [gulp-jsonlint](https://github.com/rogeriopvl/gulp-jsonlint)\n- [gulp-standard](https://github.com/emgeee/gulp-standard)\n- [gulp-stylint](https://github.com/danielhusar/gulp-stylint)\n- [gulp-tslint](https://github.com/panuhorsmalahti/gulp-tslint)\n- [gulp-xo](https://github.com/sindresorhus/gulp-xo)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgucong3000%2Fgulp-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgucong3000%2Fgulp-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgucong3000%2Fgulp-reporter/lists"}