Registry / testing / eslint-formatter-markdown

eslint-formatter-markdown

library1.0.4jsnpmunverified

An ESLint formatter that outputs linting results as Markdown, suitable for use with ESLint CLI, grunt-eslint, or programmatic usage. Current stable version is 1.0.4, last updated July 2017. The package has not seen active development since then, and only supports ESLint 2.x and 3.x (with potential issues on newer Node). It depends on lodash. Key differentiators: generates human-readable Markdown reports with summary statistics and sorting, but is largely obsolete due to lack of updates and ESLint's built-in formatter improvements.

testing

npm install eslint-formatter-markdown

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-FORMATTER-M

eslint-formatter-markdown

testingjavascriptv1.0.4

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.

formatter (require)

✓ const formatter = require('eslint-formatter-markdown');

✗ import formatter from 'eslint-formatter-markdown';

The package does not provide a default ES module export; use CommonJS require.

eslint CLI format option

✓ eslint --format node_modules/eslint-formatter-markdown/markdown.js file.js

✗ eslint --format markdown file.js

When using CLI, the format argument must point to the full path of the markdown.js file, not just the package name.

grunt-eslint format option

✓ format: require('eslint-formatter-markdown')

✗ format: 'eslint-formatter-markdown'

In grunt-eslint config, the format property expects the require'd function, not a string.

Shows how to generate Markdown-formatted ESLint output via CLI and programmatically using CommonJS require.

// Install: npm install eslint-formatter-markdown --save-dev // Use with ESLint CLI: eslint --format node_modules/eslint-formatter-markdown/markdown.js src/ // Or programmatically: const eslint = require('eslint'); const formatter = require('eslint-formatter-markdown'); const engine = new eslint.CLIEngine(); const report = engine.executeOnFiles(['src/']); const markdownOutput = formatter(report.results); console.log(markdownOutput);

Debug

Known issues

gotchaESLint version compatibility: tested only with ESLint 2 and 3. May not work correctly with ESLint 4+ due to formatter API changes.

fix

Consider using ESLint's built-in formatters or a more maintained third-party formatter.

affects: >=1.0.0

gotchaCLI format path must be absolute or relative to the current directory; using just 'markdown' does not work.

fix

Use `--format ./node_modules/eslint-formatter-markdown/markdown.js` or similar.

affects: >=1.0.0

deprecatedPackage last updated in 2017. No active maintenance or support for modern ESLint versions. Suggest migrating to an alternative.

fix

Use ESLint's built-in formatter 'stylish' or a more recent formatter like 'eslint-formatter-table'.

affects: All

Errors

Common errors & fixes

Cannot find module 'eslint-formatter-markdown'

The package is not installed or the require path is wrong.

fix

Run `npm install eslint-formatter-markdown --save-dev` and ensure the require path is correct.

Error: Invalid format: markdown

Using a short format name instead of the full path to the formatter file.

fix

Use `--format node_modules/eslint-formatter-markdown/markdown.js`.

TypeError: formatter is not a function

Importing the package with ES module syntax instead of CommonJS require.

fix

Use `const formatter = require('eslint-formatter-markdown');`

Upgrade

Version history

1.0.4latest on npm

Audit

Dependencies

lodashrequiredUsed internally for utility functions like sorting.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/sven-piller/eslint-formatter-markdown ↗

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