Various small fixes in deploy build code

Author: hlxid

build.sbt

@@ -83,7 +83,7 @@ lazy val fetch = TaskKey[Unit]("fetch", "Searches for plugins in plugin director
 lazy val copy = TaskKey[Unit]("copy", "Copies all packaged plugin jars to the target plugin folder.")
 lazy val bs = TaskKey[Unit]("bs", "Updates the bootstrap project with current dependencies and chat overflow jars.")
 lazy val deploy = TaskKey[Unit]("deploy", "Prepares the environment for deployment, fills deploy folder.")
-lazy val deployDev = TaskKey[Unit]("deployDev", "Prepares the environment for deployment, fills deploy folder.")
+lazy val deployDev = TaskKey[Unit]("deployDev", "Prepares the environment for plugin developers, fills deployDev folder.")
 lazy val gui = TaskKey[Unit]("gui", "Installs GUI dependencies and builds it using npm.")
 
 pluginBuildFileName := "plugins.sbt"
@@ -119,7 +119,7 @@ lazy val getDependencyList = Def.task[List[ModuleID]] {
         m.name == s"chatoverflow_$scalaMajorVersion")
   }
 }
-//lazy val x = ModuleID.apply()
+
 // Clears the built GUI dirs on clean
 cleanFiles += baseDirectory.value / guiProjectPath.value / "dist"
 cleanFiles += baseDirectory.value / "src" / "main" / "resources" / "chatoverflow-gui"

project/BootstrapUtility.scala

@@ -106,8 +106,8 @@ object BootstrapUtility {
 
       logger info "Started deployment process."
 
-      // First step: Create directories
-      createOrEmptyFolder("deployDev")
+      // First step: Create directory
+      createOrEmptyFolder("deploy/")
 
       // Second step: Create bin directories and copy all binaries
       val targetJarDirectories = List("bin", "deploy/bin")
@@ -146,16 +146,16 @@ object BootstrapUtility {
 
       logger info "Started deployment process for plugin dev environment."
 
-      // First step: Create directories
-      createOrEmptyFolder("deployDev")
+      // First step: Create directory
+      createOrEmptyFolder("deployDev/")
 
       // Second step: Copy all binaries
       val targetJarDirectories = List("bin", "deployDev/bin")
       prepareBinDirectories(logger, targetJarDirectories, scalaLibraryVersion, copyApi = false)
 
       // Third step: Copy the api
       sbt.IO.copyDirectory(new File(apiProjectPath), new File("deployDev/api/"))
-      sbt.IO.delete(new File("deployDev/api/target"))
+      sbt.IO.delete(new File("deployDev/api/target")) // otherwise compiled code would end up in the zip
 
       // Fourth step: Copy required meta-build files
       val requiredBuildFiles = Set("BuildUtility.scala", "build.properties", "Plugin.scala", "PluginCreateWizard.scala",

project/BuildUtility.scala

@@ -1,7 +1,6 @@
 import java.io.{File, IOException}
 import java.nio.file.{Files, StandardCopyOption}
 
-import BuildUtility._
 import sbt.internal.util.ManagedLogger
 import sbt.util.{FileFunction, FilesInfo}
 
@@ -236,6 +235,20 @@ class BuildUtility(logger: ManagedLogger) {
     }
   }
 
+  /**
+   * Creates a file listing with all files including files in any sub-dir.
+   *
+   * @param f the directory for which the file listing needs to be created.
+   * @return the file listing as a set of files.
+   */
+  def recursiveFileListing(f: File): Set[File] = {
+    if (f.isDirectory) {
+      f.listFiles().flatMap(recursiveFileListing).toSet
+    } else {
+      Set(f)
+    }
+  }
+
   private def withTaskInfo(taskName: String)(task: Unit): Unit = BuildUtility.withTaskInfo(taskName, logger)(task)
 }
 
@@ -261,18 +274,4 @@ object BuildUtility {
     // Info when task stopped (better log comprehension)
     logger info s"Finished custom task: $taskName"
   }
-
-  /**
-   * Creates a file listing with all files including files in any sub-dir.
-   *
-   * @param f the directory for which the file listing needs to be created.
-   * @return the file listing as a set of files.
-   */
-  def recursiveFileListing(f: File): Set[File] = {
-    if (f.isDirectory) {
-      f.listFiles().flatMap(recursiveFileListing).toSet
-    } else {
-      Set(f)
-    }
-  }
 }

project/SbtFile.scala

@@ -20,7 +20,7 @@ class SbtFile(val name: String, val version: String, val plugins: List[Plugin],
     * @param name    the name of a sbt project
     * @param version the version of a sbt project
     */
-  def this(name: String, version: String) = this(name, version, List(),  "", false, List())
+  def this(name: String, version: String) = this(name, version, List(), "", false, List())
 
   /**
     * Represents a simple sbt files content and methods to create a new sbt file. Not intended to open/read sbt files.
@@ -88,13 +88,8 @@ class SbtFile(val name: String, val version: String, val plugins: List[Plugin],
     }
 
     if (defineRoot) {
-      var aggregateElems = plugins.map(p => s"`${p.normalizedName}`")
-      if (apiProjectPath != "") {
-        aggregateElems = "apiProject" +: aggregateElems
-      }
-
       var rootLine = "\n\nlazy val root = (project in file(\".\")).aggregate(%s)"
-        .format(aggregateElems.mkString(", "))
+        .format(("apiProject" +: plugins.map(p => s"`${p.normalizedName}`")).mkString(", "))
 
       if (apiProjectPath != "") {
         rootLine += ".dependsOn(apiProject)"
@@ -107,23 +102,28 @@ class SbtFile(val name: String, val version: String, val plugins: List[Plugin],
       sbtContent append "\nresolvers += \"jcenter-bintray\" at \"http://jcenter.bintray.com\"\n"
 
       // Note that the %% in the string are required to escape the string formatter and will turn into a single %
-      val depString = dependencies.map(m => {
-        var formatString = ""
-
-        if (m.crossVersion == CrossVersion.binary)
-          formatString += "\"%s\" %%%% \"%s\" %% \"%s\""
-        else
-          formatString += "\"%s\" %% \"%s\" %% \"%s\""
-
-        if (m.configurations.isDefined)
-          formatString += " %% \"%s\""
-
-        formatString.format(m.organization, m.name, m.revision, m.configurations.getOrElse(""))
-      }).mkString("  ", ",\n  ", "")
+      val depString = dependencies.map(m => renderModuleID(m)).mkString("  ", ",\n  ", "")
 
       sbtContent append s"libraryDependencies ++= Seq(\n$depString\n)\n"
     }
 
     sbtContent.mkString
   }
+
+  /**
+   * Converts a ModuleID instance to a string with the module in the syntax that is used in sbt files.
+   */
+  private def renderModuleID(m: ModuleID): String = {
+    var formatString = ""
+
+    if (m.crossVersion == CrossVersion.binary)
+      formatString += "\"%s\" %%%% \"%s\" %% \"%s\""
+    else
+      formatString += "\"%s\" %% \"%s\" %% \"%s\""
+
+    if (m.configurations.isDefined)
+      formatString += " %% \"%s\""
+
+    formatString.format(m.organization, m.name, m.revision, m.configurations.getOrElse(""))
+  }
 }