{"id":20003,"library":"eslint-summary","title":"eslint-summary","description":"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.","status":"active","version":"1.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/davidwaterston/eslint-summary","tags":["javascript","eslint","formatter","reporter","lint","validate"],"install":[{"cmd":"npm install eslint-summary","lang":"bash","label":"npm"},{"cmd":"yarn add eslint-summary","lang":"bash","label":"yarn"},{"cmd":"pnpm add eslint-summary","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"required peer dependency; the formatter is consumed by ESLint","package":"eslint","optional":false}],"imports":[{"note":"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.","wrong":"const summary = require('eslint-summary')","symbol":"default","correct":"import summary from 'eslint-summary'"},{"note":"In CommonJS, the default export is the entire module.exports object; no .default needed.","wrong":"require('eslint-summary').default","symbol":"default","correct":"require('eslint-summary')"},{"note":"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.","wrong":"eslint --format eslint-summary *.js","symbol":"default","correct":"eslint --format node_modules/eslint-summary/summary.js *.js"}],"quickstart":{"code":"npm install --save-dev eslint eslint-summary\n# Create a minimal ESLint config file if not present\necho '{}' > .eslintrc.json\n# Lint with summary format\nnpx eslint --format node_modules/eslint-summary/summary.js .","lang":"javascript","description":"Installs the formatter and runs ESLint with summary output on all files in the current directory."},"warnings":[{"fix":"Use built-in ESLint formatters like 'compact' or switch to a maintained alternative.","message":"The package may not work with ESLint >= 7.0.0 due to formatter API changes.","severity":"gotcha","affected_versions":">=7.0.0"},{"fix":"Use a different formatter like 'eslint-friendly-formatter' or 'eslint-formatter-pretty' for detailed output.","message":"The formatter only displays one summary line; it does not report individual file errors. This may hide details needed for debugging.","severity":"gotcha","affected_versions":">=0.0.0"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Ensure the package is installed in node_modules and specify the full path: --format node_modules/eslint-summary/summary.js","cause":"ESLint cannot resolve the formatter when using just the package name without a path.","error":"Error: Cannot find module 'eslint-summary'"},{"fix":"Upgrade to a maintained formatter or use ESLint's built-in compact formatter.","cause":"The formatter may not be compatible with the ESLint version's API (especially ESLint 7+).","error":"TypeError: formatter is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}