From 9a089a730c8577365cd911a92d05e5fdb4d331e8 Mon Sep 17 00:00:00 2001
From: Zac Sweers <pandanomic@gmail.com>
Date: Wed, 23 Nov 2016 15:30:17 -0800
Subject: [PATCH] Add compiler option to control code formatting

This keeps the current formatting behavior by default, while allowing developers to opt out if they want via flag. Was going to open an issue but figured it would be better to just propose it as a PR.

Disabling has two main uses in my experience:
- The formatting step can actually be a significant chunk of compile time, and for those that don't need/want it gives them an option to disable it.
- For us, the formatting actually causes build flakiness due to a JDK bug. We've currently been operating off of a fork that disables this entirely, but it would be nice to just point to upstream.

I couldn't find where CompilerOptions are tested, if anywhere. Let me know if there's somewhere I should add tests
---
 .../internal/codegen/CompilerOptions.java     | 21 ++++++++++++++++++-
 .../internal/codegen/ComponentProcessor.java  |  5 ++++-
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/compiler/src/main/java/dagger/internal/codegen/CompilerOptions.java b/compiler/src/main/java/dagger/internal/codegen/CompilerOptions.java
index f7e9b213234..30065267dbe 100644
--- a/compiler/src/main/java/dagger/internal/codegen/CompilerOptions.java
+++ b/compiler/src/main/java/dagger/internal/codegen/CompilerOptions.java
@@ -37,6 +37,7 @@ abstract class CompilerOptions {
   abstract Diagnostic.Kind staticMemberValidationKind();
   abstract boolean ignorePrivateAndStaticInjectionForComponent();
   abstract ValidationType scopeCycleValidationType();
+  abstract boolean useFormattingFiler();
 
   static Builder builder() {
     return new AutoValue_CompilerOptions.Builder();
@@ -56,6 +57,7 @@ static CompilerOptions create(ProcessingEnvironment processingEnv, Elements elem
             ignorePrivateAndStaticInjectionForComponent(processingEnv)
                 .equals(FeatureStatus.DISABLED))
         .scopeCycleValidationType(scopeValidationType(processingEnv))
+        .useFormattingFiler(useFormattingFiler(processingEnv).equals(FeatureStatus.ENABLED))
         .build();
   }
 
@@ -69,11 +71,19 @@ interface Builder {
     Builder ignorePrivateAndStaticInjectionForComponent(
         boolean ignorePrivateAndStaticInjectionForComponent);
     Builder scopeCycleValidationType(ValidationType type);
+    Builder useFormattingFiler(boolean useFormattingFiler);
     CompilerOptions build();
   }
 
   static final String WRITE_PRODUCER_NAME_IN_TOKEN_KEY = "dagger.writeProducerNameInToken";
 
+  /**
+   * If true, Dagger will format generated code using a FormattingFiler.
+   *
+   * <p>This defaults to true, but can be useful for reducing compile times.
+   */
+  static final String USE_FORMATTING_FILER = "dagger.useFormattingFiler";
+
   static final String DISABLE_INTER_COMPONENT_SCOPE_VALIDATION_KEY =
       "dagger.disableInterComponentScopeValidation";
 
@@ -99,7 +109,8 @@ Builder ignorePrivateAndStaticInjectionForComponent(
         NULLABLE_VALIDATION_KEY,
         PRIVATE_MEMBER_VALIDATION_TYPE_KEY,
         STATIC_MEMBER_VALIDATION_TYPE_KEY,
-        IGNORE_PRIVATE_AND_STATIC_INJECTION_FOR_COMPONENT);
+        IGNORE_PRIVATE_AND_STATIC_INJECTION_FOR_COMPONENT,
+        USE_FORMATTING_FILER);
 
   private static FeatureStatus writeProducerNameInToken(ProcessingEnvironment processingEnv) {
     return valueOf(
@@ -117,6 +128,14 @@ private static ValidationType scopeValidationType(ProcessingEnvironment processi
         EnumSet.allOf(ValidationType.class));
   }
 
+  private static FeatureStatus useFormattingFiler(ProcessingEnvironment processingEnv) {
+    return valueOf(
+        processingEnv,
+        USE_FORMATTING_FILER,
+        FeatureStatus.ENABLED,
+        EnumSet.allOf(FeatureStatus.class));
+  }
+
   private static ValidationType nullableValidationType(ProcessingEnvironment processingEnv) {
     return valueOf(
         processingEnv,
diff --git a/compiler/src/main/java/dagger/internal/codegen/ComponentProcessor.java b/compiler/src/main/java/dagger/internal/codegen/ComponentProcessor.java
index b150fc551fa..7f596322ee3 100644
--- a/compiler/src/main/java/dagger/internal/codegen/ComponentProcessor.java
+++ b/compiler/src/main/java/dagger/internal/codegen/ComponentProcessor.java
@@ -63,7 +63,10 @@ protected Iterable<? extends ProcessingStep> initSteps() {
     Types types = processingEnv.getTypeUtils();
     Elements elements = processingEnv.getElementUtils();
     CompilerOptions compilerOptions = CompilerOptions.create(processingEnv, elements);
-    Filer filer =  new FormattingFiler(processingEnv.getFiler());
+
+    Filer filer = compilerOptions.useFormattingFiler()
+        ? new FormattingFiler(processingEnv.getFiler())
+        : processingEnv.getFiler();
 
     KeyFormatter keyFormatter = new KeyFormatter();
     MethodSignatureFormatter methodSignatureFormatter = new MethodSignatureFormatter(types);