Generate comments for deprecated properties

[ashakirin]

Generated comment recipes for deprecated properties without replacement

[timtebeek]

Comments are usually modeled as Comment, not as part of the value. I worry that diverging from this would mean that on a next parse of the project, the text value and comment will be split, and another comment will get inserted. That's not great for folks running recipes repeatedly. Can we adjust this to model comments as Comments instead?

[ashakirin]

Yes, this can be a problem indeed, model comments as Comment will be cleaner solution

[timtebeek]

Turns out: we don't actually model trailing comments as Comment, but as part of the value 🤯

    @ParameterizedTest
    @ValueSource(strings = {"#", "!"})
    void entryValueThenComment(String commentStyle) {
        rewriteRun(
          properties(
            """
              key=value %s this is a comment
              """.formatted(commentStyle),
            spec -> spec.beforeRecipe(p -> {
                assertThat(p.getContent().get(0))
                  .isInstanceOf(Properties.Entry.class)
                  .extracting(e -> ((Properties.Entry) e).getValue().getText())
                  .isEqualTo("value");
            })
          )
        );
    }

This fails with

org.opentest4j.AssertionFailedError: 
expected: "value"
 but was: "value # this is a comment"

[timtebeek]

I won't make you jump through hoops; we'll need to sort that ourselves 😅 .
openrewrite/rewrite@569e733

[ashakirin]

Yeah, but the question is still if inline comment is good idea in case of long reason string. Perhaps normal comment will be better in this case?

[timtebeek]

Regular comment would be fine as well indeed. Saves us the trouble of changing the model.

[timtebeek]

Add this validation that even though for .properties we do not model Comments correctly, we should still model the comment for .yml correctly to avoid repeated addition of the same comment.

[ashakirin]

I am going to submit "clean" recipes to add comment into rewrite-properties and rewrite-yaml to have an option to add normal comment, not inline one

[timtebeek]

Appreciate it! We can switch to those if needed; I stumbled across the one that comments out entries which I figured was good enough for an initial version, but happy to make the change to retain the property but mere add a comment.

[timtebeek]

Great to see this come together; thanks a lot @ashakirin ! Hope you don't mind that I've made quite some changes as well, and regenerated the property migrations to use your new recipe. Neat to finally clear those out for as much as they might still have been present.