Update transformer docs (#1040)

Goooler · web-flow · commit 28a6207b1eb1 · 2024-11-25T21:38:39.000+08:00
* Update Transformer

* Update ApacheLicenseResourceTransformer

* Update ApacheNoticeResourceTransformer

* Update AppendingTransformer

* Update ComponentsXmlResourceTransformer

* Update DontIncludeResourceTransformer

* Update GroovyExtensionModuleTransformer

* Update IncludeResourceTransformer

* Update Log4j2PluginsCacheFileTransformer

* Update ManifestResourceTransformer

* Update PropertiesFileTransformer

* Update ServiceFileTransformer

* Update XmlAppendingTransformer

* Cleanups
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformer.kt
@@ -3,9 +3,9 @@ package com.github.jengelman.gradle.plugins.shadow.transformers
 import org.gradle.api.file.FileTreeElement
 
 /**
- * Prevents duplicate copies of the license
+ * Prevents duplicate copies of the license.
  *
- * Modified from `org.apache.maven.plugins.shade.resouce.ApacheLicenseResourceTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java).
  *
  * @author John Engelman
  */
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt
@@ -14,7 +14,7 @@ import org.gradle.api.tasks.Optional
 /**
  * Merges `META-INF/NOTICE.TXT` files.
  *
- * Modified from `org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ApacheNoticeResourceTransformer.java).
  *
  * @author John Engelman
  */
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer.kt
@@ -10,9 +10,8 @@ import org.gradle.api.tasks.Optional
 /**
  * A resource processor that appends content for a resource, separated by a newline.
  *
- * Modified from `org.apache.maven.plugins.shade.resource.AppendingTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.AppendingTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java).
  *
- * Modifications
  * @author John Engelman
  */
 @CacheableTransformer
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ComponentsXmlResourceTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ComponentsXmlResourceTransformer.kt
@@ -17,7 +17,7 @@ import org.gradle.api.file.FileTreeElement
 /**
  * A resource processor that aggregates plexus `components.xml` files.
  *
- * Modified from `org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java).
  *
  * @author John Engelman
  */
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/DontIncludeResourceTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/DontIncludeResourceTransformer.kt
@@ -7,7 +7,7 @@ import org.gradle.api.tasks.Optional
 /**
  * A resource processor that prevents the inclusion of an arbitrary resource into the shaded JAR.
  *
- * Modified from `org.apache.maven.plugins.shade.resource.DontIncludeResourceTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.DontIncludeResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java).
  *
  * @author John Engelman
  */
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer.kt
@@ -10,7 +10,7 @@ import org.apache.tools.zip.ZipOutputStream
 import org.gradle.api.file.FileTreeElement
 
 /**
- * Modified from `eu.appsatori.gradle.fatjar.tasks.PrepareFiles.groovy`
+ * Aggregate Apache Groovy extension modules descriptors.
  *
  * Resource transformer that merges Groovy extension module descriptor files into a single file.
  * Groovy extension module descriptor files have the name org.codehaus.groovy.runtime.ExtensionModule
@@ -23,6 +23,9 @@ import org.gradle.api.file.FileTreeElement
  * It will live in the legacy directory (META-INF/services) if all the processed descriptor
  * files came from the legacy location, otherwise it will be written into the now standard location (META-INF/groovy).
  * Note that certain JDK9+ tooling will break when using the legacy location.
+ *
+ * Modified from [eu.appsatori.gradle.fatjar.tasks.PrepareFiles.groovy](https://github.com/musketyr/gradle-fatjar-plugin/blob/master/src/main/groovy/eu/appsatori/gradle/fatjar/tasks/PrepareFiles.groovy).
+ * Related to [org.apache.maven.plugins.shade.resource.GroovyResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/GroovyResourceTransformer.java).
  */
 @CacheableTransformer
 public open class GroovyExtensionModuleTransformer : Transformer {
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/IncludeResourceTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/IncludeResourceTransformer.kt
@@ -10,10 +10,9 @@ import org.gradle.api.tasks.PathSensitive
 import org.gradle.api.tasks.PathSensitivity
 
 /**
- * A resource processor that allows the addition of an arbitrary file
- * content into the shaded JAR.
+ * A resource processor that allows the addition of an arbitrary file content into the shaded JAR.
  *
- * Modified from `org.apache.maven.plugins.shade.resource.IncludeResourceTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.IncludeResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java).
  *
  * @author John Engelman
  */
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/Log4j2PluginsCacheFileTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/Log4j2PluginsCacheFileTransformer.kt
@@ -18,10 +18,10 @@ import org.gradle.api.file.FileTreeElement
 /**
  * Modified from the maven equivalent to work with gradle
  *
+ * Modified from [org.apache.logging.log4j.maven.plugins.shade.transformer.Log4j2PluginCacheFileTransformer.java](https://github.com/apache/logging-log4j-transform/blob/main/log4j-transform-maven-shade-plugin-extensions/src/main/java/org/apache/logging/log4j/maven/plugins/shade/transformer/Log4j2PluginCacheFileTransformer.java).
+ *
  * @author Paul Nelson Baker
- * @see [LinkedIn](https://www.linkedin.com/in/paul-n-baker/)
- * @see [GitHub](https://github.com/paul-nelson-baker/)
- * @see [PluginsCacheFileTransformer.java](https://github.com/edwgiz/maven-shaded-log4j-transformer/blob/master/src/main/java/com/github/edwgiz/mavenShadePlugin/log4j2CacheTransformer/PluginsCacheFileTransformer.java)
+ * @author John Engelman
  */
 @CacheableTransformer
 public open class Log4j2PluginsCacheFileTransformer : Transformer {
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ManifestResourceTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ManifestResourceTransformer.kt
@@ -17,7 +17,7 @@ import org.slf4j.LoggerFactory
  * the first MANIFEST.MF that is found in the set of JARs being processed, or
  * to a newly created manifest for the shaded JAR.
  *
- * Modified from `org.apache.maven.plugins.shade.resource.ManifestResourceTransformer`
+ * Modified from [org.apache.maven.plugins.shade.resource.ManifestResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java).
  *
  * @author Jason van Zyl
  * @author John Engelman
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/PropertiesFileTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/PropertiesFileTransformer.kt
@@ -86,6 +86,8 @@ import org.gradle.api.tasks.Internal
  * }
  * ```
  *
+ * Related to [org.apache.maven.plugins.shade.resource.properties.PropertiesTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/properties/PropertiesTransformer.java).
+ *
  * @author Andres Almiray
  * @author Marc Philipp
  */
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.kt
@@ -15,14 +15,14 @@ import org.gradle.api.tasks.util.PatternFilterable
 import org.gradle.api.tasks.util.PatternSet
 
 /**
- * Modified from `org.apache.maven.plugins.shade.resource.ServiceResourceTransformer.java`
- *
  * Resources transformer that appends entries in `META-INF/services` resources into
  * a single resource. For example, if there are several `META-INF/services/org.apache.maven.project.ProjectBuilder`
  * resources spread across many JARs the individual entries will all be concatenated into a single
  * `META-INF/services/org.apache.maven.project.ProjectBuilder` resource packaged into the resultant JAR produced
  * by the shading process.
  *
+ * Modified from [org.apache.maven.plugins.shade.resource.ServicesResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java).
+ *
  * @author jvanzyl
  * @author Charlie Knudsen
  * @author John Engelman
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.kt
@@ -6,7 +6,7 @@ import org.gradle.api.file.FileTreeElement
 import org.gradle.api.tasks.Internal
 
 /**
- * Modified from `org.apache.maven.plugins.shade.resource.ResourceTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.ResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java).
  *
  * @author Jason van Zyl
  * @author Charlie Knudsen
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/XmlAppendingTransformer.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/XmlAppendingTransformer.kt
@@ -18,7 +18,7 @@ import org.xml.sax.InputSource
 /**
  * Appends multiple occurrences of some XML file.
  *
- * Modified from `org.apache.maven.plugins.shade.resource.XmlAppendingTransformer.java`
+ * Modified from [org.apache.maven.plugins.shade.resource.XmlAppendingTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/XmlAppendingTransformer.java).
  *
  * @author John Engelman
  */
diff --git a/src/test/groovy/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformerTest.groovy b/src/test/groovy/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformerTest.groovy
@@ -30,7 +30,7 @@ import static org.junit.jupiter.api.Assertions.*
  * @author Benjamin Bentmann
  * @version $Id: ApacheLicenseResourceTransformerTest.java 673906 2008-07-04 05:03:20Z brett $
  *
- * Modified from org.apache.maven.plugins.shade.resources.ApacheLicenseResourceTransformerTest.java
+ * Modified from org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformerTest.java
  */
 class ApacheLicenseResourceTransformerTest extends TransformerTestSupport<ApacheLicenseResourceTransformer> {
 

Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,9 @@ package com.github.jengelman.gradle.plugins.shadow.transformers`
`3`	`3`	`import org.gradle.api.file.FileTreeElement`
`4`	`4`
`5`	`5`	`/**`
`6`		`- * Prevents duplicate copies of the license`
	`6`	`+ * Prevents duplicate copies of the license.`
`7`	`7`	`*`
`8`		- * Modified from `org.apache.maven.plugins.shade.resouce.ApacheLicenseResourceTransformer.java`
	`8`	`+ * Modified from [org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java).`
`9`	`9`	`*`
`10`	`10`	`* @author John Engelman`
`11`	`11`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import org.gradle.api.tasks.Optional`
`14`	`14`	`/**`
`15`	`15`	* Merges `META-INF/NOTICE.TXT` files.
`16`	`16`	`*`
`17`		- * Modified from `org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer.java`
	`17`	`+ * Modified from [org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ApacheNoticeResourceTransformer.java).`
`18`	`18`	`*`
`19`	`19`	`* @author John Engelman`
`20`	`20`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,8 @@ import org.gradle.api.tasks.Optional`
`10`	`10`	`/**`
`11`	`11`	`* A resource processor that appends content for a resource, separated by a newline.`
`12`	`12`	`*`
`13`		- * Modified from `org.apache.maven.plugins.shade.resource.AppendingTransformer.java`
	`13`	`+ * Modified from [org.apache.maven.plugins.shade.resource.AppendingTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java).`
`14`	`14`	`*`
`15`		`- * Modifications`
`16`	`15`	`* @author John Engelman`
`17`	`16`	`*/`
`18`	`17`	`@CacheableTransformer`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ import org.gradle.api.file.FileTreeElement`
`17`	`17`	`/**`
`18`	`18`	* A resource processor that aggregates plexus `components.xml` files.
`19`	`19`	`*`
`20`		- * Modified from `org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer.java`
	`20`	`+ * Modified from [org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java).`
`21`	`21`	`*`
`22`	`22`	`* @author John Engelman`
`23`	`23`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import org.gradle.api.tasks.Optional`
`7`	`7`	`/**`
`8`	`8`	`* A resource processor that prevents the inclusion of an arbitrary resource into the shaded JAR.`
`9`	`9`	`*`
`10`		- * Modified from `org.apache.maven.plugins.shade.resource.DontIncludeResourceTransformer.java`
	`10`	`+ * Modified from [org.apache.maven.plugins.shade.resource.DontIncludeResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java).`
`11`	`11`	`*`
`12`	`12`	`* @author John Engelman`
`13`	`13`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,9 @@ import org.gradle.api.tasks.PathSensitive`
`10`	`10`	`import org.gradle.api.tasks.PathSensitivity`
`11`	`11`
`12`	`12`	`/**`
`13`		`- * A resource processor that allows the addition of an arbitrary file`
`14`		`- * content into the shaded JAR.`
	`13`	`+ * A resource processor that allows the addition of an arbitrary file content into the shaded JAR.`
`15`	`14`	`*`
`16`		- * Modified from `org.apache.maven.plugins.shade.resource.IncludeResourceTransformer.java`
	`15`	`+ * Modified from [org.apache.maven.plugins.shade.resource.IncludeResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java).`
`17`	`16`	`*`
`18`	`17`	`* @author John Engelman`
`19`	`18`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ import org.slf4j.LoggerFactory`
`17`	`17`	`* the first MANIFEST.MF that is found in the set of JARs being processed, or`
`18`	`18`	`* to a newly created manifest for the shaded JAR.`
`19`	`19`	`*`
`20`		- * Modified from `org.apache.maven.plugins.shade.resource.ManifestResourceTransformer`
	`20`	`+ * Modified from [org.apache.maven.plugins.shade.resource.ManifestResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java).`
`21`	`21`	`*`
`22`	`22`	`* @author Jason van Zyl`
`23`	`23`	`* @author John Engelman`
Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,8 @@ import org.gradle.api.tasks.Internal`
`86`	`86`	`* }`
`87`	`87`	* ```
`88`	`88`	`*`
	`89`	`+ * Related to [org.apache.maven.plugins.shade.resource.properties.PropertiesTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/properties/PropertiesTransformer.java).`
	`90`	`+ *`
`89`	`91`	`* @author Andres Almiray`
`90`	`92`	`* @author Marc Philipp`
`91`	`93`	`*/`