# eslint-html-reporter

> HTML Reporter for ESLint

Latest version **0.7.4** (published 2019-09-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-html-reporter
pnpm add eslint-html-reporter
yarn add eslint-html-reporter
bun add eslint-html-reporter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.4 |
| Published | 2019-09-25 |
| First published | 2015-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 33 |
| Maintainers | ratherblue |
| Keywords | eslint, reporter, teamcity |

## Links

- npm: https://www.npmjs.com/package/eslint-html-reporter
- Repository: https://github.com/ratherblue/eslint-html-reporter
- Issues: https://github.com/ratherblue/eslint-html-reporter/issues
- npm.io page: https://npm.io/package/eslint-html-reporter

## Dependencies (2)

- [hairballs](https://npm.io/package/hairballs.md) ^0.3.2
- [handlebars](https://npm.io/package/handlebars.md) ^4.3.1

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.7.4 (latest) — 2019-09-25
- 0.7.3 — 2019-05-01
- 0.7.1 — 2019-03-06
- 0.7.0 — 2019-03-06
- 0.6.2 — 2019-02-26
- 0.5.2 — 2016-04-07
- 0.5.1 — 2016-04-07
- 0.5.0 — 2016-04-07
- 0.4.14 — 2015-08-06
- 0.4.13 — 2015-08-06
- 0.4.12 — 2015-08-04
- 0.4.11 — 2015-06-02
- 0.4.10 — 2015-04-20
- 0.4.9 — 2015-04-20
- 0.4.8 — 2015-04-13
- … 17 more at https://npm.io/package/eslint-html-reporter/versions

## README

# ESLint HTML Reporter

[![Build Status](https://img.shields.io/travis/ratherblue/eslint-html-reporter.svg?style=flat-square)](https://travis-ci.org/ratherblue/eslint-html-reporter)
[![Coverage Status](https://img.shields.io/coveralls/ratherblue/eslint-html-reporter.svg?style=flat-square)](https://coveralls.io/r/ratherblue/eslint-html-reporter)
[![License](https://img.shields.io/github/license/ratherblue/eslint-html-reporter.svg?style=flat-square)](https://github.com/ratherblue/eslint-html-reporter/blob/master/LICENSE)
[![Dependencies](https://img.shields.io/david/ratherblue/eslint-html-reporter.svg?style=flat-square)](https://david-dm.org/ratherblue/eslint-html-reporter)
[![devDependency Status](https://img.shields.io/david/dev/ratherblue/eslint-html-reporter.svg?style=flat-square)](https://david-dm.org/ratherblue/eslint-html-reporter#info=devDependencies&view=table)

HTML Reporter for ESLint. Please report bugs to [https://github.com/ratherblue/eslint-html-reporter/issues](https://github.com/ratherblue/eslint-html-reporter/issues)

Features:
* Generates an HTML page with a summary of all linted files and their errors
* Choice between detailed and "lite" output
* Optional integration with TeamCity's console
* Shows summary of all errors and warnings so you can easily identify top linting issues


## Installation

```sh
npm install eslint-html-reporter
```

## Usage

### With [ESLint CLI](http://eslint.org/docs/user-guide/command-line-interface):

```sh
# Basic - Single file
eslint file.js -f node_modules/eslint-html-reporter/reporter.js -o report.html

# Basic - Recurse current directory
eslint . -f node_modules/eslint-html-reporter/reporter.js -o report.html

# "Lite" (same as Basic, but omits the detailed error messages)
eslint file.js -f node_modules/eslint-html-reporter/reporter-lite.js -o report.html

# TeamCity Basic
eslint file.js -f node_modules/eslint-html-reporter/reporter-team-city.js -o report.html

# TeamCity "Lite"
eslint file.js -f node_modules/eslint-html-reporter/reporter-lite-team-city.js -o report.html
```

### With [Gulp ESLint](https://github.com/adametry/gulp-eslint):

```js
var eslint   = require('gulp-eslint');
var reporter = require('eslint-html-reporter');
var path     = require('path');
var fs       = require('fs');

gulp.src(['js/**/*.js'])
  .pipe(eslint())
  .pipe(eslint.format(reporter, function(results) {
      fs.writeFileSync(path.join(__dirname, 'report-results.html'), results);
    })
  );
```

## License

[MIT](https://github.com/ratherblue/eslint-html-reporter/blob/master/LICENSE)

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