{"id":41456,"library":"markdownlint-cli2-formatter-pretty","title":"markdownlint-cli2-formatter-pretty","description":"An output formatter for markdownlint-cli2 that adds color and clickable links to the default formatter output. Version 0.0.10 is current; it requires Node.js >=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0 and markdownlint-cli2 >=0.0.4 as a peer dependency. The formatter enhances readability by applying ANSI color to file paths, line numbers, and error types, and uses the terminal-link package to make rule names clickable in supported terminals. It also supports an optional 'appendLink' mode for terminals that do not support clickable links. This package is part of the markdownlint-cli2 ecosystem and does not introduce new linting rules.","status":"active","version":"0.0.10","language":"javascript","source_language":"en","source_url":"https://github.com/DavidAnson/markdownlint-cli2","tags":["javascript","markdownlint-cli2-formatter"],"install":[{"cmd":"npm install markdownlint-cli2-formatter-pretty","lang":"bash","label":"npm"},{"cmd":"yarn add markdownlint-cli2-formatter-pretty","lang":"bash","label":"yarn"},{"cmd":"pnpm add markdownlint-cli2-formatter-pretty","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency required to use the formatter","package":"markdownlint-cli2","optional":false},{"reason":"runtime dependency for clickable links","package":"terminal-link","optional":false}],"imports":[{"note":"This package is not imported directly; it is referenced by name in markdownlint-cli2 configuration.","wrong":"const formatter = require('markdownlint-cli2-formatter-pretty')","symbol":"markdownlint-cli2-formatter-pretty","correct":"Configure in .markdownlint-cli2.jsonc as an outputFormatter string"},{"note":"The formatter is designed to be used as a string reference in configuration, not as a module import.","wrong":"import pretty from 'markdownlint-cli2-formatter-pretty'","symbol":"default","correct":"No direct import. Use via markdownlint-cli2 configuration file."},{"note":"When appendLink is true, links are shown as informational text after the rule message instead of being clickable inline.","wrong":"No configuration object: { \"outputFormatters\": [\"markdownlint-cli2-formatter-pretty\"] } (missing options)","symbol":"appendLink","correct":"{ \"outputFormatters\": [[\"markdownlint-cli2-formatter-pretty\", { \"appendLink\": true }]] }"}],"quickstart":{"code":"// Install the formatter\nnpm install markdownlint-cli2-formatter-pretty --save-dev\n\n// Create .markdownlint-cli2.jsonc in project root:\n{\n  \"outputFormatters\": [\n    [ \"markdownlint-cli2-formatter-pretty\" ]\n  ]\n}\n\n// Run markdownlint-cli2 (assuming it's installed globally)\nmarkdownlint-cli2 '**/*.md'\n\n// For terminals without clickable link support, use appendLink mode:\n{\n  \"outputFormatters\": [\n    [ \"markdownlint-cli2-formatter-pretty\", { \"appendLink\": true } ]\n  ]\n}","lang":"javascript","description":"Shows installation, configuration with default and appendLink options, and typical CLI usage."},"warnings":[{"fix":"Upgrade Node.js to one of the specified versions.","message":"Requires Node.js version 20.12.0, 21.7.0, 22.13.0, or 23.5.0 or later — older versions will fail to run.","severity":"gotcha","affected_versions":"<20.12.0 || <21.7.0 || <22.13.0 || <23.5.0"},{"fix":"Use correct configuration syntax: [\"markdownlint-cli2-formatter-pretty\"]","message":"The formatter must be listed as a string in the outputFormatters array, not as a path or imported module.","severity":"gotcha","affected_versions":">=0.0.1"},{"fix":"Set appendLink: true in the options object if links are not clickable.","message":"Clickable links may not work in all terminals; use appendLink option for wider compatibility.","severity":"gotcha","affected_versions":">=0.0.1"},{"fix":"Monitor the markdownlint-cli2 repository for updates or newer formatter packages.","message":"The package may be superseded by newer formatters in the markdownlint-cli2 ecosystem. Check for alternatives.","severity":"deprecated","affected_versions":">=0.0.1"}],"env_vars":null,"search_vec":"'0.0.10':25 '0.0.4':39 '20.12.0':34 '21.7.0':33 '22.13.0':32 '23.5.0':31 'add':14 'also':76 'ansi':50 'appendlink':80 'appli':49 'cli2':3,12,38,98,110 'clickabl':17,71,88 'color':15,51 'current':27 'default':21 'depend':43 'ecosystem':99 'enhanc':46 'error':58 'file':53 'formatt':4,8,22,45,111 'introduc':103 'javascript':107 'line':55 'link':18,65,89 'lint':105 'make':68 'markdownlint':2,11,37,97,109 'markdownlint-cli2':10,36,96 'markdownlint-cli2-formatter':108 'markdownlint-cli2-formatter-pretty':1 'mode':81 'name':70 'new':104 'node.js':30 'number':56 'option':79 'output':7,23 'packag':66,91 'part':93 'path':54 'peer':42 'pretti':5 'readabl':47 'requir':29 'rule':69,106 'support':73,77,87 'termin':64,74,83 'terminal-link':63 'type':59 'use':61 'version':24","created_at":"2026-06-04T18:52:30.203264+00:00","updated_at":"2026-06-04T18:52:30.203264+00:00","problems":[{"fix":"Run `npm install markdownlint-cli2-formatter-pretty --save-dev` again and ensure package.json lists it as a devDependency.","cause":"The formatter is not installed or not listed correctly in node_modules.","error":"Error: Cannot find module 'markdownlint-cli2-formatter-pretty'"},{"fix":"Use correct syntax: [\"markdownlint-cli2-formatter-pretty\"] or [[\"markdownlint-cli2-formatter-pretty\", {}]]","cause":"outputFormatters entry is not in array format for options.","error":"TypeError: outputFormatters[0] is not iterable"},{"fix":"Install markdownlint-cli2: `npm install markdownlint-cli2 --save-dev`","cause":"Peer dependency markdownlint-cli2 is missing.","error":"ValidationError: 'markdownlint-cli2' is not installed"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/DavidAnson/markdownlint-cli2","github":"https://github.com/DavidAnson/markdownlint-cli2","docs":null,"changelog":null,"pypi":null,"npm":"markdownlint-cli2-formatter-pretty","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}