eslint-html-report

🎨 A beautiful HTML reporter for ESLint with modern UI

Forked from eslint-detailed-reporter

✨ Features

• 📊 Summary Dashboard - Top errors, warnings, and problematic files at a glance
• 💻 Source Code View - See issues highlighted directly in your code
• 📁 Flexible Grouping - View issues by file or by rule
• 🔍 Filter & Search - Quickly find what you're looking for
• 🌿 Git Integration - Shows branch, commit, and timestamp
• 🎯 Modern UI - Clean design with ESLint branding

📸 Example

👉 View example report

👉 View success report

🚀 Quick Start

npx eslint-html-report

That's it! This will run ESLint and generate eslint-report.html in your project.

📦 Installation

npm install eslint-html-report -D

📖 Usage

CLI (Recommended)

# Auto-run ESLint and generate report
npx eslint-html-report

# Specify output file
npx eslint-html-report my-report.html

# Use existing ESLint JSON output
npx eslint-html-report eslint.json report.html

With ESLint CLI

eslint . -f node_modules/eslint-html-report/lib/detailed.js -o report.html

With Grunt

module.exports = function(grunt) {
  'use strict';

  require('load-grunt-tasks')(grunt);

  grunt.initConfig({
    eslint: {
      options: {
        outputFile: 'report.html',
        format: require('eslint-html-report')
      },
      target: ['src/**/*.js']
    }
  });

  grunt.registerTask('default', ['eslint']);
};

With Gulp

const eslint   = require('gulp-eslint');
const reporter = require('eslint-html-report');
const path     = require('path');
const fs       = require('fs');

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

🤝 Contributing

Contributions are welcome! Feel free to open a pull request.

npm install
npm test

📝 Changelog

See CHANGELOG

📄 License

MIT