Skip to content

Commit 183486c

Browse files
Updated README.md for version 0.2.0
1 parent 5f182bf commit 183486c

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,32 @@ The graph generated in the report will look similar to this one:
1010
Run the following command from the root of your project (the source code does not need to be built):
1111

1212
```bash
13-
mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.1.1:report
13+
mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.2.0:report
1414
```
1515

1616
### As Part of a Build
17-
Add the following to your project in the build section:
17+
Add the following to your project in the build section. **showDetails** will show God Class metrics and rankings in the generated table.
1818
```xml
1919
<build>
2020
<plugins>
2121
...
2222
<plugin>
2323
<groupId>org.hjug.refactorfirst.plugin</groupId>
2424
<artifactId>refactor-first-maven-plugin</artifactId>
25-
<version>0.1.1</version>
25+
<version>0.2.0</version>
26+
<!-- optional -->
27+
<configuration>
28+
<showDetails>true</showDetails>
29+
</configuration>
2630
</plugin>
2731
...
2832
</plugins>
2933
</build>
3034
```
3135

3236
### As a Report
33-
Add the following to your project in the reports section:
37+
Add the following to your project in the reports section.
38+
Not supported as of Version 0.2.0 due to CVE-2020-13936
3439
```xml
3540
<reporting>
3641
<plugins>
@@ -46,7 +51,7 @@ Add the following to your project in the reports section:
4651
```
4752

4853
## 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. The classes in the top left of the graph are the easiest to refactor while also having the biggest positive impact to team productivity.
54+
Once the plugin finishes 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. The classes in the top left of the graph are the easiest to refactor while also having the biggest positive impact to team productivity.
5055

5156

5257
## Additional Details
@@ -55,8 +60,6 @@ This plugin will work on both single module and multi-module Maven projects that
5560
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
5661

5762
## Limitations
58-
* This plugin has only been confirmed to work with Java 8 projects at this time.
59-
* There isn't much logging (yet).
6063
* My time. This is a passion project and has been done in my spare time.
6164

6265
## Feedback and Collaboration Welcome
@@ -66,12 +69,12 @@ If you find this plugin useful, please star this repository and share with your
6669
## Future Plans
6770
* Improve logging.
6871
* Move from JUnit 4 to Junit 5. Junit 5 is lacking the support for temporary files that JUnit 4 provides.
69-
* Use Maven's Guice to autowire dependencies.
7072
* Add a Gradle plugin.
7173
* Incorporate Unit Test coverage metrics to quickly identify the safety of refactoring a God class.
7274
* Incorporate bug counts per God class to the Impact (Y-Axis) calculation.
7375
* Incorporate more disharmonies from Object Oriented Metrics In Practice (Lanza and Marinescu, 2004).
74-
* Support Java 11
7576

77+
## Note:
78+
If you are a user of Version 0.1.0 or 0.1.1, you may notice that the list of God classes found by the plugin has changed. This is due to changes in PMD.
7679

7780
# Thank You! Enjoy!

0 commit comments

Comments
 (0)