使用重写操作向注释添加参数

在这篇博文中，我们将。

• 示范搜索和匹配注释
• 使用 "胡子 "模版来修正注释

Sensei 提供了匹配有问题的代码模式的能力，然后将其修正为商定的实现。在这个例子中，我使用没有参数的@Disabled作为有问题的代码模式。

禁用的测试注释

没有特定原因的禁用测试，从长期来看会被证明是有问题的，因为我们忘记了为什么禁用它。

@Disabled
   void thisTestMethodHasNoDisabledReason(){
    Assertions.fail("This test is disabled and should not run");
    }

风险在于，随着时间的推移，代码库的发展，被禁用的测试没有与代码的目的同步更新，最终成为多余的和不相关的，并且可能永远不会重新启用。

在代码审查过程中，我们经常会指出，添加解释性描述作为注释参数是个好主意。

@Disabled ("Disabled to demonstrate adding a reason")
    void thisTestMethodHasDisabledReason(){
   Assertions.fail("This test is disabled and should not run");
   }

一个Sensei 的食谱

我们可以写一个配方来检测何时在没有解释的情况下添加@Disabled，并写一个快速修复，提醒我们添加实际的理由，解释为什么我们禁用它。

当我想到我要做什么时，我必须这样做。

• 匹配没有任何参数的禁用注释
• 修改禁用注释，使之有一个带有标记文本 "TODO：在此添加描述 "的参数。

创建一个警告配方

我使用Alt+Enter来创建一个新配方。

然后在一般信息中添加基本的描述性文字。

通过使该规则成为警告，任何匹配的代码都会被突出显示，但不会显示为一个明显的错误。

寻找注释

在配方编辑器中，我改变了 "搜索 "以匹配注释。

这将突出显示预览中的所有注释。

做完这些之后，我想对注释的类型进行过滤。

我可以直接使用Disabled，但我用包对类进行了充分的限定，以便它只与JUnit 5的注释相匹配。因为源代码显示在预览中，我可以很容易地从实际代码中复制和粘贴，以避免任何错字。

然后我想只匹配没有参数的注释，我可以用GUI来做这个。

即搜索。

search:
  annotation:
    type: "org.junit.jupiter.api.Disabled"
    without:
       parameters:
          - {}

创建一个重写快速修复行动

对于我的QuickFix，我将使用一个重写动作。

我使用显示变量的功能来向我显示Mustache的变量并预览内容。

然后我添加创建地方标记注释所需的额外代码。

即QuickFix。

availableFixes:
 - name: "Add a todo comment parameter"
   actions:
   - rewrite:
      to: "{{{ . }}}(\"TODO: add a description here\")"
      target: "self"

实践中的Sensei

我们制作了一个简短的视频，展示了菜谱创作过程的实际情况。

摘要

在建立重写快速修复系统时，当我们能够搜索到我们想要重写的代码元素时，就会更容易，因为这时我们可以对它进行自我操作。

在这个例子中，我使用了一个重写动作来修改注释。重写是一个通用的动作，可以适用于任何代码元素，是一个很好的默认探索。