Skip to content

Commit 1af1f4c

Browse files
Merge branch 'main' of github.com:makingthematrix/scala-suffix into main
2 parents 95206eb + 8e31e51 commit 1af1f4c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ You compile the project and you see this warning:
3232
... and then when you run your program, it crashes when it tries to access the given Scala dependency.
3333
Paraphrasing [this answer on Stack Overflow](https://stackoverflow.com/questions/48714633/automatic-module-name-containing-number/48714979#48714979), since Java 9, Java does not recognize suffixes in modules names like `_2.13` as version numbers and treat them as integral parts of modules names. So, when your project tries to use a class from the Scala dependency, it will look for `your.scala.dependency.2.13` instead of just `your.scala.dependency`, it will fail to do it, and it will crash.
3434

35-
### Installation
36-
37-
TBD. (I need some time to upload the plugin to Maven Central. Until then you would have to download the source code and compile the plugin manually, and I would prefer to spare you this).
3835

3936
### Usage
4037

@@ -43,7 +40,7 @@ Add this to the `<plugins>` section of your `pom.xml`:
4340
<plugin>
4441
<groupId>io.github.makingthematrix</groupId>
4542
<artifactId>scala-suffix-maven-plugin</artifactId>
46-
<version>0.0.3</version>
43+
<version>0.1.0</version>
4744
<configuration>
4845
<libraries>
4946
<param>your-scala-dependency</param>
@@ -66,6 +63,12 @@ Automatic-Module-Name: your-scala-dependency
6663
```
6764
If the property `Automatic-Module-Name` already exists, the plugin does nothing - we assume that in that case the dependency should already work. This prevents the plugin from modifying the same JAR file more than once.
6865

66+
If you find any problems or if you think some kind of an extended functionality would be valuable, feel free to open a ticket under the **Issues** tab here on GitHub. I will se what I can do.
67+
68+
### Tests
69+
70+
Here's [a small Scala+JavaFX project, built with Maven](https://github.com/makingthematrix/scalaonandroid/tree/main/HelloFxml2), which you can use to test how the plugin works.
71+
6972
### Potential problems
7073

7174
1. If `Automatic-Module-Name` already exists but is set to a value that is still invalid for Java 9+, the plugin won't fix this.
@@ -89,6 +92,3 @@ Compile / packageBin / packageOptions +=
8992
Package.ManifestAttributes("Automatic-Module-Name" -> name.value)
9093
```
9194
(`name` here is the name of the library, without the version suffix).
92-
93-
94-
I hope you will find this plugin useful.

0 commit comments

Comments
 (0)