Support configuring separator in AppendingTransformer

Author: Goooler

api/shadow.api

@@ -297,6 +297,8 @@ public abstract class com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar
 	public fun <init> ()V
 	public fun append (Ljava/lang/String;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar;
 	public synthetic fun append (Ljava/lang/String;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec;
+	public fun append (Ljava/lang/String;Ljava/lang/String;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar;
+	public synthetic fun append (Ljava/lang/String;Ljava/lang/String;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec;
 	protected fun copy ()V
 	protected fun createCopyAction ()Lorg/gradle/api/internal/file/copy/CopyAction;
 	public fun dependencies (Lorg/gradle/api/Action;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar;
@@ -349,6 +351,7 @@ public abstract class com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar
 
 public abstract interface class com/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec : org/gradle/api/file/CopySpec {
 	public abstract fun append (Ljava/lang/String;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec;
+	public abstract fun append (Ljava/lang/String;Ljava/lang/String;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec;
 	public abstract fun dependencies (Lorg/gradle/api/Action;)Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec;
 	public abstract fun getStats ()Lcom/github/jengelman/gradle/plugins/shadow/ShadowStats;
 	public abstract fun mergeGroovyExtensionModules ()Lcom/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec;
@@ -397,15 +400,21 @@ public class com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNotic
 }
 
 public class com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer : com/github/jengelman/gradle/plugins/shadow/transformers/Transformer {
+	public static final field Companion Lcom/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer$Companion;
+	public static final field DEFAULT_SEPARATOR Ljava/lang/String;
 	public fun <init> (Lorg/gradle/api/model/ObjectFactory;)V
 	public fun canTransformResource (Lorg/gradle/api/file/FileTreeElement;)Z
 	public final fun getObjectFactory ()Lorg/gradle/api/model/ObjectFactory;
 	public fun getResource ()Lorg/gradle/api/provider/Property;
+	public fun getSeparator ()Lorg/gradle/api/provider/Property;
 	public fun hasTransformedResource ()Z
 	public fun modifyOutputStream (Lorg/apache/tools/zip/ZipOutputStream;Z)V
 	public fun transform (Lcom/github/jengelman/gradle/plugins/shadow/transformers/TransformerContext;)V
 }
 
+public final class com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer$Companion {
+}
+
 public abstract interface annotation class com/github/jengelman/gradle/plugins/shadow/transformers/CacheableTransformer : java/lang/annotation/Annotation {
 }
 

src/docs/changes/README.md

@@ -5,7 +5,9 @@
 
 **Added**
 
-- Sync `SimpleRelocator` changes from maven-shade-plugin. ([#1076](https://github.com/GradleUp/shadow/pull/1076))
+- Sync `SimpleRelocator` changes from maven-shade-plugin. ([#1076](https://github.com/GradleUp/shadow/pull/1076))  
+- Support configuring `separator` in `AppendingTransformer`. ([#1169](https://github.com/GradleUp/shadow/pull/1169))  
+  This is useful for handling files like `resources/application.yml`.  
 
 **Changed**
 

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformerTest.kt

@@ -20,14 +20,22 @@ class AppendingTransformerTest : BaseTransformerTest() {
         shadowJarBlock = fromJar(one, two),
         transformerBlock = """
           resource = '$ENTRY_TEST_PROPERTIES'
+          separator = '\n# This is an empty line\n'
         """.trimIndent(),
       ),
     )
 
     run(shadowJarTask)
 
     val content = outputShadowJar.use { it.getContent(ENTRY_TEST_PROPERTIES) }.trimIndent()
-    assertThat(content).isEqualTo(CONTENT_ONE_TWO)
+    assertThat(content).isEqualTo(
+      """
+        $CONTENT_ONE
+        # This is an empty line
+        $CONTENT_TWO
+        # This is an empty line
+      """.trimIndent(),
+    )
   }
 
   @Test

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.kt

@@ -209,9 +209,14 @@ public abstract class ShadowJar :
   }
 
   override fun append(resourcePath: String): ShadowJar {
+    return append(resourcePath, AppendingTransformer.DEFAULT_SEPARATOR)
+  }
+
+  override fun append(resourcePath: String, separator: String): ShadowJar {
     return runCatching {
       transform(AppendingTransformer::class.java) {
         it.resource.set(resourcePath)
+        it.separator.set(separator)
       }
     }.getOrDefault(this)
   }

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec.kt

@@ -45,6 +45,8 @@ public interface ShadowSpec : CopySpec {
 
   public fun append(resourcePath: String): ShadowSpec
 
+  public fun append(resourcePath: String, separator: String): ShadowSpec
+
   public fun relocate(pattern: String, destination: String): ShadowSpec
 
   public fun relocate(pattern: String, destination: String, action: Action<SimpleRelocator>?): ShadowSpec

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer.kt

@@ -27,20 +27,23 @@ public open class AppendingTransformer @Inject constructor(
    * Defer initialization, see [issue 763](https://github.com/GradleUp/shadow/issues/763).
    */
   private var _data: ByteArrayOutputStream? = null
-  private inline val data get() = if (_data == null) ByteArrayOutputStream().also { _data = it } else _data!!
+  private inline val data get() = _data ?: ByteArrayOutputStream().also { _data = it }
 
   @get:Optional
   @get:Input
   public open val resource: Property<String> = objectFactory.property()
 
+  @get:Input
+  public open val separator: Property<String> = objectFactory.property(DEFAULT_SEPARATOR)
+
   override fun canTransformResource(element: FileTreeElement): Boolean {
     return resource.orNull.equals(element.relativePath.pathString, ignoreCase = true)
   }
 
   override fun transform(context: TransformerContext) {
     context.inputStream.use {
       it.copyTo(data)
-      data.write('\n'.code)
+      data.write(separator.get().toByteArray())
     }
   }
 
@@ -57,4 +60,8 @@ public open class AppendingTransformer @Inject constructor(
     data.toByteArray().inputStream().copyTo(os)
     data.reset()
   }
+
+  public companion object {
+    public const val DEFAULT_SEPARATOR: String = "\n"
+  }
 }