Rename skipStringLiteral to skipStringConstants

Author: Goooler

api/shadow.api

@@ -112,7 +112,7 @@ public abstract interface class com/github/jengelman/gradle/plugins/shadow/reloc
 	public abstract fun applyToSourceContent (Ljava/lang/String;)Ljava/lang/String;
 	public abstract fun canRelocateClass (Ljava/lang/String;)Z
 	public abstract fun canRelocatePath (Ljava/lang/String;)Z
-	public fun getSkipStringLiteral ()Z
+	public fun getSkipStringConstants ()Z
 	public abstract fun relocateClass (Lcom/github/jengelman/gradle/plugins/shadow/relocation/RelocateClassContext;)Ljava/lang/String;
 	public abstract fun relocatePath (Lcom/github/jengelman/gradle/plugins/shadow/relocation/RelocatePathContext;)Ljava/lang/String;
 }
@@ -137,12 +137,12 @@ public class com/github/jengelman/gradle/plugins/shadow/relocation/SimpleRelocat
 	public fun exclude (Ljava/lang/String;)V
 	public final fun getExcludes ()Ljava/util/Set;
 	public final fun getIncludes ()Ljava/util/Set;
-	public fun getSkipStringLiteral ()Z
+	public fun getSkipStringConstants ()Z
 	public fun hashCode ()I
 	public fun include (Ljava/lang/String;)V
 	public fun relocateClass (Lcom/github/jengelman/gradle/plugins/shadow/relocation/RelocateClassContext;)Ljava/lang/String;
 	public fun relocatePath (Lcom/github/jengelman/gradle/plugins/shadow/relocation/RelocatePathContext;)Ljava/lang/String;
-	public fun setSkipStringLiteral (Z)V
+	public fun setSkipStringConstants (Z)V
 }
 
 public abstract interface class com/github/jengelman/gradle/plugins/shadow/tasks/DependencyFilter : java/io/Serializable {

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

@@ -610,7 +610,7 @@ class RelocationTest : BasePluginTest() {
   )
   @ParameterizedTest
   @ValueSource(booleans = [false, true])
-  fun canDisableRelocateStringConstants(skipStringLiteral: Boolean) {
+  fun canDisableRelocateStringConstants(skipStringConstants: Boolean) {
     writeClassWithStringRef()
     projectScriptPath.appendText(
       """
@@ -619,7 +619,7 @@ class RelocationTest : BasePluginTest() {
             attributes '$mainClassAttributeKey': 'my.Main'
           }
           relocate('junit', 'foo.junit') {
-            skipStringLiteral = $skipStringLiteral
+            skipStringConstants = $skipStringConstants
           }
         }
       """.trimIndent(),
@@ -628,13 +628,8 @@ class RelocationTest : BasePluginTest() {
     run(shadowJarTask)
     val result = runProcess("java", "-jar", outputShadowJar.use { it.toString() })
 
-    assertThat(result).contains(
-      if (skipStringLiteral) {
-        "junit.framework.Test"
-      } else {
-        "foo.junit.framework.Test"
-      },
-    )
+    val expected = if (skipStringConstants) "junit.framework.Test" else "foo.junit.framework.Test"
+    assertThat(result).contains(expected)
   }
 
   private fun writeClassWithStringRef() {

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/RelocatorRemapper.kt

@@ -45,7 +45,7 @@ internal class RelocatorRemapper(
     }
 
     for (relocator in relocators) {
-      if (mapLiterals && relocator.skipStringLiteral) {
+      if (mapLiterals && relocator.skipStringConstants) {
         return name
       } else if (relocator.canRelocateClass(newName)) {
         return prefix + relocator.relocateClass(newName) + suffix

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/relocation/Relocator.kt

@@ -20,8 +20,13 @@ public interface Relocator {
 
   public fun applyToSourceContent(sourceContent: String): String
 
+  /**
+   * Indicates whether this relocator should skip relocating string constants.
+   *
+   * Defaults to `false`.
+   */
   @get:Input
-  public val skipStringLiteral: Boolean get() = false
+  public val skipStringConstants: Boolean get() = false
 
   public companion object {
     public val ROLE: String = Relocator::class.java.name

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/relocation/SimpleRelocator.kt

@@ -19,7 +19,7 @@ public open class SimpleRelocator @JvmOverloads constructor(
   includes: List<String>? = null,
   excludes: List<String>? = null,
   private val rawString: Boolean = false,
-  @get:Input override var skipStringLiteral: Boolean = false,
+  @get:Input override var skipStringConstants: Boolean = false,
 ) : Relocator {
   private val pattern: String
   private val pathPattern: String
@@ -138,7 +138,7 @@ public open class SimpleRelocator @JvmOverloads constructor(
     if (this === other) return true
     if (other !is SimpleRelocator) return false
     return rawString == other.rawString &&
-      skipStringLiteral == other.skipStringLiteral &&
+      skipStringConstants == other.skipStringConstants &&
       pattern == other.pattern &&
       pathPattern == other.pathPattern &&
       shadedPattern == other.shadedPattern &&
@@ -151,7 +151,7 @@ public open class SimpleRelocator @JvmOverloads constructor(
 
   override fun hashCode(): Int {
     var result = rawString.hashCode()
-    result = 31 * result + skipStringLiteral.hashCode()
+    result = 31 * result + skipStringConstants.hashCode()
     result = 31 * result + pattern.hashCode()
     result = 31 * result + pathPattern.hashCode()
     result = 31 * result + shadedPattern.hashCode()