Avoid warning about legacy for default tags

fix #74
mojohaus · Jun 29, 2024 · 19aa03b · 19aa03b
1 parent 295c644
commit 19aa03b
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 17 deletions.
diff --git a/src/main/java/org/codehaus/mojo/taglist/TagListReport.java b/src/main/java/org/codehaus/mojo/taglist/TagListReport.java
@@ -201,12 +201,6 @@ public class TagListReport extends AbstractMavenReport {
  protected void executeReport(Locale locale) throws MavenReportException {
  this.currentLocale = locale;
 
- // User entered no tags and no tagOptions, then default tags
- if ((tags == null || tags.length == 0)
- && (tagListOptions == null || tagListOptions.getTagClasses().isEmpty())) {
- tags = new String[] {"@todo", "TODO", "FIXME"};
- }
-
  if (StringUtils.isEmpty(getInputEncoding())) {
  getLog().warn("File encoding has not been set, using platform encoding "
  + Charset.defaultCharset().displayName() + ", i.e. build is platform dependent!");
@@ -219,16 +213,7 @@ protected void executeReport(Locale locale) throws MavenReportException {
  if (tags != null && tags.length > 0) {
  getLog().warn("Using legacy tag format. This is not recommended.");
  for (String tag : tags) {
- TagClass tc = new TagClass(tag);
- try {
- AbsTag newTag = TagFactory.createTag("exact", tag);
- tc.addTag(newTag);
-
- tagClasses.add(tc);
- } catch (InvalidTagException e) {
- // This should be impossible since exact is supported.
- getLog().error("Invalid tag type used. tag type: exact");
- }
+ tagClasses.add(createTagClass(tag));
  }
  }
 
@@ -262,6 +247,13 @@ protected void executeReport(Locale locale) throws MavenReportException {
  }
  }
 
+ // default tags
+ if (tagClasses.isEmpty()) {
+ tagClasses.add(createTagClass("@todo"));
+ tagClasses.add(createTagClass("TODO"));
+ tagClasses.add(createTagClass("FIXME"));
+ }
+
  // let's proceed to the analysis
  FileAnalyser fileAnalyser = new FileAnalyser(this, tagClasses);
  Collection<TagReport> tagReports = fileAnalyser.execute();
@@ -297,6 +289,17 @@ protected void executeReport(Locale locale) throws MavenReportException {
  generateXmlReport(tagReports);
  }
 
+ private TagClass createTagClass(String tag) {
+ TagClass tc = new TagClass(tag);
+ try {
+ AbsTag newTag = TagFactory.createTag("exact", tag);
+ tc.addTag(newTag);
+ } catch (InvalidTagException e) {
+ // This should be impossible since exact is supported.
+ }
+ return tc;
+ }
+
  /**
  * Generate an XML report that can be used by other plugins like the dashboard plugin.
  *

diff --git a/src/test/java/org/codehaus/mojo/taglist/TaglistMojoTagsTest.java b/src/test/java/org/codehaus/mojo/taglist/TaglistMojoTagsTest.java
@@ -50,6 +50,10 @@ public void testDefaultTags() throws Exception {
  // Check to see that @todo has one occurance.
  expected = "\">TODO</a></td><td>1</td>";
  assertTrue("Incorrect default TODO tag result.", htmlString.contains(expected));
+
+ // Check to see that @FIXME has one occurance.
+ expected = "\">FIXME</a></td><td>1</td>";
+ assertTrue("Incorrect default FIXME tag result.", htmlString.contains(expected));
  }
 
  /**

diff --git a/src/test/resources/unit/tag-test/java-sources/com/Tags.java b/src/test/resources/unit/tag-test/java-sources/com/Tags.java
@@ -4,7 +4,8 @@
  *
  * @todo: This is the default tag #1.
  * TODO: This is the default tag #2.
- * 
+ * FIXME: This is the default tag #3.
+ *
  */
 class Tags
 {