"Did you mean to..." hint messages contain repeated text

[dpursehouse]

Please answer these questions before submitting your issue. Thanks!

What version of Error Prone are you using?

Not sure. Whatever is bundled with bazel version 0.17.2

Does this issue reproduce with the latest release?

Have not tried

What did you do?

Clone JGit and build from commit https://github.com/eclipse/jgit/commit/7d89f0a053f32e0ba6d0384cf73a70ce99190821

with the command:

bazel build --java_toolchain //tools:error_prone_warnings_toolchain //...

What did you expect to see?

Various warnings are expected because we haven't been using error-prone regularly on this project.

What did you see instead?

There are warnings about misuse of ExpectedException, but the hints to fix them contain repeated text, for example:

Did you mean to remove this line or to remove this line or to remove this line?

[dpursehouse]

/CC @davido

[davido]

There is this loop in: JavacErrorDescriptionListener#messageForFixes():

https://github.com/google/error-prone/blob/master/check_api/src/main/java/com/google/errorprone/JavacErrorDescriptionListener.java#L130-L142

private static String messageForFixes(Description description, List<AppliedFix> appliedFixes) {
    StringBuilder messageBuilder = new StringBuilder(description.getMessage());
    boolean first = true;
    for (AppliedFix appliedFix : appliedFixes) {
      if (first) {
        messageBuilder.append("\nDid you mean ");
      } else {
        messageBuilder.append(" or ");
      }
      if (appliedFix.isRemoveLine()) {
        messageBuilder.append("to remove this line");
      } else {
        messageBuilder.append("'").append(appliedFix.getNewCodeSnippet()).append("'");
      }
      first = false;
    }
    if (!first) { // appended at least one suggested fix to the message
      messageBuilder.append("?");
    }
    return messageBuilder.toString();
  }

Is some flaw in the method or parameter passed in are the root cause here?

[grankdan]

Is this issue being reviewed?