added PackagingMethod.PluginModule for plugin model v2 #SCL-21681

README.md

@@ -275,6 +275,12 @@ packageMethod := PackagingMethod.Standalone()
 // specify in which project to merge into
 packageMethod := PackagingMethod.MergeIntoParent()
 
+// This packages all projects that are marked with the same moduleName into
+// a module jar under lib/modules/<moduleName>.jar
+// Modules are a new mechanism in intellij to better configure dependencies
+// between plugins and builtin modules.
+packageMethod := PackagingMethod.PluginModule("moduleName")
+
 // merge all dependencies of this project in a standalone jar
 // being used together with assembleLibraries setting allows sbt-assembly like packaging
 // the project may contain classes but they will be ignored during packaging

packaging/src/main/scala/org/jetbrains/sbtidea/packaging/PackagingMethod.scala

@@ -10,4 +10,5 @@ object PackagingMethod {
   final case class DepsOnly(targetPath: String = "") extends PackagingMethod
   final case class MergeIntoOther(project: Project) extends PackagingMethod
   final case class Standalone(targetPath: String = "", static: Boolean = false) extends PackagingMethod
+  final case class PluginModule(moduleName: String, static: Boolean = false) extends PackagingMethod
 }

packaging/src/main/scala/org/jetbrains/sbtidea/packaging/mappings/LinearMappingsBuilder.scala

@@ -54,6 +54,9 @@ class LinearMappingsBuilder(override val outputDir: File, log: PluginLogger) ext
       case PackagingMethod.Standalone(targetPath, isStatic) =>
         val target = outputDir / targetPath
         addProductDirs(node, target, isStatic)
+      case PackagingMethod.PluginModule(moduleName, isStatic) =>
+        val target = outputDir / mkPluginModulePath(moduleName)
+        addProductDirs(node, target, isStatic)
       case PackagingMethod.Skip() => throw new MappingBuildException("Unreachable")
     }
   }
@@ -63,6 +66,8 @@ class LinearMappingsBuilder(override val outputDir: File, log: PluginLogger) ext
     def collectCandidate(nodes: Seq[PackagedProjectNode]): PackagedProjectNode = {
       if (nodes.isEmpty)
         throw new MappingBuildException(s"No standalone-packaged parents found for $node")
+
+      // note that we do not package into parent with PackagingMethod.PluginModule. For this explicilty use PluginModule
       val candidates = nodes.filter(_.packagingOptions.packageMethod.isInstanceOf[PackagingMethod.Standalone]).distinct
       if (candidates.size > 1)
         throw new MappingBuildException(s"Multiple direct parents package into standalone jar ($node) (use MergeIntoOther): $candidates")
@@ -148,9 +153,12 @@ class LinearMappingsBuilder(override val outputDir: File, log: PluginLogger) ext
       mkProjectJarDefaultPath(node)
     case PackagingMethod.Standalone(nonEmptyPath, _) =>
       nonEmptyPath
+    case PackagingMethod.PluginModule(moduleName, _) =>
+      mkPluginModulePath(moduleName)
   }
 
   private def mkProjectJarDefaultPath(node: ProjectNode): String = s"lib/${node.name}.jar"
+  private def mkPluginModulePath(moduleName: String): String = s"lib/modules/$moduleName.jar"
 
   private def fixPaths(str: String): String = System.getProperty("os.name") match {
     case os if os.startsWith("Windows") => str.replace('/', '\\')

packaging/src/main/scala/org/jetbrains/sbtidea/packaging/structure/PackagingMethod.scala

@@ -5,7 +5,8 @@ sealed trait PackagingMethod
 object PackagingMethod {
   final case class Skip() extends PackagingMethod
   final case class MergeIntoParent() extends PackagingMethod
-  final case class DepsOnly(targetPath: String = "") extends PackagingMethod
+  final case class DepsOnly(targetPath: String) extends PackagingMethod
   final case class MergeIntoOther(project: PackagedProjectNode) extends PackagingMethod
-  final case class Standalone(targetPath: String = "", static: Boolean = false) extends PackagingMethod
+  final case class Standalone(targetPath: String, static: Boolean) extends PackagingMethod
+  final case class PluginModule(moduleName: String, static: Boolean) extends PackagingMethod
 }

packaging/src/main/scala/org/jetbrains/sbtidea/packaging/structure/sbtImpl/SbtPackagingStructureExtractor.scala

@@ -116,5 +116,7 @@ class SbtPackagingStructureExtractor(override val rootProject: ProjectRef,
       structure.PackagingMethod.Standalone(targetPath, static)
     case packaging.PackagingMethod.MergeIntoOther(project) =>
       structure.PackagingMethod.MergeIntoOther(findProjectRef(project).map(projectCache).getOrElse(???))
+    case packaging.PackagingMethod.PluginModule(moduleName, static) =>
+      structure.PackagingMethod.PluginModule(moduleName, static)
   }
 }