Registry / devops / markdownlint-cli2-formatter-default

markdownlint-cli2-formatter-default

library0.0.6jsnpmunverified

Default output formatter for markdownlint-cli2, producing the same text output as markdownlint-cli. Version 0.0.6, stable. No configuration needed; it is automatically used when no other formatter is specified. Lightweight, zero dependencies aside from peer requirement.

devops

npm install markdownlint-cli2-formatter-default

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MARKDOWNLINT-CLI2-

markdownlint-cli2-formatter-default

devopsjavascriptv0.0.6

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 formatter

✓ No import needed; used automatically by markdownlint-cli2

✗ require('markdownlint-cli2-formatter-default')

This package is a plugin, not a direct import. It is loaded by markdownlint-cli2 via its config.

config reference in .markdownlint-cli2.jsonc

✓ "outputFormatters": [[ "markdownlint-cli2-formatter-default" ]]

✗ "outputFormatters": [ "markdownlint-cli2-formatter-default" ]

Must be an array inside an array when specifying as a string. Correct: [["pkg"]] not ["pkg"].

Installs the formatter and runs markdownlint-cli2 on all Markdown files to see the default text output.

// Install the formatter and run markdownlint-cli2 npm install --save-dev markdownlint-cli2 markdownlint-cli2-formatter-default npx markdownlint-cli2 "**/*.md"

Debug

Known issues

gotchaThe formatter is automatically used as default; specifying it explicitly in config requires nested array syntax.

fix

Use [[ "markdownlint-cli2-formatter-default" ]] instead of [ "markdownlint-cli2-formatter-default" ]

affects: >=0.0.1

gotchaThis formatter only works with markdownlint-cli2 >=0.0.4 (peer dependency).

fix

Ensure markdownlint-cli2 is at version 0.0.4 or higher.

affects: >=0.0.1

Errors

Common errors & fixes

Can't find 'markdownlint-cli2-formatter-default' when running markdownlint-cli2

Formatters must be installed in the same project or a parent directory; not automatically resolved globally.

fix

Run npm install --save-dev markdownlint-cli2-formatter-default in your project root.

Missing peer dependency: markdownlint-cli2

markdownlint-cli2 is not installed or version too low.

fix

npm install --save-dev markdownlint-cli2@>=0.0.4

Upgrade

Version history

0.0.6latest on npm

Audit

Dependencies

markdownlint-cli2requiredPeer dependency; the formatter only works with markdownlint-cli2

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/DavidAnson/markdownlint-cli2 ↗

packagemarkdownlint-cli2-formatter-default ↗

homepagehttps://github.com/DavidAnson/markdownlint-cli2 ↗