@codacy/tools-lizard-1

Table of Contents

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

Overview

Code complexity analyzer using the Lizard Python tool. Uses the CLI execution strategy -- spawns lizard via spawnTool() and parses its plain-text output.

Unlike standard linters that emit rule violations, Lizard reports raw metrics (NLOC, CCN, parameter count). The adapter transforms these metrics into issues by applying configurable thresholds at three severity tiers (minor, medium, critical).

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 Lizard_ccn-medium, Lizard_nloc-critical, Lizard_file-nloc-minor, etc.

Updating the Lizard version

1. Update preferredVersion in src/adapter.ts
2. Update the PIP_PACKAGE constant to match
3. Run pnpm prefetch to check for any pattern changes
4. Run pnpm test to verify compatibility
5. If the major version changes, create a new adapter package (lizard-2/)

Development

pnpm build    # Build with tsup
pnpm test     # Run tests (some require lizard in PATH)

Installing lizard locally:

pip install lizard==1.24.0

Or let the adapter install it automatically via --install-dependencies.

Notes for maintainers

• Lizard outputs plain text (not JSON/XML). The adapter parses two sections: methods and files.
• The -V flag enables verbose function names; -f reads a file list from a temporary file.
• No threshold flags are passed to lizard -- the adapter applies its own thresholds from Codacy pattern parameters.
• Each pattern has a single threshold parameter. If not provided, defaults are used.
• Thresholds are checked in descending severity order (critical -> medium -> minor). Only the highest severity match is emitted per metric group per function/file.
• A single function can produce up to 3 issues (one per metric: NLOC, CCN, parameter count).
• File-level NLOC issues are reported at line 1.
• Lizard has no configuration file format -- checkLocalConfigurationFile always returns { found: false }.
• The adapter uses Python venv utilities from @codacy/tooling (findPython, ensureVenv, pipInstall) for installation.
• The lineContent field is empty for Lizard issues because the issue refers to a whole function, not a specific line of code.