{"id":19646,"library":"eslint-formatter-markdown","title":"ESLint Formatter Markdown","description":"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.","status":"maintenance","version":"1.0.4","language":"javascript","source_language":"en","source_url":"https://github.com/sven-piller/eslint-formatter-markdown","tags":["javascript","eslint","formatter","reporter","lint","validate"],"install":[{"cmd":"npm install eslint-formatter-markdown","lang":"bash","label":"npm"},{"cmd":"yarn add eslint-formatter-markdown","lang":"bash","label":"yarn"},{"cmd":"pnpm add eslint-formatter-markdown","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Used internally for utility functions like sorting.","package":"lodash","optional":false}],"imports":[{"note":"The package does not provide a default ES module export; use CommonJS require.","wrong":"import formatter from 'eslint-formatter-markdown';","symbol":"formatter (require)","correct":"const formatter = require('eslint-formatter-markdown');"},{"note":"When using CLI, the format argument must point to the full path of the markdown.js file, not just the package name.","wrong":"eslint --format markdown file.js","symbol":"eslint CLI format option","correct":"eslint --format node_modules/eslint-formatter-markdown/markdown.js file.js"},{"note":"In grunt-eslint config, the format property expects the require'd function, not a string.","wrong":"format: 'eslint-formatter-markdown'","symbol":"grunt-eslint format option","correct":"format: require('eslint-formatter-markdown')"}],"quickstart":{"code":"// Install: npm install eslint-formatter-markdown --save-dev\n// Use with ESLint CLI:\neslint --format node_modules/eslint-formatter-markdown/markdown.js src/\n\n// Or programmatically:\nconst eslint = require('eslint');\nconst formatter = require('eslint-formatter-markdown');\n\nconst engine = new eslint.CLIEngine();\nconst report = engine.executeOnFiles(['src/']);\nconst markdownOutput = formatter(report.results);\nconsole.log(markdownOutput);","lang":"javascript","description":"Shows how to generate Markdown-formatted ESLint output via CLI and programmatically using CommonJS require."},"warnings":[{"fix":"Consider using ESLint's built-in formatters or a more maintained third-party formatter.","message":"ESLint version compatibility: tested only with ESLint 2 and 3. May not work correctly with ESLint 4+ due to formatter API changes.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use `--format ./node_modules/eslint-formatter-markdown/markdown.js` or similar.","message":"CLI format path must be absolute or relative to the current directory; using just 'markdown' does not work.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use ESLint's built-in formatter 'stylish' or a more recent formatter like 'eslint-formatter-table'.","message":"Package last updated in 2017. No active maintenance or support for modern ESLint versions. Suggest migrating to an alternative.","severity":"deprecated","affected_versions":"All"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Run `npm install eslint-formatter-markdown --save-dev` and ensure the require path is correct.","cause":"The package is not installed or the require path is wrong.","error":"Cannot find module 'eslint-formatter-markdown'"},{"fix":"Use `--format node_modules/eslint-formatter-markdown/markdown.js`.","cause":"Using a short format name instead of the full path to the formatter file.","error":"Error: Invalid format: markdown"},{"fix":"Use `const formatter = require('eslint-formatter-markdown');`","cause":"Importing the package with ES module syntax instead of CommonJS require.","error":"TypeError: formatter is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}