markdownlint-cli2-formatter-codequality

An output formatter for markdownlint-cli2 that writes results to a GitLab Code Quality report artifact JSON file (a subset of the CodeClimate specification)

Install

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

Use

For the default output file name of "markdownlint-cli2-codequality.json", use the following .markdownlint-cli2.jsonc:

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

To customize the output file name, use the following .markdownlint-cli2.jsonc:

{
  "outputFormatters": [
    [ "markdownlint-cli2-formatter-codequality", { "name": "custom-name.json" } ]
  ]
}

Use in GitLab CI

markdownlint:
  stage: lint
  image:
    name: davidanson/markdownlint-cli2:<version>
    entrypoint: [""]
  script:
    - markdownlint-cli2 "**/*.md"
  artifacts:
    when: always
    expire_in: 1 week
    reports:
      codequality: markdownlint-cli2-codequality.json

Example Output

[
  {
    "type": "issue",
    "check_name": "MD009/no-trailing-spaces",
    "description": "MD009/no-trailing-spaces: Trailing spaces [Expected: 0 or 2; Actual: 1]",
    "severity": "minor",
    "fingerprint": "f34a01e4a119d7df262993933665d4c97cc601702eeca2814ccad9606a3ccb48",
    "location": {
      "path": "viewme.md",
      "lines": {
        "begin": 3
      }
    }
  },
  {
    "type": "issue",
    "check_name": "MD012/no-multiple-blanks",
    "description": "MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]",
    "severity": "minor",
    "fingerprint": "a3d9b647ce8d929904e64fbbb0a47223617e8985d0a4d31e674b22f919f736fb",
    "location": {
      "path": "viewme.md",
      "lines": {
        "begin": 5
      }
    }
  },
  {
    "type": "issue",
    "check_name": "MD025/single-title/single-h1",
    "description": "MD025/single-title/single-h1: Multiple top-level headings in the same document",
    "severity": "minor",
    "fingerprint": "ef26889ac26be010b8bb6d2bd8c846c70bccf90506c0adffb763bef774f93f80",
    "location": {
      "path": "viewme.md",
      "lines": {
        "begin": 6
      }
    }
  },
  {
    "type": "issue",
    "check_name": "MD019/no-multiple-space-atx",
    "description": "MD019/no-multiple-space-atx: Multiple spaces after hash on atx style heading",
    "severity": "minor",
    "fingerprint": "244fe04169875709c7854fc0ddef5c2639aa57bad8a9319e3a9ed6a5f8504c89",
    "location": {
      "path": "viewme.md",
      "lines": {
        "begin": 12
      }
    }
  },
  {
    "type": "issue",
    "check_name": "MD047/single-trailing-newline",
    "description": "MD047/single-trailing-newline: Files should end with a single newline character",
    "severity": "minor",
    "fingerprint": "bf74eade0ee3301ccaa826907651e0d6925b60d517e1110c29b081c7b6ce1acf",
    "location": {
      "path": "viewme.md",
      "lines": {
        "begin": 14
      }
    }
  }
]

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