From 5d83d3ef5c957a9730ea8110966ce6521dc5f1f5 Mon Sep 17 00:00:00 2001 From: Maxime Michel Date: Fri, 15 Mar 2024 15:56:34 +0100 Subject: [PATCH] Warn about plain text specifics in AppendToTextFile.java (#4097) See https://github.com/openrewrite/rewrite/issues/4092 --- .../main/java/org/openrewrite/text/AppendToTextFile.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/rewrite-core/src/main/java/org/openrewrite/text/AppendToTextFile.java b/rewrite-core/src/main/java/org/openrewrite/text/AppendToTextFile.java index 9666a17f325..dcd586fd5a3 100644 --- a/rewrite-core/src/main/java/org/openrewrite/text/AppendToTextFile.java +++ b/rewrite-core/src/main/java/org/openrewrite/text/AppendToTextFile.java @@ -72,7 +72,11 @@ public String getDisplayName() { @Override public String getDescription() { - return "Appends or replaces content of an existing plain text file, or creates a new one if it doesn't already exist."; + return "Appends or replaces content of an existing plain text file, or creates a new one if it doesn't already exist. " + + "Please note that this recipes requires existing plain text files' format to be successfully parsable by OpenRewrite. " + + "If a file is left unchanged, it might be parsed as a `Quark` rather than plain text. In such case, use the `plainTextMask` option. " + + "See the [Gradle](https://docs.openrewrite.org/reference/gradle-plugin-configuration#configuring-the-rewrite-dsl) or " + + "[Maven](https://openrewrite.github.io/rewrite-maven-plugin/run-mojo.html#plainTextMasks) plugin configuration page."; } @Override