@codacy/tools-reek-6

Table of Contents

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

Overview

Ruby code smell detector using the Reek gem. Uses the CLI execution strategy -- spawns reek --format json via spawnTool() and parses its JSON output.

Updating patterns

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

# Commit the result
git add src/patterns.json

The prefetch script calls packages/tools/scripts/fetch-patterns.mjs with the tool UUID to download pattern metadata (IDs, categories, severity levels) from the Codacy API.

Pattern IDs are bare smell type names (no prefix): FeatureEnvy, TooManyStatements, UncommunicativeMethodName, etc.

Updating the Reek version

1. Update REEK_VERSION in src/adapter.ts
2. Run pnpm prefetch to check for new/removed smells
3. Run pnpm test to verify compatibility
4. If the major version changes, create a new adapter package (reek-7/)

Development

pnpm build    # Build with tsup
pnpm test     # Run tests (requires ruby + reek in PATH for integration tests)

To install reek locally for testing:

gem install reek -v 6.5.0

Notes for maintainers

• Reek requires Ruby >= 2.7 as a runtime. The adapter uses ensureRuby() to download a portable Ruby if no system Ruby is found.
• Gems are installed in an isolated directory at ~/.codacy/runtimes/reek-6/gems/ via GEM_HOME/GEM_PATH environment variables.
• Output format is a flat JSON array of smell objects, each with smell_type, source, lines[], message, and context.
• The lines field is an array -- a single smell can span multiple lines. The adapter uses lines[0] as the primary line number.
• Exit codes: 0 = no smells, 2 = smells found (both success), 1 = runtime error.
• Pattern IDs in patterns.json have no prefix -- they are bare smell type names matching smell_type from Reek's JSON output.
• Pattern filtering is post-hoc: Reek runs against all provided files, then output is filtered by the enabled patterns set.
• Config file detection supports .reek.yml and config.reek. When a local config is found and useLocalConfigurationFile is true, it is passed via --config <path>.