Skip to main content

Find compile errors

org.openrewrite.java.search.FindCompileErrors

Compile errors result in a particular LST structure that can be searched for.

Recipe source​

GitHub: FindCompileErrors.java, Issue Tracker, Code Genome Project

This recipe is available under the Apache License Version 2.0.

Examples​

Example 1​

FindCompileErrorsTest#javaVisitorHandlesErroneousNodes

Before​
class A {
    void test() {
        owner
    }
}
After​
class A {
    void test() {
        /*~~>*/owner
    }
}
Example 2​

JavaParserTest#erroneousVariableDeclarations

Before​
package com.example.demo;
class Bar {
    pet
    public void test() {
    }
}
After​
package com.example.demo;
class Bar {
    /*~~>*/pet
    public void test() {
    }
}
Before​
package com.example.demo;
class Baz {
    -pet
    public void test() {
    }
}
After​
package com.example.demo;
class Baz {
    /*~~>*/-/*~~>*/pet
    public void test() {
    }
}
Before​
package com.example.demo;
class Foo {
    /pet
    public void test() {
    }
}
After​
package com.example.demo;
class Foo {
    /*~~>*///*~~>*/pet
    public void test() {
    }
}

Usage​

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

  1. Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
    ~/.gradle/gradle.properties
    codeGenomeUsername=you@example.com
    codeGenomeToken=your-download-token
  2. Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:
    settings.gradle
    pluginManagement {
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = providers.gradleProperty("codeGenomeUsername").get()
                    password = providers.gradleProperty("codeGenomeToken").get()
                }
            }
            // Keep the portal for any other plugins your build applies
            gradlePluginPortal()
        }
    }
  3. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("org.openrewrite.java.search.FindCompileErrors")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = providers.gradleProperty("codeGenomeUsername").get()
                password = providers.gradleProperty("codeGenomeToken").get()
            }
        }
    }
  4. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Compile errors​

org.openrewrite.java.table.CompileErrors

The source code of compile errors.

Column NameDescription
Source fileThe source file that the method call occurred in.
SourceThe source code of the type use.