SONARHTML-139 Should not raise issue on comments annotated with @elVa…

…riable or @thymesVar (#221)
SonarSource · Nov 23, 2022 · 54ab508 · 54ab508
1 parent 8695a22
commit 54ab508
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/...ugin/src/main/java/org/sonar/plugins/html/checks/comments/AvoidCommentedOutCodeCheck.java b/...ugin/src/main/java/org/sonar/plugins/html/checks/comments/AvoidCommentedOutCodeCheck.java
@@ -19,6 +19,7 @@
 
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.List;
 import org.apache.commons.lang.StringUtils;
 import org.sonar.check.Rule;
 import org.sonar.plugins.html.checks.AbstractPageCheck;
@@ -40,6 +41,8 @@ public class AvoidCommentedOutCodeCheck extends AbstractPageCheck {
 
   private static final CodeRecognizer CODE_RECOGNIZER = new CodeRecognizer(THRESHOLD, LANGUAGE_FOOTPRINT);
 
+  private static final List<String> IGNORED_COMMENT_ANNOTATIONS = Arrays.asList("@thymesVar", "@elvariable");
+
   @Override
   public void comment(CommentNode node) {
     if (node.isHtml()) {
@@ -56,7 +59,9 @@ private static boolean isIgnored(String comment) {
       // Conditional comments
       || comment.startsWith("<!--[if")
       // Server Side Includes
-      || comment.startsWith("<!--#");
+      || comment.startsWith("<!--#")
+      // Annotated comments
+      || IGNORED_COMMENT_ANNOTATIONS.stream().anyMatch(comment::contains);
   }
 
 }
diff --git a/sonar-html-plugin/src/test/resources/checks/AvoidCommentedOutCodeCheck.html b/sonar-html-plugin/src/test/resources/checks/AvoidCommentedOutCodeCheck.html
@@ -55,3 +55,7 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 -->
+
+<!--/* @thymesVar id="users" type="java.util.List<my.namespace.User>" */-->
+
+<!--@elvariable id="id" type="java.lang.String"-->