Registry / testing / eslint-formatter-summary

eslint-formatter-summary

library2.0.2jsnpmunverified

ESLint formatter that aggregates linting results by rule, showing total errors and warnings per rule instead of per-file output. Current stable version is 2.0.2 (April 2025), with regular releases. Key differentiator: helps introduce ESLint to large codebases by summarizing rule failures, making it easier to suppress or prioritize fixes. Supports sorting by rule name, error count, or warning count via environment variables. Written in TypeScript, requires Node.js >=20.

testing devops

npm install eslint-formatter-summary

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-FORMATTER-S

eslint-formatter-summary

testingjavascriptv2.0.2

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.

summary formatter

✓ eslint -f summary ./src

✗ eslint -f eslint-formatter-summary ./src

Use the shorthand name 'summary' when specifying the formatter, not the full package name.

SORT_BY environment variable

✓ SORT_BY=rule eslint -f summary ./src

✗ eslint -f summary --sort-by rule ./src

Configuration is via environment variables only, not CLI flags.

DESC environment variable

✓ SORT_BY=errors DESC=true eslint -f summary ./src

✗ eslint -f summary --desc ./src

Use DESC=true to reverse sort order. Must be used with SORT_BY.

Installs the package and runs ESLint with the summary formatter, demonstrating basic usage and sorting via environment variables.

npm install -D eslint-formatter-summary # Create a test file with lint errors echo 'const x = 1;' > test.js # Run ESLint with the summary formatter (ensure ESLint is installed) eslint -f summary test.js # Output shows aggregated errors/warnings per rule # To sort by rule (ascending): SORT_BY=rule eslint -f summary test.js # To sort by errors descending: SORT_BY=errors DESC=true eslint -f summary test.js

Debug

Known issues

breakingv2.0.0 drops support for Node.js versions below 20. Requires Node.js >=20.

fix

Upgrade Node.js to v20 or later.

affects: >=2.0.0

breakingv2.0.0 rewrites the formatter in TypeScript and updates dependencies. Output format may have slight changes.

fix

Review output format for any changes in aggregation behavior.

affects: >=2.0.0

deprecatedv1.x configuration via environment variables SORT_BY and DESC remain supported but may be removed in future.

fix

Migrate to v2 and continue using env vars; no breaking change in usage.

affects: <2.0.0

gotchaThe formatter expects ESLint to be installed as a peer dependency. It may not work if ESLint is missing.

fix

Ensure ESLint is installed in the project (npm i -D eslint).

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'eslint-formatter-summary'

Package not installed or ESLint cannot locate the formatter.

fix

Run 'npm install -D eslint-formatter-summary' and ensure node_modules is present.

Invalid formatter 'summary'

Using a formatter name that ESLint does not recognize.

fix

Use '-f summary' (the shorthand) after installing eslint-formatter-summary.

Error: Requires node >=20

Node.js version is below 20 when using v2.

fix

Upgrade Node.js to v20 or later, or use v1 (npm install eslint-formatter-summary@1).

Upgrade

Version history

2.0.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/mhipszki/eslint-formatter-summary ↗

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