palantir / goethe

Java code-formatter for https://github.com/square/javapoet

Goethe

Goethe is a code formatter library for square/javapoet using palantir-java-format.

The palantir-java-format that this library uses is shaded into a nested package to prevent coupling between human-generated code formatting and validation, and components which generate code automatically.

Usage

Formatting a javapoet JavaFile as a String:

String formatted = Goethe.formatAsString(javaFile);

Formatting a JavaFile while writing it to an annotation processing Filer:

Goethe.formatAndEmit(javaFile, filer);

Gradle Tasks

./gradlew tasks - to get the list of gradle tasks

Start Developing

Run one of the following commands:

• ./gradlew idea for IntelliJ
• ./gradlew eclipse for Eclipse

goethe's Issues

Reformat Javadoc to add line wraps

I have an internal code generator that adds very long Javadoc using javapoet's MethodSpec.addJavadoc(). Unfortunately the generated output doesn't add line wraps, so the Javadoc is all on one very long line. I'd like this to be wrapped for improved readability, but there is no option for that library to set on goethe to reformat Javadoc as well as Java code.

Blocked on palantir/palantir-java-format#724

Goethe not self-bootstrapping when used with gradle 7.3.1

Getting the following failure when running goethe in JDK 17 with Gradle 7.3.1:

Caused by: com.palantir.goethe.GoetheException: Formatter exited non-zero (1) formatting class $CLASSNAME:
Error: Could not find or load main class com.palantir.goethe.GoetheMain
Caused by: java.lang.ClassNotFoundException: com.palantir.goethe.GoetheMain

        at com.palantir.goethe.BootstrappingFormatterFacade.formatSource(BootstrappingFormatterFacade.java:66)
        at com.palantir.goethe.Goethe.formatAsString(Goethe.java:54)
        at com.palantir.goethe.Goethe.formatAndEmit(Goethe.java:97)
        at com.palantir.conjure.java.GenerationCoordinator.lambda$emit$1(GenerationCoordinator.java:46)
        at com.google.common.util.concurrent.AbstractTransformFuture$TransformFuture.doTransform(AbstractTransformFuture.java:250)
        at com.google.common.util.concurrent.AbstractTransformFuture$TransformFuture.doTransform(AbstractTransformFuture.java:240)
        at com.google.common.util.concurrent.AbstractTransformFuture.run(AbstractTransformFuture.java:122)

After attaching a debugger, it looks like the classpath isn't set right, as System.getProperty("java.class.path") returns:

~/.gradle/wrapper/dists/gradle-7.3.1-bin/[...]/gradle-7.3.1/lib/gradle-launcher-7.3.1.jar