Registry / testing / eslint-formatter-overview

eslint-formatter-overview

JSON →
library2.0.0jsnpmunverified

An ESLint formatter that displays a tree overview of files with errors and warnings, showing rule names and line:column positions. Current stable version is 2.0.0. Release cadence is low, with sparse updates. Differentiators: simple, visually clean tree output; supports an environment variable to show all files (even without errors). Alternative to built-in formatters like 'stylish' or 'compact'.

testing
npm install eslint-formatter-overview
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · ESLINT-FORMATTER-O
E
eslint-formatter-overview
testingjavascriptv2.0.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

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

default
✓ module.exports = require('eslint-overview-formatter')
✗ import overview from 'eslint-overview-formatter'
The package is a CommonJS module, not ESM. Use require() to load the formatter.

Shows how to run ESLint with the overview formatter via CLI and programmatic Node.js usage.

// Basic usage: run ESLint with this formatter from the command line // npm install --save-dev eslint eslint-overview-formatter // eslint --format ./node_modules/eslint-overview-formatter src/ // Programmatic usage (Node.js, CommonJS): const { ESLint } = require('eslint'); (async () => { const eslint = new ESLint({ fix: false }); const results = await eslint.lintFiles(['src/']); const formatter = require('eslint-overview-formatter'); console.log(formatter(results)); })().catch(console.error);
Debug
Known issues
gotchaFormatter must be required as a CommonJS module; using ES6 import will fail.
fix
Use require('eslint-overview-formatter') instead of import.
affects: >=1.0.0
gotchaEnvironment variable OVERVIEW_FORMATTER_SHOW_ALL must be set to 'true' (string) to show all files.
fix
Run with OVERVIEW_FORMATTER_SHOW_ALL=true before the eslint command.
affects: >=1.0.0
deprecatedNo new releases since 2018; may not work with ESLint 8+ due to formatter API changes.
fix
Consider using eslint-formatter-pretty or custom formatter.
affects: >=2.0.0
Errors
Common errors & fixes
Error: Could not find formatter 'eslint-overview-formatter'
Running eslint --format eslint-overview-formatter without a full path to the module.
fix
Use --format ./node_modules/eslint-overview-formatter or register it in .eslintrc.
TypeError: formatter is not a function
Using ES6 import (import formatter from ...) instead of require.
fix
Replace with const formatter = require('eslint-overview-formatter');
SyntaxError: Unexpected token 'export'
Trying to require an ES module without proper configuration.
fix
Use require() in a CommonJS context or convert project to ESM.
Upgrade
Version history
2.0.0latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
6 hits · last 30 days
node
6
Resources
githubhttps://github.com/ViggoV/eslint-overview-formatter ↗
packageeslint-formatter-overview ↗
homepagehttps://github.com/ViggoV/eslint-overview-formatter#readme ↗
eslint-formatter-overview — npm install eslint-formatter-overview · libregistry