replaceduplicatestringliterals.md

Replace duplicate String literals

org.openrewrite.staticanalysis.ReplaceDuplicateStringLiterals

Replaces String literals with a length of 5 or greater repeated a minimum of 3 times. Qualified String literals include final Strings, method invocations, and new class invocations. Adds a new private static final String or uses an existing equivalent class field. A new variable name will be generated based on the literal value if an existing field does not exist. The generated name will append a numeric value to the variable name if a name already exists in the compilation unit.

Tags

• RSPEC-1192

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-static-analysis
• version: 1.0.1

Options

Type	Name	Description
Boolean	includeTestSources	Optional. Changes only apply to main by default. includeTestSources will apply the recipe to test source files.

Example

Parameters

Parameter	Value
includeTestSources	true

{% tabs %} {% tab title="org/foo/A.java" %}

Before

{% code title="org/foo/A.java" %}

package org.foo;
class A {
    final String val1 = "value";
    final String val2 = "value";
    final String val3 = "value";
}

{% endcode %}

After

{% code title="org/foo/A.java" %}

package org.foo;
class A {
    private static final String VALUE = "value";
    final String val1 = VALUE;
    final String val2 = VALUE;
    final String val3 = VALUE;
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- org/foo/A.java
+++ org/foo/A.java
@@ -3,3 +3,4 @@
package org.foo;
class A {
-   final String val1 = "value";
-   final String val2 = "value";
-   final String val3 = "value";
+   private static final String VALUE = "value";
+   final String val1 = VALUE;
+   final String val2 = VALUE;
+   final String val3 = VALUE;
}

{% endcode %} {% endtab %} {% endtabs %}

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-static-analysis:1.0.1 in your build file or by running a shell command (in which case no build changes are needed): {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("org.openrewrite.staticanalysis.ReplaceDuplicateStringLiterals")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-static-analysis:1.0.1")
}

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.staticanalysis.ReplaceDuplicateStringLiterals</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-static-analysis</artifactId>
            <version>1.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} {% code title="shell" %} You will need to have Maven installed on your machine before you can run the following command.

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-static-analysis:RELEASE \
  -Drewrite.activeRecipes=org.openrewrite.staticanalysis.ReplaceDuplicateStringLiterals

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Tracey Yoshima
• Knut Wannheden
• Jonathan Schneider
• Sam Snyder
• Kun Li

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.