@codacy/tools-markdownlint-0

Table of Contents

• Overview
• Updating patterns
• Updating the markdownlint version
• Development
• Notes for maintainers

Overview

Markdown linter using the markdownlint Node.js library. Uses the Library execution strategy — calls the markdownlint API directly rather than spawning a subprocess.

| Property | Value | |----------|-------| | Tool ID | markdownlint | | Codacy UUID | 547ff16b-d57c-4d75-8067-5ccf3ea88a00 | | Strategy | Library | | Languages | Markdown | | Dependency | markdownlint npm package (v0.x) | | File patterns | **/*.md |

Updating patterns

# Re-fetch pattern metadata from the Codacy API
pnpm prefetch

# Commit the result
git add src/patterns.json

Pattern IDs follow the format markdownlint_MD001, markdownlint_MD013, etc.

Updating the markdownlint version

1. Update the markdownlint version in package.json
2. Run pnpm install
3. Run pnpm prefetch to check for new/removed rules
4. Run pnpm test to verify compatibility
5. If the major version changes, create a new adapter package (markdownlint-1/)

Development

pnpm build    # Build with tsup
pnpm test     # Run tests

Notes for maintainers

• markdownlint v0.37+ is pure ESM. The adapter uses dynamic import() at runtime to stay CJS-compatible with the tsup build.
• checkAvailability dynamically imports markdownlint and checks its version.
• install is a no-op — the npm dependency handles installation.