Registry / testing / markdownlint-cli2-formatter-sarif

markdownlint-cli2-formatter-sarif

JSON →
library0.0.4jsnpmunverified

An output formatter for markdownlint-cli2 that writes linting results to a SARIF (Static Analysis Results Interchange Format) file. Current version is 0.0.4. It is a stable, low-churn package that receives updates mainly when markdownlint-cli2 changes its API. Differentiator: provides standardized SARIF output for integration with tools like GitHub Advanced Security or other SARIF-compatible platforms. It is extracted from the main markdownlint-cli2 project and published as a separate npm package.

npm install markdownlint-cli2-formatter-sarif
INSTALL
IMPORT
SIG · MARKDOWNLINT-CLI2-
M
markdownlint-cli2-formatter-sarif
testingjavascriptv0.0.4
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
Define in .markdownlint-cli2.jsonc as [ "markdownlint-cli2-formatter-sarif" ]
This is a formatter plugin for markdownlint-cli2, not imported directly in code. Configure via config file.

Configure markdownlint-cli2 to use the SARIF formatter. Run markdownlint-cli2 to generate a SARIF file.

// .markdownlint-cli2.jsonc { "outputFormatters": [ [ "markdownlint-cli2-formatter-sarif", { "name": "output.sarif" } ] ] }
Debug
Known issues
deprecatedThe output file name defaults to 'markdownlint-cli2-sarif.sarif' which may conflict if multiple projects share a directory.
fix
Always specify a custom name using the 'name' option to avoid collisions.
affects: <=0.0.4
gotchaRequires markdownlint-cli2 version >=0.0.4; older versions will not load the formatter.
fix
Ensure markdownlint-cli2 is at least 0.0.4.
affects: >=0.0.0
Errors
Common errors & fixes
Error: Cannot find module 'markdownlint-cli2-formatter-sarif'
Package not installed or not in node_modules.
fix
npm install --save-dev markdownlint-cli2-formatter-sarif
Upgrade
Version history
0.0.4latest on npm
Audit
Dependencies
markdownlint-cli2requiredPeer dependency; the formatter is loaded by markdownlint-cli2
Agent activity
2 hits · last 30 days
node
2
Resources
markdownlint-cli2-formatter-sarif — npm install markdownlint-cli2-formatter-sarif · libregistry