Registry / testing / eslint-formatter-markdown

eslint-formatter-markdown

JSON →
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
github ↗package ↗
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.

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

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

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

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

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

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

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 footguns
gotchaESLint version compatibility: tested only with ESLint 2 and 3. May not work correctly with ESLint 4+ due to formatter API changes.
gotchaCLI format path must be absolute or relative to the current directory; using just 'markdown' does not work.
deprecatedPackage last updated in 2017. No active maintenance or support for modern ESLint versions. Suggest migrating to an alternative.
Upgrade
Version history

Breaking-change detection hasn't run for this library yet.

Audit
Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity
9 hits · last 30 days
gptbot
4
ahrefsbot
4
script
1
Resources
githubhttps://github.com/sven-piller/eslint-formatter-markdown ↗
packagehttps://www.npmjs.com/package/eslint-formatter-markdown ↗