eslint-summary

library1.0.0jsnpmunverified

A minimal ESLint custom formatter (reporter) that displays a single summary line for all files processed. Version 1.0.0 (stable) — no known regular release cadence; appears to be a single release. Unlike verbose formatters, it shows only the count of files processed, files passed, and total warnings/errors, making it suitable for quick status checks in CI or Git hooks. It requires ESLint 0.18.0+ and has no additional dependencies.

testing

npm install eslint-summary

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-SUMMARY

eslint-summary

testingjavascriptv1.0.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.

default

✓ import summary from 'eslint-summary'

✗ const summary = require('eslint-summary')

This package is ESM-only in v1.0.0? Actually the README suggests require() usage for grunt-eslint, but for consistency with modern ESLint configs, use ESM import if using ESLint's --format flag with a custom config.

default

✓ require('eslint-summary')

✗ require('eslint-summary').default

In CommonJS, the default export is the entire module.exports object; no .default needed.

default

✓ eslint --format node_modules/eslint-summary/summary.js *.js

✗ eslint --format eslint-summary *.js

The CLI expects a path to the formatter file or a module name resolved via require.resolve; using just the package name may not work if ESLint cannot resolve it.

Installs the formatter and runs ESLint with summary output on all files in the current directory.

npm install --save-dev eslint eslint-summary # Create a minimal ESLint config file if not present echo '{}' > .eslintrc.json # Lint with summary format npx eslint --format node_modules/eslint-summary/summary.js .

Debug

Known issues

gotchaThe package may not work with ESLint >= 7.0.0 due to formatter API changes.

fix

Use built-in ESLint formatters like 'compact' or switch to a maintained alternative.

affects: >=7.0.0

gotchaThe formatter only displays one summary line; it does not report individual file errors. This may hide details needed for debugging.

fix

Use a different formatter like 'eslint-friendly-formatter' or 'eslint-formatter-pretty' for detailed output.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'eslint-summary'

ESLint cannot resolve the formatter when using just the package name without a path.

fix

Ensure the package is installed in node_modules and specify the full path: --format node_modules/eslint-summary/summary.js

TypeError: formatter is not a function

The formatter may not be compatible with the ESLint version's API (especially ESLint 7+).

fix

Upgrade to a maintained formatter or use ESLint's built-in compact formatter.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

eslintrequiredrequired peer dependency; the formatter is consumed by ESLint

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/davidwaterston/eslint-summary ↗

packagehttps://www.npmjs.com/package/eslint-summary ↗