Skip to main content

Find source files with ParseExceptionResult markers

org.openrewrite.FindParseFailures

This recipe explores parse failures after an LST is produced for classifying the types of failures that can occur and prioritizing fixes according to the most common problems.

Recipe source

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options

TypeNameDescriptionExample
IntegermaxSnippetLengthOptional. When the failure occurs on a granular tree element, its source code will be included as a column in the data table up to this maximum snippet length.
StringparserTypeOptional. Only display failures from parsers with this simple name.YamlParser
StringstackTraceOptional. Only mark stack traces with a message containing this text.RuntimeException
StringcreatedAfterOptional. Only report on source files that were created after this date.2025-01-01

Usage

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

  1. Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("7.5.0")
}

rewrite {
activeRecipe("org.openrewrite.FindParseFailures")
setExportDatatables(true)
}

repositories {
mavenCentral()
}

  1. 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

Parser failures

org.openrewrite.table.ParseFailures

A list of files that failed to parse along with stack traces of their failures.

Column NameDescription
ParserThe parser implementation that failed.
Source pathThe file that failed to parse.
Exception typeThe class name of the exception that produce the parse failure.
Tree typeThe type of the tree element that was being parsed when the failure occurred. This can refer either to the intended target OpenRewrite Tree type or a parser or compiler internal tree type that we couldn't determine how to map.
SnippetThe code snippet that the failure occurred on. Omitted when the parser fails on the whole file.
Stack traceThe stack trace of the failure.

Contributors

Knut Wannheden, Shannon Pamperl, Jonathan Schnéider, Tracey Yoshima, Tim te Beek, Mike Solomon