Registry / testing / eslint-simple-formatter

eslint-simple-formatter

library1.0.1jsnpmunverified

eslint-simple-formatter (v1.0.1) provides a clean, minimal output for ESLint results. It is a simple formatter that reduces noise by displaying only essential lint information. With no dependencies and minimal configuration, it serves as a lightweight alternative to built-in or more complex formatters. The package appears to be a single-function formatter usable via ESLint's --format flag. No release cadence is documented; it is a small utility. Key differentiators: zero dependencies, trivial setup.

testing

npm install eslint-simple-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ESLINT-SIMPLE-FORM

eslint-simple-formatter

testingjavascriptv1.0.1

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 export (formatter function)

✓ import formatter from 'eslint-simple-formatter'

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

The module exports a single default function. In ESM, use default import. In CJS, use require('eslint-simple-formatter').default.

require in CommonJS

✓ const formatter = require('eslint-simple-formatter').default

✗ const formatter = require('eslint-simple-formatter')

If using CommonJS, you must access .default because the package is likely transpiled ESM.

Use via ESLint config

✓ eslint --format eslint-simple-formatter src/

✗ eslint --format=eslint-simple-formatter src/

The --format flag accepts a module path directly. No import needed when used via CLI.

Shows installation, CLI usage, and programmatic usage of the formatter using ESM.

// Install npm install --save-dev eslint-simple-formatter // Use via ESLint CLI eslint --format eslint-simple-formatter src/ // Or in code (ESM) import formatter from 'eslint-simple-formatter'; import { ESLint } from 'eslint'; const eslint = new ESLint(); const results = await eslint.lintFiles(['src/']); const output = formatter(results); console.log(output);

Debug

Known issues

gotchaThe formatter may not show all details like rule IDs or line numbers if results are empty.

fix

This is by design; it's a 'simple' formatter. Use another formatter if you need full details.

affects: >=1.0.0

gotchaOnly works with ESLint's result format. Not compatible with other linting tools.

fix

Ensure input is the standard ESLint LintResult array.

affects: >=1.0.0

gotchaThe exported default function expects exactly one argument (results array); passing extra arguments may cause silent errors.

fix

Call formatter only with the results array: formatter(results)

affects: >=1.0.0

Errors

Common errors & fixes

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

Package not installed or not in node_modules.

fix

Run 'npm install --save-dev eslint-simple-formatter'

Unexpected token 'export'

The package uses ESM exports but is required via CommonJS without transpilation.

fix

Use dynamic import: import('eslint-simple-formatter') or set 'type': 'module' in package.json.

TypeError: formatter is not a function

In CJS, require returns an object with a default property.

fix

Use const formatter = require('eslint-simple-formatter').default;

Upgrade

Version history

1.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/allanhortle/eslint-simple-formatter ↗

packageeslint-simple-formatter ↗

homepagehttps://github.com/allanhortle/eslint-simple-formatter ↗