Skip to content

Latest commit

 

History

History
167 lines (132 loc) · 4.18 KB

usestaticimport.md

File metadata and controls

167 lines (132 loc) · 4.18 KB

Use static import

org.openrewrite.java.UseStaticImport

Removes unnecessary receiver types from static method invocations. For example, Collections.emptyList() becomes emptyList().

Source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite
  • artifactId: rewrite-java
  • version: 8.1.3

Options

Type Name Description
String methodPattern A method pattern that is used to find matching method invocations.

Example

Parameters
Parameter Value
methodPattern org.junit.jupiter.api.Assertions assert*(..)

{% tabs %} {% tab title="org/openrewrite/SampleTest.java" %}

Before

{% code title="org/openrewrite/SampleTest.java" %}

package org.openrewrite;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Assertions;

class SampleTest {
    @Test
    void sample() {
        Assertions.assertEquals(42, 21*2);
    }
}

{% endcode %}

After

{% code title="org/openrewrite/SampleTest.java" %}

package org.openrewrite;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

class SampleTest {
    @Test
    void sample() {
        assertEquals(42, 21*2);
    }
}

{% endcode %}

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

--- org/openrewrite/SampleTest.java
+++ org/openrewrite/SampleTest.java
@@ -4,1 +4,0 @@

import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.Assertions;

@@ -6,0 +5,2 @@
import org.junit.jupiter.api.Assertions;

+import static org.junit.jupiter.api.Assertions.assertEquals;
+
class SampleTest {
@@ -9,1 +10,1 @@
    @Test
    void sample() {
-       Assertions.assertEquals(42, 21*2);
+       assertEquals(42, 21*2);
    }

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

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.UseStaticImportExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.UseStaticImportExample
displayName: Use static import example
recipeList:
  - org.openrewrite.java.UseStaticImport:
      methodPattern: java.util.Collections emptyList()

{% endcode %}

Now that com.yourorg.UseStaticImportExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

rewrite {
    activeRecipe("com.yourorg.UseStaticImportExample")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% 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>com.yourorg.UseStaticImportExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

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

Contributors

See how this recipe works across multiple open-source repositories

Moderne Link Image

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.