Generate Automatic-Module-Name attribute
#1718
Conversation
It is currently impossible to define `pureconfig` on a module path. This is because Java fails to automatically infer Module name from jar's containing invalid characters (e.g. `_` or `-` in `_2.13` cross version). It's a common problem with Scala artifacts. This change adds `Automatic-Module-Name` attribute to MANIFEST that contains a valid Java identifier that can be used to define appropriate module dependencies.
|
Any problem with this PR? This should unblock anyone who wants to use |
|
This is a nice addition. |
There was a problem hiding this comment.
Hey @hubertp, thanks for the contribution. Is there anywhere where I can read more about Java module usages and Scala's recommended approach to this? As you said this seems to be a problem common to all Scala artifacts, so is there general guidance from the Scala team or the community? It seems strange for every project to require that small amount of boilerplate.
This LGTM in general, sending back you just just for minor adjustments.
| @@ -15,9 +15,18 @@ ThisBuild / libraryDependencySchemes ++= Seq( | |||
| "org.scala-lang.modules" %% "scala-xml" % VersionScheme.Always | |||
| ) | |||
|
|
|||
| lazy val javaModuleName = settingKey[String]("Java Module name") | |||
There was a problem hiding this comment.
nit: can you please move this to after the projects are defined? This seems to be too niche and minor to be defined at the top of build.sbt.
| @@ -44,6 +53,7 @@ def genericModule(proj: Project) = proj | |||
| .dependsOn(testkit % "test") | |||
| .settings(commonSettings) | |||
| .settings(name := s"pureconfig-${baseDirectory.value.getName}") | |||
| .settings(Seq(javaModuleName := s"${name.value.replace("-", ".")}") ++ publishSettingAutomaticModuleName) | |||
There was a problem hiding this comment.
I don't understand why we're defining this only for core and generic modules. Don't other modules, like pekko-http and scala-xml, suffer from the same problem? If we can, we should skip the SBT setting boilerplate and just inline this into commonSettings.
It is currently impossible to define
pureconfigon a module path. This is because Java fails to automatically infer Module name from jar's containing invalid characters (e.g._or-in_2.13cross version). It's a common problem with Scala artifacts.This change adds
Automatic-Module-Nameattribute to MANIFEST that contains a valid Java identifier that can be used to define appropriate module dependencies.Also fixed a warning that was stopping the compilation for those who are on JDK 20 already.