You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,22 +45,32 @@ Add the following to your project in the reports section:
45
45
</reporting>
46
46
```
47
47
48
-
Once the plugin is finished executing (it may take a while for large / old codebases), open the file **target/site/refactor-first-report.html** in the root of the project. It will contain a graph similar to the one above, and a table that lists God classes as well as the recommended order they should be refactored in. The classes you should refactor first are at the top.
48
+
## Viewing the Report
49
+
Once the plugin is finished executing (it may take a while for a large / old codebase), open the file **target/site/refactor-first-report.html** in the root of the project. It will contain a graph similar to the one above, and a table that lists God classes in the recommended order that they should be refactored. These are the clasess that are the easiest to refactor while also having the biggest positive impact to team productivity.
49
50
50
-
This plugin will work on both single module and multi-module Maven projects.
51
+
52
+
## Additional Details
53
+
This plugin will work on both single module and multi-module Maven projects that have a typical Maven project layout.
51
54
52
55
This tool is based on the paper **[Prioritizing Design Debt Investment Opportunities](https://dl.acm.org/doi/10.1145/1985362.1985372)** by Nico Zazworka, Carolyn Seaman, and Forrest Shull
53
56
54
-
There is still much to be done. Your feedback would be greatly appreciated!
55
-
56
57
## Limitations
57
-
* This plugin only works with Java 8 projects at this time
58
+
* This plugin has only been confirmed to work with Java 8 projects at this time.
59
+
* There isn't much logging (yet).
60
+
* My time. This is a passion project and has been done in my spare time.
61
+
62
+
## Feedback and Collaboration Welcome
63
+
There is still much to be done. Your feedback and collaboration would be greatly appreciated in the form of feature requests, bug submissions, and PRs.
64
+
If you find this plugin useful, please star this repository and share with your friends & colleagues and on social media.
58
65
59
66
## Future Plans
60
67
* Improve logging.
61
68
* Move from JUnit 4 to Junit 5. Junit 5 is lacking the support for temporary files that JUnit 4 provides.
62
69
* Use Maven's Guice to autowire dependencies.
70
+
* Add a Gradle plugin.
71
+
* Incorporate bug counts per God class to the Impact (Y-Axis) calculation.
63
72
* Incorporate more disharmonies from Object Oriented Metrics In Practice (Lanza and Marinescu, 2004).
0 commit comments