Deploy the whole api project instead of jars, fixes javadoc in IntelliJ

Author: hlxid

.idea/runConfigurations/Full_API_package__sbt_packagedArtifacts_.xml

@@ -94,11 +94,11 @@ guiProjectPath := "gui"
 
 create := PluginCreateWizard(streams.value.log).createPluginTask(pluginFolderNames.value)
 fetch := BuildUtility(streams.value.log).fetchPluginsTask(pluginFolderNames.value, pluginBuildFileName.value,
-  pluginTargetFolderNames.value, apiProjectPath.value, apiJarPath = "")
+  pluginTargetFolderNames.value, apiProjectPath.value)
 copy := BuildUtility(streams.value.log).copyPluginsTask(pluginFolderNames.value, pluginTargetFolderNames.value, scalaMajorVersion)
 bs := BootstrapUtility.bootstrapGenTask(streams.value.log, s"$scalaMajorVersion$scalaMinorVersion", getDependencyList.value)
 deploy := BootstrapUtility.prepareDeploymentTask(streams.value.log, scalaMajorVersion)
-deployDev := BootstrapUtility.prepareDevDeploymentTask(streams.value.log, scalaMajorVersion, getDependencyList.value)
+deployDev := BootstrapUtility.prepareDevDeploymentTask(streams.value.log, scalaMajorVersion, apiProjectPath.value, libraryDependencies.value.toList)
 gui := BuildUtility(streams.value.log).guiTask(guiProjectPath.value, streams.value.cacheDirectory / "gui")
 
 // ---------------------------------------------------------------------------------------------------------------------
@@ -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"

.idea/runConfigurations/_DeployDev__Generate_Bootstrap_Launcher_and_deploy_plugin_dev_environment.xml

@@ -27,6 +27,7 @@ unmanagedBase := file("bin")
 lazy val pluginBuildFileName = settingKey[String]("The filename of the plugin build file. Remember to gitignore it!")
 lazy val pluginFolderNames = settingKey[List[String]]("The folder names of all plugin source directories.")
 lazy val pluginTargetFolderNames = settingKey[List[String]]("The folder names of compiled and packaged plugins. Remember to gitignore these!")
+lazy val apiProjectPath = settingKey[String]("The path to the api sub project. Remember to gitignore it!")
 
 // Plugin framework tasks
 lazy val create = TaskKey[Unit]("create", "Creates a new plugin. Interactive command using the console.")
@@ -36,8 +37,9 @@ lazy val copy = TaskKey[Unit]("copy", "Copies all packaged plugin jars to the ta
 pluginBuildFileName := "plugins.sbt"
 pluginFolderNames := List("plugins-public", "plugins-private")
 pluginTargetFolderNames := List("plugins", s"target/scala-$scalaMajorVersion/plugins")
+apiProjectPath := "api"
 
 create := PluginCreateWizard(streams.value.log).createPluginTask(pluginFolderNames.value)
 fetch := BuildUtility(streams.value.log).fetchPluginsTask(pluginFolderNames.value, pluginBuildFileName.value,
-  pluginTargetFolderNames.value, "", "bin/")
+  pluginTargetFolderNames.value, apiProjectPath.value)
 copy := BuildUtility(streams.value.log).copyPluginsTask(pluginFolderNames.value, pluginTargetFolderNames.value, scalaMajorVersion)

build.sbt

