Introduce error-prone-experimental module (#1003)

And move the known-incomplete `MethodReferenceUsage` check to it.
PicnicSupermarket · Feb 10, 2024 · 6195ede · 6195ede
1 parent 03ba14b
commit 6195ede
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 8 deletions.
diff --git a/...prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/IsInstanceLambdaUsage.java b/...prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/IsInstanceLambdaUsage.java
@@ -23,10 +23,9 @@
 /**
  * A {@link BugChecker} that flags lambda expressions that can be replaced with a method reference
  * of the form {@code T.class::isInstance}.
- *
- * @see MethodReferenceUsage
  */
-// XXX: Consider folding this logic into the `MethodReferenceUsage` check.
+// XXX: Consider folding this logic into the `MethodReferenceUsage` check of the
+// `error-prone-experimental` module.
 @AutoService(BugChecker.class)
 @BugPattern(
     summary = "Prefer `Class::isInstance` method reference over equivalent lambda expression",

diff --git a/error-prone-experimental/README.md b/error-prone-experimental/README.md
@@ -0,0 +1,6 @@
+# Experimental Error Prone checks
+
+This module contains Error Prone checks that are currently under development or
+evaluation. These checks may be works-in-progress or have uncertain impact on
+code. Having this module allows for controlled experimentation and refinement
+before integration into production environments.
diff --git a/error-prone-experimental/pom.xml b/error-prone-experimental/pom.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>tech.picnic.error-prone-support</groupId>
+        <artifactId>error-prone-support</artifactId>
+        <version>0.14.1-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>error-prone-experimental</artifactId>
+
+    <name>Picnic :: Error Prone Support :: Experimental</name>
+    <description>Experimental Error Prone checks.</description>
+    <url>https://error-prone.picnic.tech</url>
+
+    <dependencies>
+        <dependency>
+            <groupId>${groupId.error-prone}</groupId>
+            <artifactId>error_prone_annotation</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>${groupId.error-prone}</groupId>
+            <artifactId>error_prone_check_api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>${groupId.error-prone}</groupId>
+            <artifactId>error_prone_test_helpers</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>error-prone-utils</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.google.auto.service</groupId>
+            <artifactId>auto-service-annotations</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <!-- XXX: Explicitly declared as a workaround for
+        https://github.com/pitest/pitest-junit5-plugin/issues/105. -->
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/...one/bugpatterns/MethodReferenceUsage.java → ...tal/bugpatterns/MethodReferenceUsage.java b/...one/bugpatterns/MethodReferenceUsage.java → ...tal/bugpatterns/MethodReferenceUsage.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.experimental.bugpatterns;
 
 import static com.google.common.collect.ImmutableList.toImmutableList;
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
@@ -37,8 +37,6 @@
 
 /**
  * A {@link BugChecker} that flags lambda expressions that can be replaced with method references.
- *
- * @see IsInstanceLambdaUsage
  */
 // XXX: Other custom expressions we could rewrite:
 // - `a -> "str" + a` to `"str"::concat`. But only if `str` is provably non-null.
@@ -54,7 +52,8 @@
 // Palantir's `LambdaMethodReference` check seems to suffer a similar issue at this time.
 // XXX: Expressions of the form `i -> SomeType.class.isInstance(i)` are not replaced; fix that using
 // a suitable generalization.
-// XXX: Consider folding the `IsInstanceLambdaUsage` check into this class.
+// XXX: Consider folding the `IsInstanceLambdaUsage` check of the `error-prone-contrib` module into
+// this class.
 @AutoService(BugChecker.class)
 @BugPattern(
     summary = "Prefer method references over lambda expressions",

diff --git a/...bugpatterns/MethodReferenceUsageTest.java → ...bugpatterns/MethodReferenceUsageTest.java b/...bugpatterns/MethodReferenceUsageTest.java → ...bugpatterns/MethodReferenceUsageTest.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.experimental.bugpatterns;
 
 import com.google.errorprone.BugCheckerRefactoringTestHelper;
 import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;

diff --git a/pom.xml b/pom.xml
@@ -41,6 +41,7 @@
     <modules>
         <module>documentation-support</module>
         <module>error-prone-contrib</module>
+        <module>error-prone-experimental</module>
         <module>error-prone-utils</module>
         <module>refaster-compiler</module>
         <module>refaster-runner</module>
@@ -256,6 +257,11 @@
                 <artifactId>error-prone-contrib</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>${project.groupId}</groupId>
+                <artifactId>error-prone-experimental</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>${project.groupId}</groupId>
                 <artifactId>error-prone-utils</artifactId>
@@ -1607,6 +1613,11 @@
                                     <artifactId>error-prone-contrib</artifactId>
                                     <version>${project.version}</version>
                                 </path>
+                                <path>
+                                    <groupId>${project.groupId}</groupId>
+                                    <artifactId>error-prone-experimental</artifactId>
+                                    <version>${project.version}</version>
+                                </path>
                                 <path>
                                     <groupId>${project.groupId}</groupId>
                                     <artifactId>refaster-runner</artifactId>