Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 2.93 KB

linting.md

File metadata and controls

109 lines (80 loc) · 2.93 KB

Linting and Refactoring Support

TDD Guard can optionally check code quality during the refactoring phase (when tests are green) using ESLint. When issues are detected, the coding agent will be prompted to fix them.

Why Use Refactoring Support?

During the TDD green phase, the coding agent may:

  • Clean up implementation code
  • Extract methods or constants
  • Improve naming
  • Remove duplication

The refactoring support helps by:

  • Running ESLint automatically after file modifications
  • Detecting code quality issues
  • Prompting the coding agent to fix any issues found

Setup

  1. Install ESLint in your project:

    npm install --save-dev eslint@latest

  2. Enable linting by setting the environment variable:

    LINTER_TYPE=eslint

    Note: Currently only ESLint is supported. Additional linters may be added in the future.

  3. Configure the PostToolUse hook

    You can configure this hook either through the interactive /hooks command or by manually editing your settings file. See Settings File Locations to choose the appropriate location. Use the same location as your PreToolUse hook.

    Interactive Setup (Recommended)

    1. Type /hooks in Claude Code
    2. Select PostToolUse - After tool execution
    3. Choose + Add new matcher...
    4. Enter: Write|Edit|MultiEdit
    5. Select + Add new hook...
    6. Enter command: tdd-guard
    7. Choose where to save

    Manual Configuration

    Add to your chosen settings file:

    {
  "hooks": {
    "PostToolUse": [
      {
        "matcher": "Write|Edit|MultiEdit",
        "hooks": [
          {
            "type": "command",
            "command": "tdd-guard"
          }
        ]
      }
    ]
  }
}

How It Works

When enabled:

  1. After any file modification (Edit, MultiEdit, Write)
  2. TDD Guard runs ESLint on modified files
  3. If issues are found, the coding agent receives a notification
  4. The agent will then fix the identified issues

Without LINTER_TYPE=eslint, TDD Guard skips all linting operations.

Tip: Configure ESLint with complexity rules (e.g., complexity, max-depth) and the SonarJS plugin to encourage meaningful refactoring. These rules help identify code that could benefit from simplification during the green phase.

ESLint Configuration

For effective refactoring support, consider adding these rules to your .eslintrc.js:

module.exports = {
  rules: {
    complexity: ['warn', 10],
    'max-depth': ['warn', 4],
    'max-lines-per-function': ['warn', 50],
    'max-nested-callbacks': ['warn', 3],
    'max-params': ['warn', 4],
  },
}

Troubleshooting

ESLint Not Running

  1. Verify ESLint is installed: npm list eslint
  2. Check that LINTER_TYPE=eslint is set in your .env file
  3. Ensure the PostToolUse hook is configured
  4. Restart your Claude session after making changes