Registry / testing / eslint-friendly-formatter

eslint-friendly-formatter

library4.0.1jsnpmunverified

An ESLint formatter that produces output compatible with Sublime Text and iTerm2 'click to open file' functionality. Version 4.0.1 is the current stable release, with irregular updates. Key differentiators: file/line/column links that open in editors, clickable rule IDs linking to documentation, errors reported at end, and a summary with contextual code snippets. It is based on the default 'stylish' formatter but enhanced for terminal usability.

testing

npm install eslint-friendly-formatter

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-FRIENDLY-FO

eslint-friendly-formatter

testingjavascriptv4.0.1

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 formatter from 'eslint-friendly-formatter'

✗ const formatter = require('eslint-friendly-formatter').default

ESM default export equivalent to module.exports. Use default import.

formatter (CJS)

✓ const formatter = require('eslint-friendly-formatter')

✗ const { formatter } = require('eslint-friendly-formatter')

CommonJS: module.exports = function, so require() returns the function directly.

formatter (TypeScript)

✓ import formatter from 'eslint-friendly-formatter'

✗ import * as formatter from 'eslint-friendly-formatter'

TypeScript: default import works for both ESM and CJS with esModuleInterop.

Demonstrates using eslint-friendly-formatter to format ESLint results for console output with clickable file links.

const formatter = require('eslint-friendly-formatter'); const results = [ { filePath: 'src/index.js', messages: [ { ruleId: 'no-unused-vars', severity: 2, message: 'foo is defined but never used', line: 5, column: 10, nodeType: 'Identifier', }, ], errorCount: 1, warningCount: 0, fixableErrorCount: 0, fixableWarningCount: 0, source: 'const foo = 1;', }, ]; const output = formatter(results); console.log(output);

eslint --version

Debug

Known issues

breakingv4.0.0 changed from CommonJS to hybrid ESM/CJS, breaking direct require() without .default in some bundlers.

fix

Use default import: import formatter from 'eslint-friendly-formatter' or use require('eslint-friendly-formatter').default if needed.

affects: >=4.0.0

deprecatedv3.x and earlier are deprecated; upgrading to v4+ may break existing CJS code.

fix

Update to v4.0.0 or later and adjust imports as needed.

affects: <4.0.0

gotchaClickable file links only work in terminals that support URIs like iTerm2 or Sublime Text; not all terminals.

fix

Test in your target terminal; configure editor to handle 'file://' URIs.

affects: all

gotchaFormatter does not handle eslint --fix output; only displays messages.

fix

Use ESLint's --fix separately; this formatter only displays results.

affects: all

Errors

Common errors & fixes

Cannot find module 'eslint-friendly-formatter'

Module not installed or path incorrect when using --format in CLI.

fix

npm install --save-dev eslint-friendly-formatter; use --format ./node_modules/eslint-friendly-formatter/index.js

formatter is not a function

Wrong import style in ESM/CJS interop (e.g., require().default not used).

fix

Use const formatter = require('eslint-friendly-formatter').default if needed; for CJS use require('eslint-friendly-formatter') directly.

Upgrade

Version history

4.0.1latest on npm

Audit

Dependencies

eslintoptionalPeer dependency - used as a formatter for ESLint

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/royriojas/eslint-friendly-formatter ↗

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