scrooge: Add setting to configure root dir importer

Problem As described in twitter/scrooge/#341 a lot of warnings are generated when using scrooge in projects with sbt sub modules as a root dir importer is always added. Solution Add a new setting scroogeThriftIncludeRoot that makes this behaviour configurable. The default behaviour is as it is now. Result Users won't see a ton of warnings. Closes #345 Signed-off-by: Joy Bestourous <[email protected]> Differential Revision: https://phabricator.twitter.biz/D633782
twitter · Mar 15, 2021 · fe679c0 · fe679c0
1 parent 72f5a0a
commit fe679c0
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 6 deletions.
diff --git a/scrooge-generator/src/main/scala/com/twitter/scrooge/Compiler.scala b/scrooge-generator/src/main/scala/com/twitter/scrooge/Compiler.scala
@@ -18,8 +18,15 @@ package com.twitter.scrooge
 
 import com.twitter.scrooge.ast.Document
 import com.twitter.scrooge.backend.{GeneratorFactory, ScalaGenerator}
-import com.twitter.scrooge.frontend.{FileParseException, TypeResolver, ThriftParser, Importer}
+import com.twitter.scrooge.frontend.{
+  FileParseException,
+  Importer,
+  NullImporter,
+  ThriftParser,
+  TypeResolver
+}
 import com.twitter.scrooge.java_generator.ApacheJavaGenerator
+
 import java.io.{File, FileWriter}
 import scala.collection.concurrent.TrieMap
 
@@ -45,7 +52,12 @@ class Compiler(val config: ScroogeConfig) {
       new FileWriter(file)
     }
 
-    val importer = Importer(new File(".")) +: Importer(config.includePaths.toSeq)
+    val importer = {
+      val rootImporter =
+        if (config.addRootDirImporter) Importer(new File("."))
+        else NullImporter
+      rootImporter +: Importer(config.includePaths.toSeq)
+    }
 
     val isJava = config.language.equals("java")
     val documentCache = new TrieMap[String, Document]

diff --git a/scrooge-generator/src/main/scala/com/twitter/scrooge/ScroogeOptionParser.scala b/scrooge-generator/src/main/scala/com/twitter/scrooge/ScroogeOptionParser.scala
@@ -41,7 +41,8 @@ case class ScroogeConfig(
   language: String = CompilerDefaults.language,
   defaultNamespace: String = CompilerDefaults.defaultNamespace,
   scalaWarnOnJavaNSFallback: Boolean = false,
-  javaSerEnumType: Boolean = false)
+  javaSerEnumType: Boolean = false,
+  addRootDirImporter: Boolean = true)
 
 object ScroogeOptionParser {
 

diff --git a/scrooge-sbt-plugin/src/main/scala/com/twitter/ScroogeSBT.scala b/scrooge-sbt-plugin/src/main/scala/com/twitter/ScroogeSBT.scala
@@ -22,7 +22,8 @@ object ScroogeSBT extends AutoPlugin {
     flags: Set[ServiceOption],
     disableStrict: Boolean,
     scalaWarnOnJavaNSFallback: Boolean,
-    defaultNamespace: String
+    defaultNamespace: String,
+    addRootDirImporter: Boolean
   ): Unit = {
 
     val originalLoader: Option[ClassLoader] =
@@ -43,7 +44,8 @@ object ScroogeSBT extends AutoPlugin {
       strict = !disableStrict,
       scalaWarnOnJavaNSFallback = scalaWarnOnJavaNSFallback,
       defaultNamespace = defaultNamespace,
-      language = language.toLowerCase
+      language = language.toLowerCase,
+      addRootDirImporter = addRootDirImporter
     )
 
     try {
@@ -105,6 +107,11 @@ object ScroogeSBT extends AutoPlugin {
       "complete list of folders to search for thrift 'include' directives"
     )
 
+    val scroogeThriftIncludeRoot = SettingKey[Boolean](
+      "scrooge-thrift-include-root",
+      "If true scrooge will always search the project root for script files"
+    )
+
     val scroogeThriftNamespaceMap = SettingKey[Map[String, String]](
       "scrooge-thrift-namespace-map",
       "namespace rewriting, to support generation of java/finagle/scrooge into the same jar"
@@ -187,6 +194,7 @@ object ScroogeSBT extends AutoPlugin {
     scroogeThriftSources := (scroogeThriftSourceFolder.value ** "*.thrift").get,
     // complete list of include directories
     scroogeThriftIncludes := scroogeThriftIncludeFolders.value ++ scroogeUnpackDeps.value,
+    scroogeThriftIncludeRoot := true,
     // unpack thrift files from all dependencies in the `thrift` configuration
     //
     // returns Seq[File] - directories that include thrift files
@@ -259,6 +267,7 @@ object ScroogeSBT extends AutoPlugin {
       val disableStrict = scroogeDisableStrict.value
       val warnOnFallBack = scroogeScalaWarnOnJavaNSFallback.value
       val javaNamespace = scroogeDefaultJavaNamespace.value
+      val addRootDirImporter = scroogeThriftIncludeRoot.value
       // for some reason, sbt sometimes calls us multiple times, often with no source files.
       if (scroogeIsDirty.value && thriftSources.nonEmpty) {
         streamValue.log.info(s"Generating scrooge thrift for ${thriftSources.mkString(", ")} ...")
@@ -273,7 +282,8 @@ object ScroogeSBT extends AutoPlugin {
             buildOptions.toSet,
             disableStrict,
             warnOnFallBack,
-            javaNamespace
+            javaNamespace,
+            addRootDirImporter
           )
         }
       }