Skip to main content

​
Configuration File

Refactron uses a .refactron.yaml file to configure analyzers, refactorers, and thresholds.

​
Initialize Configuration

Generate a default configuration file: 
refactron init
This creates .refactron.yaml in your project root.

​
Configuration Options

​
Basic Configuration

.refactron.yaml
# Analyzers to run
enabled_analyzers:
  - security
  - performance
  - complexity
  - code_smell
  - type_hint
  - dead_code
  - dependency

# Refactorers to use
enabled_refactorers:
  - extract_method
  - extract_constant
  - add_docstring
  - simplify_conditionals
  - reduce_parameters

# Thresholds
max_function_complexity: 10
max_function_length: 50
max_parameters: 5
max_nesting_depth: 3

​
Pattern Learning

Enable pattern learning to improve suggestions over time:
.refactron.yaml
# Pattern Learning (optional)
enable_pattern_learning: true
pattern_learning_enabled: true
pattern_ranking_enabled: true
pattern_storage_dir: null  # null = auto-detect
Learn more about pattern learning in the Pattern Learning Guide

​
Available Analyzers

Detects security vulnerabilities like SQL injection, code injection, hardcoded secrets, and SSRF
Detects runtime performance antipatterns: N+1 queries, inefficient list operations, unnecessary iterations, inefficient string concatenation, and redundant list() calls
Identifies magic numbers, long functions, excessive parameters, and deep nesting
Measures cyclomatic complexity, maintainability index, and nested loops
Checks for missing or incomplete type annotations
Finds unused functions and unreachable code
Analyzes circular imports and wildcard imports

​
Available Refactorers

Extract long or logically distinct code blocks from complex functions into separate named functions
Extract magic numbers into named constants
Add missing docstrings to functions and classes
Simplify complex conditional statements
Reduce function parameter count using dataclasses or dictionaries

​
Threshold Configuration

Adjust thresholds to match your project’s standards:
.refactron.yaml
# Complexity thresholds
max_function_complexity: 15        # Default: 10
max_function_length: 100           # Default: 50
max_parameters: 7                  # Default: 5
max_nesting_depth: 4              # Default: 3

# Code quality thresholds
min_maintainability_index: 60     # Default: 65
max_cognitive_complexity: 20      # Default: 15

​
Exclude Patterns

Exclude files or directories from analysis:
.refactron.yaml
exclude_patterns:
  - "*/tests/*"
  - "*/migrations/*"
  - "*/venv/*"
  - "*.pyc"
  - "__pycache__"

​
Environment Variables

Configure Refactron using environment variables: 
# Disable color output
export REFACTRON_NO_COLOR=1

# Set log level (DEBUG, INFO, WARNING, ERROR)
export REFACTRON_LOG_LEVEL=DEBUG

# Custom config path
export REFACTRON_CONFIG=/path/to/.refactron.yaml

​
Per-File Ignores

Ignore specific issues in code using comments: 
def my_function():  # refactron: ignore
    # This entire function will be ignored
    pass

def another_function():
    x = 42  # refactron: ignore magic-number
    # Only magic-number check will be ignored for this line

​
Next Steps

Authentication

Set up authentication for cloud features

Code Analysis Guide

Learn about analysis capabilities