Registry / testing / eslint-detailed-reporter

eslint-detailed-reporter

library0.9.0jsnpmunverified

An HTML reporter for ESLint that provides detailed output including total problem counts, tables of top warnings and errors, a list of files with the most issues, source code views with highlighted problems, and per-file summaries. Current version 0.9.0 supports ESLint 3.x to 8.x (peer dep: eslint >=3.0.0 <9). It features links to rule descriptions, keyboard accessibility, and optional multi-file output. Updated sporadically, last release in 2020.

testing

npm install eslint-detailed-reporter

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-DETAILED-RE

eslint-detailed-reporter

testingjavascriptv0.9.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

reporterFn

✓ import reporter from 'eslint-detailed-reporter'

✗ const reporter = require('eslint-detailed-reporter').default

Package exports a single function via default export; ESM import works as shown. For CommonJS, use require('eslint-detailed-reporter').

format path (multi-file)

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

✗ eslint . -f eslint-detailed-reporter -o report.html

The multi-file formatter must be referenced via its full path to lib/detailed-multi.js. Single-file formatter is at lib/detailed.js.

format option in Grunt

✓ format: require('eslint-detailed-reporter')

✗ format: 'eslint-detailed-reporter'

In Grunt, you must pass the required function, not a string. The string approach will not work.

Shows installation, CLI usage for single and multi-file output, and programmatic usage with Node.js.

// Install npm install eslint-detailed-reporter --save-dev // Run ESLint with the reporter (single file output) eslint file.js -f node_modules/eslint-detailed-reporter/lib/detailed.js -o report.html // Run ESLint with the reporter (multi-file output, experimental) eslint . -f node_modules/eslint-detailed-reporter/lib/detailed-multi.js -o report.html // Alternative: use the exported module for programmatic usage const reporter = require('eslint-detailed-reporter'); const fs = require('fs'); const results = /* get ESLint results */; const html = reporter(results); fs.writeFileSync('report.html', html);

Debug

Known issues

gotchaESLint >=9 is not supported. The peer dependency specifies eslint >=3.0.0 <9, so ESLint 9 and above will not work.

fix

Use an older version of ESLint (e.g., 8.x) or consider alternatives like eslint-formatter-html.

affects: >=9.0.0

gotchaThe multi-file output feature is marked as BETA and may have bugs.

fix

Stick with single-file mode for stability. If using multi-file, test thoroughly.

affects: all

gotchaWhen using Grunt, you must pass the reporter function via require, not a string.

fix

Use format: require('eslint-detailed-reporter') instead of format: 'eslint-detailed-reporter'.

affects: all

gotchaWith Gulp, you need to call eslint.format with a callback to write the HTML output; just passing the reporter won't generate a file.

fix

Use eslint.format(reporter, function(results) { fs.writeFileSync(...) });

affects: all

Errors

Common errors & fixes

Cannot find module 'eslint-detailed-reporter'

The package was not installed or the require path is incorrect.

fix

Run npm install eslint-detailed-reporter --save-dev and ensure you are using require('eslint-detailed-reporter') (CommonJS) or import from 'eslint-detailed-reporter' (ESM).

TypeError: reporter is not a function

Using default import incorrectly in ESM or supplying a string to format option in Grunt/ESLint config.

fix

For CommonJS: const reporter = require('eslint-detailed-reporter'); For ESM: import reporter from 'eslint-detailed-reporter'. In Grunt, use require('eslint-detailed-reporter') as the format value.

Error: ESLint configuration is invalid: "format" must be a function or a full path to a formatter file.

Using a string for the format option in ESLint configuration object (e.g., in .eslintrc) is not supported; only CLI -f accepts string paths.

fix

In programmatic or config usage, pass the require'd function directly, not a string. For CLI, use -f node_modules/eslint-detailed-reporter/lib/detailed.js.

Upgrade

Version history

0.9.0latest on npm

Audit

Dependencies

lodashrequiredUsed for utility functions in the reporter

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/mportuga/eslint-detailed-reporter ↗

packagehttps://www.npmjs.com/package/eslint-detailed-reporter ↗