eslint-summary

1.0.0 verified Sat Apr 25 auth: no javascript

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.

Common errors

error Error: Cannot find module 'eslint-summary' ↓

cause 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

error TypeError: formatter is not a function ↓

cause 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.

Warnings

gotcha The 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.

gotcha The 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.

Install

npm install eslint-summary

yarn add eslint-summary

pnpm add eslint-summary

Imports

default
wrong
```
const summary = require('eslint-summary')
```
correct
```
import summary from '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
wrong
```
require('eslint-summary').default
```
correct
```
require('eslint-summary')
```
In CommonJS, the default export is the entire module.exports object; no .default needed.
default
wrong
```
eslint --format eslint-summary *.js
```
correct
```
eslint --format node_modules/eslint-summary/summary.js *.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.

Quickstart

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 .