fix-linter-warnings

Fix Linter Warnings

Overview

When fixing linter issues, use a systematic batch approach that prioritizes code quality over linter satisfaction.

Core principle: Fix 25 issues per iteration. Never make code worse to satisfy the linter - use suppression directives (nolint, eslint-disable, etc.) with clear justifications when appropriate.

When to Use

Use this pattern when:

• Cleaning up existing codebase with many linter warnings
• Working through a backlog of linter issues
• Need to make incremental progress on linter compliance
• Want to maintain code quality while addressing linter feedback
• Each commit should represent a logical unit of work

Don't use when:

• Only a few isolated linter issues (fix directly)
• Linter is reporting genuine bugs (fix immediately, don't batch)
• Working on new code (fix as you write)

The Pattern

1. Run Linter and Identify Issues

# Run your project's linter
<linter-command> 2>&1 | head -100

Analyze output by issue type:

• Style issues (formatting, naming)
• Complexity issues (cyclomatic complexity, function length)
• Security issues
• Performance issues
• Code smell issues (duplication, magic numbers)

2. Categorize and Prioritize

Fix in this order:

1. Quick wins (do these first):

   • Formatting issues (run auto-formatter)
   • Missing punctuation in comments
   • Extract constants for repeated strings/numbers

2. Line length issues:

   • Break long lines across multiple lines
   • Shorten verbose comments
   • Split function signatures
   • Split method chains

3. Legitimate suppression cases (use sparingly):

   • Complexity that can't be simplified (inherent to domain logic)
   • Long functions with comprehensive logic
   • Framework constraints that prevent fix (ORM tags, query builders)

3. Fixing Strategy

Strategy A: Direct Fixes

For issues that improve code quality:

// Style: Add punctuation
// Before: Get user returns the user
// After: Get user returns the user.

// Constants: Extract magic values
// Before: if (timeout === 5000) { ... }
// After: const DEFAULT_TIMEOUT = 5000; if (timeout === DEFAULT_TIMEOUT) { ... }

// Line length: Break long signatures
// Before
function processData(input, options, config, callbacks, validators) {
// After
function processData(
    input,
    options,
    config,
    callbacks,
    validators
) {