Skip to content

Commit

Permalink
Cleanups legacy tags option from code and documentations
Browse files Browse the repository at this point in the history 
Fix #98
  • Loading branch information
@slawekjaranowski
slawekjaranowski committed Jul 1, 2024
1 parent 15a9ba8 commit 0e65561
Show file tree
Hide file tree
Showing 19 changed files with 262 additions and 90 deletions.
10 changes: 0 additions & 10 deletions src/main/java/org/codehaus/mojo/taglist/TagListReport.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,6 @@ public class TagListReport extends AbstractMavenReport {
@Parameter
private org.codehaus.mojo.taglist.options.TagListOptions tagListOptions;

private String[] tags;

/**
* Skip generating report if no tags found in sources.
*
Expand Down Expand Up @@ -262,14 +260,6 @@ private void executeAnalysis() {
// Create the tag classes
List<TagClass> tagClasses = new ArrayList<>();

// If any old style tags were used, then add each tag as a tag class
if (tags != null && tags.length > 0) {
getLog().warn("Using legacy tag format. This is not recommended.");
for (String tag : tags) {
tagClasses.add(createTagClass(tag));
}
}

// If the new style of tag options were used, add them
if (tagListOptions != null && !tagListOptions.getTagClasses().isEmpty()) {
// Scan each tag class
Expand Down
20 changes: 0 additions & 20 deletions src/site/apt/usage.apt.vm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,24 +88,4 @@ mvn site
</reporting>
...
</project>
+---+

For backwards compatibility with versions prior to the 2.4 release, the legacy tags configuration is supported;
however, only exact matching
is used with legacy configuration.

+---+

<project>
...
<configuration>
<tags>
<tag>TODO</tag>
<tag>FIXME</tag>
<tag>@todo</tag>
<tag>@deprecated</tag>
</tags>
</configuration>
...
</project>
+---+
15 changes: 12 additions & 3 deletions src/test/resources/unit/basic-config-test/colons-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,18 @@
<configuration>
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<tags>
<tag>@colons</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@colons</displayName>
<tags>
<tag>
<matchString>@colons</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
15 changes: 12 additions & 3 deletions src/test/resources/unit/basic-config-test/create-output-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,18 @@
<configuration>
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<tags>
<tag>@create_output</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@create_output</displayName>
<tags>
<tag>
<matchString>@create_output</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
24 changes: 20 additions & 4 deletions src/test/resources/unit/basic-config-test/empty-colons-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,26 @@
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<emptyComments>true</emptyComments>
<tags>
<tag>@empty_no_colons</tag>
<tag>@empty_colons</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@empty_no_colons</displayName>
<tags>
<tag>
<matchString>@empty_no_colons</matchString>
</tag>
</tags>
</tagClass>
<tagClass>
<displayName>@empty_colons</displayName>
<tags>
<tag>
<matchString>@empty_colons</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
17 changes: 13 additions & 4 deletions src/test/resources/unit/basic-config-test/empty-comments-disabled-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,22 @@
<plugin>
<artifactId>taglist-maven-plugin</artifactId>
<configuration>
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub" />
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory-empty-comments-disabled</outputDirectory>
<skipEmptyReport>true</skipEmptyReport>
<emptyComments>false</emptyComments>
<tags>
<tag>@empty_comment</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@empty_comment</displayName>
<tags>
<tag>
<matchString>@empty_comment</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
15 changes: 12 additions & 3 deletions src/test/resources/unit/basic-config-test/empty-comments-enabled-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,18 @@
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<emptyComments>true</emptyComments>
<tags>
<tag>@empty_comment</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@empty_comment</displayName>
<tags>
<tag>
<matchString>@empty_comment</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
15 changes: 12 additions & 3 deletions src/test/resources/unit/basic-config-test/multiple-line-comments-disabled-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,18 @@
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<multipleLineComments>false</multipleLineComments>
<tags>
<tag>@multiple_line_comment</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@multiple_line_comment</displayName>
<tags>
<tag>
<matchString>@multiple_line_comment</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
15 changes: 12 additions & 3 deletions src/test/resources/unit/basic-config-test/multiple-line-comments-enabled-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,18 @@
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<multipleLineComments>true</multipleLineComments>
<tags>
<tag>@multiple_line_comment</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@multiple_line_comment</displayName>
<tags>
<tag>
<matchString>@multiple_line_comment</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
24 changes: 20 additions & 4 deletions src/test/resources/unit/basic-config-test/show-empty-details-disabled-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,26 @@
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<showEmptyDetails>false</showEmptyDetails>
<tags>
<tag>@show_empty_details_tag_in_code</tag>
<tag>@show_empty_details_tag_not_in_code</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@show_empty_details_tag_in_code</displayName>
<tags>
<tag>
<matchString>@show_empty_details_tag_in_code</matchString>
</tag>
</tags>
</tagClass>
<tagClass>
<displayName>@show_empty_details_tag_not_in_code</displayName>
<tags>
<tag>
<matchString>@show_empty_details_tag_not_in_code</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
24 changes: 20 additions & 4 deletions src/test/resources/unit/basic-config-test/show-empty-details-enabled-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,26 @@
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<showEmptyDetails>true</showEmptyDetails>
<tags>
<tag>@show_empty_details_tag_in_code</tag>
<tag>@show_empty_details_tag_not_in_code</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@show_empty_details_tag_in_code</displayName>
<tags>
<tag>
<matchString>@show_empty_details_tag_in_code</matchString>
</tag>
</tags>
</tagClass>
<tagClass>
<displayName>@show_empty_details_tag_not_in_code</displayName>
<tags>
<tag>
<matchString>@show_empty_details_tag_not_in_code</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
15 changes: 12 additions & 3 deletions src/test/resources/unit/basic-config-test/xml-output-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,18 @@
<project implementation="org.codehaus.mojo.taglist.stubs.BasicConfigProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/basic-config-test/outputDirectory</outputDirectory>
<showEmptyDetails>false</showEmptyDetails>
<tags>
<tag>@create_output</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>@create_output</displayName>
<tags>
<tag>
<matchString>@create_output</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
53 changes: 45 additions & 8 deletions src/test/resources/unit/counting-tags-test/counting-tags-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,52 @@
<plugin>
<artifactId>taglist-maven-plugin</artifactId>
<configuration>
<project implementation="org.codehaus.mojo.taglist.stubs.CountingTagsProjectStub"/>
<project implementation="org.codehaus.mojo.taglist.stubs.CountingTagsProjectStub" />
<outputDirectory>${basedir}/target/test-classes/unit/counting-tags-test/outputDirectory</outputDirectory>
<tags>
<tag>TODO</tag>
<tag>&lt;todo</tag>
<tag>FIXME</tag>
<tag>DOCUMENT_ME</tag>
<tag>NOT_YET_DOCUMENTED</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>TODO</displayName>
<tags>
<tag>
<matchString>TODO</matchString>
</tag>
</tags>
</tagClass>
<tagClass>>
<displayName>&lt;todo</displayName>
<tags>
<tag>
<matchString>&lt;todo</matchString>
</tag>
</tags>
</tagClass>
<tagClass>
<displayName>FIXME</displayName>
<tags>
<tag>
<matchString>FIXME</matchString>
</tag>
</tags>
</tagClass>
<tagClass>
<displayName>DOCUMENT_ME</displayName>
<tags>
<tag>
<matchString>DOCUMENT_ME</matchString>
</tag>
</tags>
</tagClass>
<tagClass>
<displayName>NOT_YET_DOCUMENTED</displayName>
<tags>
<tag>
<matchString>NOT_YET_DOCUMENTED</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
15 changes: 12 additions & 3 deletions src/test/resources/unit/tag-test/c-style-tags-pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,18 @@
<configuration>
<project implementation="org.codehaus.mojo.taglist.stubs.TagsProjectStub"/>
<outputDirectory>${basedir}/target/test-classes/unit/tag-test/outputDirectory</outputDirectory>
<tags>
<tag>c_style_tag</tag>
</tags>
<tagListOptions>
<tagClasses>
<tagClass>
<displayName>c_style_tag</displayName>
<tags>
<tag>
<matchString>c_style_tag</matchString>
</tag>
</tags>
</tagClass>
</tagClasses>
</tagListOptions>
</configuration>
</plugin>
</plugins>
Expand Down
Loading

0 comments on commit 0e65561

Please sign in to comment.