Introduce error-prone-guidelines module (PicnicSupermarket#1002)

And move all applicable checks to this new module.
BLasan · Feb 10, 2024 · 9a2a191 · 9a2a191
1 parent a01e5e4
commit 9a2a191
Show file tree

Hide file tree

Showing 19 changed files with 164 additions and 27 deletions.
diff --git a/error-prone-contrib/pom.xml b/error-prone-contrib/pom.xml
@@ -77,10 +77,6 @@
             <artifactId>auto-value-annotations</artifactId>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>com.google.googlejavaformat</groupId>
-            <artifactId>google-java-format</artifactId>
-        </dependency>
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>

diff --git a/error-prone-guidelines/README.md b/error-prone-guidelines/README.md
@@ -0,0 +1,5 @@
+# Error Prone Support coding guidelines
+
+This module provides Error Prone checks that describe and suggest coding
+guidelines for both Error Prone checks and Refaster rules. These rules are only
+meant to be applied to Error Prone Support itself.
diff --git a/error-prone-guidelines/pom.xml b/error-prone-guidelines/pom.xml
@@ -0,0 +1,119 @@
+<?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-guidelines</artifactId>
+
+    <name>Picnic :: Error Prone Support :: Guidelines</name>
+    <description>Coding guidelines for the Error Prone Support project.</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_annotations</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_core</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>documentation-support</artifactId>
+            <!-- This dependency is declared only as a hint to Maven that
+            compilation depends on it; see the `maven-compiler-plugin`'s
+            `annotationProcessorPaths` configuration below. -->
+            <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.googlejavaformat</groupId>
+            <artifactId>google-java-format</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.jspecify</groupId>
+            <artifactId>jspecify</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>
+
+    <build>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-compiler-plugin</artifactId>
+                    <configuration>
+                        <annotationProcessorPaths combine.children="append">
+                            <!-- XXX: Drop the version declarations once
+                            properly supported. See
+                            https://youtrack.jetbrains.com/issue/IDEA-342187. -->
+                            <path>
+                                <groupId>${project.groupId}</groupId>
+                                <artifactId>documentation-support</artifactId>
+                                <version>${project.version}</version>
+                            </path>
+                        </annotationProcessorPaths>
+                        <compilerArgs combine.children="append">
+                            <arg>-Xplugin:DocumentationGenerator -XoutputDirectory=${project.build.directory}/docs</arg>
+                        </compilerArgs>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
+    </build>
+</project>
diff --git a/...patterns/AssociativeMethodInvocation.java → ...patterns/AssociativeMethodInvocation.java b/...patterns/AssociativeMethodInvocation.java → ...patterns/AssociativeMethodInvocation.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
 import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION;
@@ -36,6 +36,8 @@
  * <p>The arguments to such methods can be flattened without affecting semantics, while making the
  * code more readable.
  */
+// XXX: Move this check to the `error-prone-contrib` module once it also covers non-Error Prone
+// methods.
 @AutoService(BugChecker.class)
 @BugPattern(
     summary =

diff --git a/...gpatterns/ErrorProneRuntimeClasspath.java → ...gpatterns/ErrorProneRuntimeClasspath.java b/...gpatterns/ErrorProneRuntimeClasspath.java → ...gpatterns/ErrorProneRuntimeClasspath.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import static com.google.common.collect.ImmutableSet.toImmutableSet;
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;

diff --git a/...rns/ErrorProneTestHelperSourceFormat.java → ...rns/ErrorProneTestHelperSourceFormat.java b/...rns/ErrorProneTestHelperSourceFormat.java → ...rns/ErrorProneTestHelperSourceFormat.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
 import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION;

diff --git a/...prone/bugpatterns/RefasterAnyOfUsage.java → ...lines/bugpatterns/RefasterAnyOfUsage.java b/...prone/bugpatterns/RefasterAnyOfUsage.java → ...lines/bugpatterns/RefasterAnyOfUsage.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
 import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION;

diff --git a/...atterns/RefasterMethodParameterOrder.java → ...atterns/RefasterMethodParameterOrder.java b/...atterns/RefasterMethodParameterOrder.java → ...atterns/RefasterMethodParameterOrder.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import static com.google.common.collect.ImmutableList.toImmutableList;
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;

diff --git a/...ne/bugpatterns/RefasterRuleModifiers.java → ...es/bugpatterns/RefasterRuleModifiers.java b/...ne/bugpatterns/RefasterRuleModifiers.java → ...es/bugpatterns/RefasterRuleModifiers.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
 import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION;

diff --git a/...tterns/UnqualifiedSuggestedFixImport.java → ...tterns/UnqualifiedSuggestedFixImport.java b/...tterns/UnqualifiedSuggestedFixImport.java → ...tterns/UnqualifiedSuggestedFixImport.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
 import static com.google.errorprone.BugPattern.SeverityLevel.WARNING;

diff --git a/...-guidelines/src/main/java/tech/picnic/errorprone/guidelines/bugpatterns/package-info.java b/...-guidelines/src/main/java/tech/picnic/errorprone/guidelines/bugpatterns/package-info.java
@@ -0,0 +1,4 @@
+/** Error Prone Support coding guidelines. */
+@com.google.errorprone.annotations.CheckReturnValue
+@org.jspecify.annotations.NullMarked
+package tech.picnic.errorprone.guidelines.bugpatterns;
diff --git a/...erns/AssociativeMethodInvocationTest.java → ...erns/AssociativeMethodInvocationTest.java b/...erns/AssociativeMethodInvocationTest.java → ...erns/AssociativeMethodInvocationTest.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import com.google.errorprone.BugCheckerRefactoringTestHelper;
 import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;

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

diff --git a/...ErrorProneTestHelperSourceFormatTest.java → ...ErrorProneTestHelperSourceFormatTest.java b/...ErrorProneTestHelperSourceFormatTest.java → ...ErrorProneTestHelperSourceFormatTest.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import com.google.errorprone.BugCheckerRefactoringTestHelper;
 import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;
@@ -14,13 +14,13 @@ void identification() {
             "import com.google.errorprone.BugCheckerRefactoringTestHelper;",
             "import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;",
             "import com.google.errorprone.CompilationTestHelper;",
-            "import tech.picnic.errorprone.bugpatterns.EmptyMethod;",
+            "import tech.picnic.errorprone.guidelines.bugpatterns.RefasterAnyOfUsage;",
             "",
             "class A {",
             "  private final CompilationTestHelper compilationTestHelper =",
-            "      CompilationTestHelper.newInstance(EmptyMethod.class, getClass());",
+            "      CompilationTestHelper.newInstance(RefasterAnyOfUsage.class, getClass());",
             "  private final BugCheckerRefactoringTestHelper refactoringTestHelper =",
-            "      BugCheckerRefactoringTestHelper.newInstance(EmptyMethod.class, getClass());",
+            "      BugCheckerRefactoringTestHelper.newInstance(RefasterAnyOfUsage.class, getClass());",
             "",
             "  void m() {",
             "    compilationTestHelper",
@@ -63,13 +63,13 @@ void replacement() {
             "import com.google.errorprone.BugCheckerRefactoringTestHelper;",
             "import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;",
             "import com.google.errorprone.CompilationTestHelper;",
-            "import tech.picnic.errorprone.bugpatterns.EmptyMethod;",
+            "import tech.picnic.errorprone.guidelines.bugpatterns.RefasterAnyOfUsage;",
             "",
             "class A {",
             "  private final CompilationTestHelper compilationTestHelper =",
-            "      CompilationTestHelper.newInstance(EmptyMethod.class, getClass());",
+            "      CompilationTestHelper.newInstance(RefasterAnyOfUsage.class, getClass());",
             "  private final BugCheckerRefactoringTestHelper refactoringTestHelper =",
-            "      BugCheckerRefactoringTestHelper.newInstance(EmptyMethod.class, getClass());",
+            "      BugCheckerRefactoringTestHelper.newInstance(RefasterAnyOfUsage.class, getClass());",
             "",
             "  void m() {",
             "    compilationTestHelper",
@@ -105,13 +105,13 @@ void replacement() {
             "import com.google.errorprone.BugCheckerRefactoringTestHelper;",
             "import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;",
             "import com.google.errorprone.CompilationTestHelper;",
-            "import tech.picnic.errorprone.bugpatterns.EmptyMethod;",
+            "import tech.picnic.errorprone.guidelines.bugpatterns.RefasterAnyOfUsage;",
             "",
             "class A {",
             "  private final CompilationTestHelper compilationTestHelper =",
-            "      CompilationTestHelper.newInstance(EmptyMethod.class, getClass());",
+            "      CompilationTestHelper.newInstance(RefasterAnyOfUsage.class, getClass());",
             "  private final BugCheckerRefactoringTestHelper refactoringTestHelper =",
-            "      BugCheckerRefactoringTestHelper.newInstance(EmptyMethod.class, getClass());",
+            "      BugCheckerRefactoringTestHelper.newInstance(RefasterAnyOfUsage.class, getClass());",
             "",
             "  void m() {",
             "    compilationTestHelper",

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

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

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

diff --git a/...ns/UnqualifiedSuggestedFixImportTest.java → ...ns/UnqualifiedSuggestedFixImportTest.java b/...ns/UnqualifiedSuggestedFixImportTest.java → ...ns/UnqualifiedSuggestedFixImportTest.java
@@ -1,4 +1,4 @@
-package tech.picnic.errorprone.bugpatterns;
+package tech.picnic.errorprone.guidelines.bugpatterns;
 
 import com.google.errorprone.CompilationTestHelper;
 import org.junit.jupiter.api.Test;

diff --git a/pom.xml b/pom.xml
@@ -42,6 +42,7 @@
         <module>documentation-support</module>
         <module>error-prone-contrib</module>
         <module>error-prone-experimental</module>
+        <module>error-prone-guidelines</module>
         <module>error-prone-utils</module>
         <module>refaster-compiler</module>
         <module>refaster-runner</module>
@@ -262,6 +263,11 @@
                 <artifactId>error-prone-experimental</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>${project.groupId}</groupId>
+                <artifactId>error-prone-guidelines</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>${project.groupId}</groupId>
                 <artifactId>error-prone-utils</artifactId>
@@ -1618,6 +1624,11 @@
                                     <artifactId>error-prone-experimental</artifactId>
                                     <version>${project.version}</version>
                                 </path>
+                                <path>
+                                    <groupId>${project.groupId}</groupId>
+                                    <artifactId>error-prone-guidelines</artifactId>
+                                    <version>${project.version}</version>
+                                </path>
                                 <path>
                                     <groupId>${project.groupId}</groupId>
                                     <artifactId>refaster-runner</artifactId>