Registry / devops / markdownlint-cli2-formatter-codequality

markdownlint-cli2-formatter-codequality

library0.0.7jsnpmunverified

An output formatter for markdownlint-cli2 (v0.0.7, latest stable) that writes linting results to a GitLab Code Quality report artifact JSON file, following a subset of the CodeClimate specification. It integrates seamlessly with GitLab CI/CD pipelines via the codequality report artifact and supports configurable severity levels for errors and warnings (e.g., critical, blocker, minor). Updated periodically; requires markdownlint-cli2 >=0.0.4.

devops testing

npm install markdownlint-cli2-formatter-codequality

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MARKDOWNLINT-CLI2-

markdownlint-cli2-formatter-codequality

devopsjavascriptv0.0.7

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.

formatter

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

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

The formatter must be specified as an array with the package name and optional options object, e.g., ["markdownlint-cli2-formatter-codequality", { "name": "custom.json" }].

Configure markdownlint-cli2 to output GitLab Code Quality JSON.

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

Debug

Known issues

gotchaThe formatter does not produce the standard markdownlint output; it only writes a JSON file for GitLab.

fix

Use this formatter only when you need GitLab Code Quality artifacts. For human-readable output, use markdownlint-cli2-formatter-default.

affects: all

deprecatedNo active deprecations in this version, but the formatter relies on markdownlint-cli2's output formatter interface which may change.

fix

Keep markdownlint-cli2 updated and check the changelog for breaking changes.

affects: >=0.0.1

breakingThe default output file name changed from 'markdownlint-cli2-codequality.json' to 'markdownlint-cli2-codequality.json' (no change in v0.0.7, but verify against your markdownlint-cli2 version).

fix

Explicitly specify the output file name using the 'name' option to avoid surprises.

affects: <=0.0.5

Errors

Common errors & fixes

Error: [markdownlint-cli2-formatter-codequality] Could not find module 'markdownlint-cli2-formatter-codequality'

The formatter is not installed or markdownlint-cli2 cannot resolve it.

fix

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

SyntaxError: Unexpected token ']' ... in JSON at position ...

Incorrect configuration in .markdownlint-cli2.jsonc; missing array brackets.

fix

Use: "outputFormatters": [["markdownlint-cli2-formatter-codequality"]]

TypeError: Cannot read properties of undefined (reading 'push')

markdownlint-cli2 version is too old to support output formatters.

fix

Upgrade markdownlint-cli2 to >=0.0.4.

Warning: No output formatters configured for markdownlint-cli2

Configuration file missing or invalid; formatter not loaded.

fix

Ensure .markdownlint-cli2.jsonc contains the correct outputFormatters array.

Upgrade

Version history

0.0.7latest on npm

Audit

Dependencies

markdownlint-cli2requiredPeer dependency; the formatter only works as a plugin for markdownlint-cli2.

Agent activity

2 hits · last 30 days

node

Resources

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

packagemarkdownlint-cli2-formatter-codequality ↗

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