markdownlint-cli2-formatter-pretty v0.0.7

markdownlint-cli2-formatter-pretty

An output formatter for markdownlint-cli2 that looks like markdownlint-cli2-formatter-default with color and clickable links.

Install

npm install markdownlint-cli2-formatter-pretty --save-dev

Use

To enable this formatter, use the following .markdownlint-cli2.jsonc:

{
  "outputFormatters": [
    [ "markdownlint-cli2-formatter-pretty" ]
  ]
}

Many terminals support color (implemented by chalk), but support for clickable links (implemented by terminal-link) is not as widespread. Where possible, rule names in output are rendered as clickable links with information about the rule.

To append informational links to the output instead (which may be clickable):

{
  "outputFormatters": [
    [ "markdownlint-cli2-formatter-pretty", { "appendLink": true } ]
  ]
}

Example