@@ -98,7 +98,7 @@ object BootstrapUtility {
    * @param scalaLibraryVersion the scala library major version
    */
   def prepareDeploymentTask(logger: ManagedLogger, scalaLibraryVersion: String): Unit = {
-    // Assuming, before this: clean, bs, assembly bootstrapProject, package
+    // Assuming, before this: clean, gui, bs, bootstrapProject/assembly, package
     // Assuming: Hardcoded "bin/" and "deploy/" folders
     // Assuming: A folder called "deployment-files" with all additional files (license, bat, etc.)
 
@@ -111,7 +111,7 @@ object BootstrapUtility {
 
       // Second step: Create bin directories and copy all binaries
       val targetJarDirectories = List("bin", "deploy/bin")
-      prepareBinDirectories(logger, targetJarDirectories, scalaLibraryVersion)
+      prepareBinDirectories(logger, targetJarDirectories, scalaLibraryVersion, copyApi = true)
 
       // Third step: Copy bootstrap launcher
       copyJars(s"bootstrap/target/scala-$scalaLibraryVersion/", List("deploy/"), logger)
@@ -134,9 +134,11 @@ object BootstrapUtility {
    *
    * @param logger              the sbt logger
    * @param scalaLibraryVersion the scala library major version
+   * @param apiProjectPath      the path to the api project. Used to copy the api into the deployDev directory
+   * @param dependencies        the dependencies of the framework. Used to create a sbt file with them.
    */
-  def prepareDevDeploymentTask(logger: ManagedLogger, scalaLibraryVersion: String, dependencies: List[ModuleID]): Unit = {
-    // Assuming, before this: clean, package and apiProject/packagedArtifacts
+  def prepareDevDeploymentTask(logger: ManagedLogger, scalaLibraryVersion: String, apiProjectPath: String, dependencies: List[ModuleID]): Unit = {
+    // Assuming, before this: clean, gui and package
     // Assuming: Hardcoded "bin/" and "deployDev/" folders
     // Assuming: A folder called "deployment-files-dev" with more additional files for plugin developers
 
@@ -149,19 +151,23 @@ object BootstrapUtility {
 
       // Second step: Copy all binaries
       val targetJarDirectories = List("bin", "deployDev/bin")
-      prepareBinDirectories(logger, targetJarDirectories, scalaLibraryVersion)
+      prepareBinDirectories(logger, targetJarDirectories, scalaLibraryVersion, copyApi = false)
 
-      // Third step: Copy required meta-build files
+      // Third step: Copy the api
+      sbt.IO.copyDirectory(new File(apiProjectPath), new File("deployDev/api/"))
+      sbt.IO.delete(new File("deployDev/api/target"))
+
+      // Fourth step: Copy required meta-build files
       val requiredBuildFiles = Set("BuildUtility.scala", "build.properties", "Plugin.scala", "PluginCreateWizard.scala",
-        "PluginLanguage.scala", "PluginMetadata.scala", "SbtFile.scala")
+        "PluginLanguage.scala", "PluginMetadata.scala", "SbtFile.scala", "APIUtility.scala", "RequirementsFile.scala")
 
       for (filepath <- requiredBuildFiles) {
         val origFile = new File(s"project/$filepath")
         val deployFile = new File(s"deployDev/project/$filepath")
         sbt.IO.copyFile(origFile, deployFile)
       }
 
-      // Fourth step: Create sbt files containing all dependencies
+      // Fifth step: Create sbt files containing all dependencies
       val depFile = new SbtFile(dependencies)
       sbt.IO.write(new File("deployDev/dependencies.sbt"), depFile.toString)
 
@@ -176,7 +182,7 @@ object BootstrapUtility {
     }
   }
 
-  private def prepareBinDirectories(logger: ManagedLogger, targetDirs: List[String], scalaLibraryVersion: String): Unit = {
+  private def prepareBinDirectories(logger: ManagedLogger, targetDirs: List[String], scalaLibraryVersion: String, copyApi: Boolean): Unit = {
     // First prepare all bin folders
     targetDirs.foreach(d => {
       logger info s"Preparing '$d' folder."
@@ -185,8 +191,10 @@ object BootstrapUtility {
 
     // Then copy all binary files
     logger info "Copying chat overflow files..."
-    val sourceJarDirectories = List(s"target/scala-$scalaLibraryVersion/",
-      s"api/target/scala-$scalaLibraryVersion/")
+    val sourceJarDirectories = if (copyApi)
+      List(s"target/scala-$scalaLibraryVersion/", s"api/target/scala-$scalaLibraryVersion/")
+    else
+      List(s"target/scala-$scalaLibraryVersion/")
 
     sourceJarDirectories.foreach(d => copyJars(d, targetDirs, logger))
   }

deployment-files-dev/build.sbt

@@ -34,10 +34,9 @@ class BuildUtility(logger: ManagedLogger) {
    * @param pluginBuildFileName     The generated sbt build file, containing all sub project references. Defined in build.sbt.
    * @param pluginTargetFolderNames The name of the directory, in which all plugins should be copied.
    * @param apiProjectPath          The path of the api project. Chosen over apiJarPath if possible.
-   * @param apiJarPath              The path of a directory which is containing all api jars. Chosen if apiProjectPath is empty.
    */
   def fetchPluginsTask(pluginSourceFolderNames: List[String], pluginBuildFileName: String,
-                       pluginTargetFolderNames: List[String], apiProjectPath: String, apiJarPath: String): Unit = {
+                       pluginTargetFolderNames: List[String], apiProjectPath: String): Unit = {
     withTaskInfo("FETCH PLUGINS") {
 
       // Check validity of plugin source folders
@@ -49,7 +48,7 @@ class BuildUtility(logger: ManagedLogger) {
       val allPlugins = getAllPlugins(pluginSourceFolderNames)
 
       // Create a sbt file with all plugin dependencies (sub projects)
-      val sbtFile = new SbtFile("", "", allPlugins, apiProjectPath, apiJarPath, defineRoot = true, List())
+      val sbtFile = new SbtFile("", "", allPlugins, apiProjectPath, defineRoot = true, List())
 
       if (sbtFile.save(pluginBuildFileName)) {
         logger info s"Successfully updated plugin file at '$pluginBuildFileName'."

project/BootstrapUtility.scala

@@ -1,6 +1,6 @@
 import java.io.{BufferedWriter, File, FileWriter, IOException}
 
-import sbt.librarymanagement.ModuleID
+import sbt.librarymanagement.{CrossVersion, ModuleID}
 
 /**
  * Represents a simple sbt files content and methods to create a new sbt file. Not intended to open/read sbt files.
@@ -9,19 +9,18 @@ import sbt.librarymanagement.ModuleID
  * @param version        the version of a sbt project
  * @param plugins        list of paths of sub projects
  * @param apiProjectPath the path of a base api project which every project depends on
- * @param apiJarDirPath  the path of a directory containing jar files over the api. Designed to be a fallback to apiProjectPath
  * @param defineRoot     true, if a root project (".") should be defined in the sbt file
  * @param dependencies   library dependencies to add to the sbt file
  */
 class SbtFile(val name: String, val version: String, val plugins: List[Plugin], val apiProjectPath: String,
-              val apiJarDirPath: String, val defineRoot: Boolean, dependencies: List[ModuleID]) {
+              val defineRoot: Boolean, dependencies: List[ModuleID]) {
   /**
     * Represents a simple sbt files content and methods to create a new sbt file. Not intended to open/read sbt files.
     *
     * @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.
@@ -33,7 +32,7 @@ class SbtFile(val name: String, val version: String, val plugins: List[Plugin],
    *
    * @param dependencies library dependencies to add to the sbt file
    */
-  def this(dependencies: List[ModuleID]) = this("", "", List(), "", "", false, dependencies)
+  def this(dependencies: List[ModuleID]) = this("", "", List(), "", false, dependencies)
 
   /**
     * Tries to save the sbt files content into a defined directory.
@@ -79,17 +78,13 @@ class SbtFile(val name: String, val version: String, val plugins: List[Plugin],
 
       if (apiProjectPath != "") {
         pluginLine += ".dependsOn(apiProject)"
-      } else if (apiJarDirPath != "") {
-        pluginLine += ".settings(Compile / unmanagedJars := jars)"
       }
 
       sbtContent append pluginLine
     }
 
     if (apiProjectPath != "") {
       sbtContent append "\n\nlazy val apiProject = project in file(\"%s\")".format(apiProjectPath)
-    } else if (apiJarDirPath != "") {
-      sbtContent append "\nlazy val jars: Classpath = (file(\"%s\") ** \"chatoverflow-api*.jar\").classpath\n".format(apiJarDirPath)
     }
 
     if (defineRoot) {
@@ -112,8 +107,19 @@ 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 => "\"%s\" %% \"%s\" %% \"%s\"".format(m.organization, m.name, m.revision))
-        .mkString("  ", ",\n  ", "")
+      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  ", "")
 
       sbtContent append s"libraryDependencies ++= Seq(\n$depString\n)\n"
     }