Documentation

Generating Reports

Run the Maven plugin:

mvn refactorfirst:jsonReport

This writes .refactorfirst/refactor-first.json. A graphical HTML report is also generated into the targets/site directory bymvn refactorfirst:report.

Understanding the Report

• Priority — XRank-based ordering: refactor these classes first.
• Effort — estimated relative effort to refactor the class.
• Disharmonies — detected design flaws (God Class, Brain Method, Feature Envy, ...).
• Recommendation — suggested next step for each class.

CI/CD Integration

Add the RefactorFirst workflow to your repository so the report regenerates on every push to the default branch. See Getting Startedfor a copy-paste workflow.

Full Documentation

Complete plugin documentation is available in theRefactorFirst repository.