@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.

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 devDependencies of package.json, and preferredVersion in src/metadata.ts
2. Run pnpm install
3. Run pnpm generate-payloads markdownlint-0 from the repo root to re-pin payload/package.json and regenerate its lockfile
4. Run pnpm prefetch to check for new/removed rules
5. Run pnpm test to verify compatibility
6. 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.
• The tool is an npm payload, not a dependency: it is resolved at run time (a Codacy-managed install under ~/.codacy/tools/<id>/, a CODACY_TOOL_ROOT_<ID> root, or this package's own node_modules in the monorepo) and install runs npm ci against the committed payload/package-lock.json. See src/payload.ts.