html - 如何将 HTML 文件中的这一行标记为被 Sonar 规则忽略？

Question

我有一个场景，其中有一个 AEM 模板文件，在这个文件中，我有一个 <li> 元素。换句话说，我在内部有一个循环来生成项目列表。

<template data-sly-template.step>
    <li
        data-sly-use.localStep="MyAdapter"
        data-sly-test="${(wcmmode.edit && localStep.start) || !wcmmode.edit}"

但是， Sonar 的规则 RSPEC-1093 提示:

"<li>" and "<dt>" item tags should be in "<ul>", "<ol>" or "<dl>" container tags.

在这种情况下，一旦 <ul> 在模板之外，就不是错误。输出文件是一个生成良好的 HTML 文件，没有错误。

我正在尝试在 html 文件中使用 NOSONAR。我试过 <!-- NOSONAR --> 和 <!-- //NOSONAR --> ，但没​​有用。

如何将 HTML 文件中的这一行标记为被 Sonar 规则忽略？

Answer 1

我检查了 SonarHTML 插件源代码，根据我的理解，您必须在应忽略的行中添加 //NOSONAR。在你的情况下，它应该是:

<template data-sly-template.step>
    <!-- //NOSONAR --><li
        data-sly-use.localStep="MyAdapter"
        data-sly-test="${(wcmmode.edit && localStep.start) || !wcmmode.edit}"

如果您压缩源代码，则该解决方案可以安全使用。如果没有，您必须知道所有这些 <!-- //NOSONAR --> 都将发送给您的客户端。这意味着资源使用量会更大(例如网络带宽 - 要发送的字节数更多)。
//NOSONAR 由 org.sonar.plugins.html.visitor.NoSonarScanner 处理:

source code

test class