Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

markdownlint-cli2-formatter-default

DavidAnson856kMIT0.0.5

An output formatter for markdownlint-cli2 that produces the same output as markdownlint-cli

markdownlint-cli2-formatter

readme

markdownlint-cli2-formatter-default

An output formatter for markdownlint-cli2 that produces the same output as markdownlint-cli

npm version License

Install

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

Use

No action is necessary; this is the default output formatter for markdownlint-cli2.

To reference it directly in .markdownlint-cli2.jsonc:

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

Example

dir/about.md:1:1 MD021/no-multiple-space-closed-atx Multiple spaces inside hashes on closed atx style heading [Context: "#  About  #"]
dir/about.md:4 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. List"]
dir/about.md:5:1 MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 3; Style: 1/2/3]
dir/subdir/info.md:1 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Information"]
dir/subdir/info.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Information"]
dir/subdir/info.md:2:6 MD038/no-space-in-code Spaces inside code span elements [Context: "` code1`"]
dir/subdir/info.md:2:20 MD038/no-space-in-code Spaces inside code span elements [Context: "`code2 `"]
dir/subdir/info.md:4 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
viewme.md:3:10 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
viewme.md:5 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
viewme.md:6 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Description"]
viewme.md:12:1 MD019/no-multiple-space-atx Multiple spaces after hash on atx style heading [Context: "##  Summary"]
viewme.md:14:14 MD047/single-trailing-newline Files should end with a single newline character

changelog

Changelog

0.13.0

  • Add noBanner and gitignore configuration options
  • Reduce install size by switching to js-yaml package
  • Add more detail to some error messages
  • Export JSONC/YAML parsers for reuse
  • Update dependencies (including markdownlint)

0.12.1

  • Update JSONC parsing to handle trailing commas
  • Add documentation links to JSON schema
  • Update dependencies

0.12.0

  • Remove deprecated markdownlint-cli2-config entry point
    • Use markdownlint-cli2 --config ... instead
  • Remove deprecated markdownlint-cli2-fix entry point
    • Use markdownlint-cli2 --fix ... instead
  • Add --help and --no-globs parameters
  • Improve and document included JSON schemas
  • Update dependencies (including markdownlint)

0.11.0

  • Add modulePaths configuration option
  • Update dependencies (including markdownlint)
  • Remove support for end-of-life Node 16

0.10.0

  • Add showFound configuration option
  • Add .markdownlint-cli2.jsonc config schema
  • Update dependencies (including markdownlint)

0.9.2

  • Remove npm-shrinkwrap.json entirely to avoid npm failures

0.9.1

  • Remove devDependencies from npm-shrinkwrap.json to avoid npm failures

0.9.0

  • Add support for Node.js's package.json as a configuration file source
  • Add output formatter for Static Analysis Results Interchange Format/SARIF
  • Bundle npm-shrinkwrap.json for reproducible/faster installs
  • Update dependencies (including markdownlint)

0.8.1

  • Handle --config edge case

0.8.0

  • Add support for --config and --fix parameters
  • Update dependencies (including markdownlint)
  • Remove support for end-of-life Node 14

0.7.1

  • Update dependencies (including markdownlint)

0.7.0

  • Add support for extends in config property of .markdownlint-cli2.* files
  • Build and publish davidanson/markdownlint-cli2-rules Docker container image
  • Update dependencies (including markdownlint)

0.6.0

  • Update dependencies (including markdownlint)

0.5.1

  • Update dependencies

0.5.0

  • New rules
  • Support modules (MJS) everywhere
  • Include dotfiles

0.4.0

  • New rules
  • Async custom rules
  • Explicit config
  • CJS (breaking)

0.3.2

  • Extensibility/Windows/consistency improvements

0.3.1

  • Extensibility tweaks

0.3.0

  • Add Docker container
  • Update dependencies

0.2.0

  • Improve handling of Windows paths using backslash

0.1.3

  • Support rule collections

0.1.2

  • Update use of require to be more flexible

0.1.1

  • Restore previous use of require

0.1.0

  • Simplify use of require
  • Increment minor version

0.0.15

  • Improve extensibility

0.0.14

  • Update dependencies (including markdownlint)

0.0.13

  • Add markdownlint-cli2-fix command

0.0.12

  • Update dependencies (including markdownlint)

0.0.11

  • Improve performance of fix
  • Update banner

0.0.10

  • Improve performance and configuration

0.0.9

  • Improve configuration file handling

0.0.8

  • Support .markdownlint-cli2.yaml
  • Add progress

0.0.7

  • Support .markdownlint-cli2.js and .markdownlint.js

0.0.6

  • Improve handling of very large directory trees

0.0.5

  • Improve support for ignoring files

0.0.4

  • Support output formatters and markdown-it plugins

0.0.3

  • Feature parity with markdownlint-cli

0.0.2

  • Initial release