Skip to content

Commit

Permalink
Fix module names for vertx-lang-scala and vertx-lang-scala-test (#122)
Browse files Browse the repository at this point in the history
closes #120
  • Loading branch information
oliver-brm authored Dec 23, 2023
1 parent 062055d commit b3767ef
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 25 deletions.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</parent>

<modelVersion>4.0.0</modelVersion>
<artifactId>vertx-lang-scala3-parent</artifactId>
<artifactId>vertx-lang-scala-parent</artifactId>
<version>4.5.1</version>
<packaging>pom</packaging>
<inceptionYear>2016</inceptionYear>
Expand Down
2 changes: 1 addition & 1 deletion vertx-lang-scala-codegen/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3-parent</artifactId>
<artifactId>vertx-lang-scala-parent</artifactId>
<version>4.5.1</version>
<relativePath>../pom.xml</relativePath>
</parent>
Expand Down
4 changes: 2 additions & 2 deletions vertx-lang-scala-itests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3-parent</artifactId>
<artifactId>vertx-lang-scala-parent</artifactId>
<version>4.5.1</version>
</parent>

Expand All @@ -20,7 +20,7 @@
</dependency>
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3</artifactId>
<artifactId>vertx-lang-scala_3</artifactId>
<version>${stack.version}</version>
</dependency>
<dependency>
Expand Down
6 changes: 3 additions & 3 deletions vertx-lang-scala-on-the-fly/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

<parent>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3-parent</artifactId>
<version>4.3.3</version>
<artifactId>vertx-lang-scala-parent</artifactId>
<version>4.5.1</version>
<relativePath>../pom.xml</relativePath>
</parent>

<artifactId>vertx-lang-scala3-on-the-fly</artifactId>
<artifactId>vertx-lang-scala-on-the-fly</artifactId>
<name>Scala on the fly compilation</name>

<dependencies>
Expand Down
7 changes: 4 additions & 3 deletions vertx-lang-scala-test/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@

<parent>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3-parent</artifactId>
<artifactId>vertx-lang-scala-parent</artifactId>
<version>4.5.1</version>
<relativePath>../pom.xml</relativePath>
</parent>

<artifactId>vertx-lang-scala3-test</artifactId>
<!-- Scala convention is to append an underscore and the major Scala version -->
<artifactId>vertx-lang-scala-test_3</artifactId>

<name>Vert.x Scala Testing Support</name>

<dependencies>
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3</artifactId>
<artifactId>vertx-lang-scala_3</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
Expand Down
6 changes: 3 additions & 3 deletions vertx-lang-scala/build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Compile / doc / scalacOptions ++= Seq(
"-social-links:" + socialLinks.map { case (site, link) => s"$site::$link" }.mkString(","),
"-scastie-configuration", s"""
|libraryDependencies += "io.vertx" % "vertx-web" % ${version.value},
|libraryDependencies += "io.vertx" % "vertx-lang-scala3" % ${version.value},
|libraryDependencies += "io.vertx" %% "vertx-lang-scala" % ${version.value},
""".stripMargin,
"-project-version", version.value,
"-project-logo", "src/main/markdown/_assets/images/vertx-logo.png",
Expand All @@ -29,8 +29,8 @@ lazy val root = project
name := "Vert.x for Scala",
libraryDependencies ++= Seq(
"io.vertx" % "vertx-web" % version.value,
"io.vertx" % "vertx-lang-scala3" % version.value,
"io.vertx" % "vertx-lang-scala3-test" % version.value,
"io.vertx" %% "vertx-lang-scala" % version.value,
"io.vertx" %% "vertx-lang-scala-test" % version.value,
"org.scalatest" %% "scalatest" % "3.2.17",
),
scalacOptions ++= Seq("-deprecation", "-feature"),
Expand Down
5 changes: 3 additions & 2 deletions vertx-lang-scala/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@

<parent>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3-parent</artifactId>
<artifactId>vertx-lang-scala-parent</artifactId>
<version>4.5.1</version>
<relativePath>../pom.xml</relativePath>
</parent>

<artifactId>vertx-lang-scala3</artifactId>
<!-- Scala convention is to append an underscore and the major Scala version -->
<artifactId>vertx-lang-scala_3</artifactId>

<name>Vert.x Scala Language Support</name>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ build descriptor:

```sbt
libraryDependencies += "io.vertx" % "vertx-core" % "{{projectVersion}}"
libraryDependencies += "io.vertx" % "vertx-lang-scala3" % "{{projectVersion}}"
libraryDependencies += "io.vertx" %% "vertx-lang-scala" % "{{projectVersion}}"
```

## Gradle

```kotlin title="build.gradle"
implementation "io.vertx:vertx-core:{{projectVersion}}"
implementation "io.vertx:vertx-lang-scala3:{{projectVersion}}"
implementation "io.vertx:vertx-lang-scala_3:{{projectVersion}}"
```

## Maven
Expand All @@ -32,15 +32,15 @@ implementation "io.vertx:vertx-lang-scala3:{{projectVersion}}"
</dependency>
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3</artifactId>
<artifactId>vertx-lang-scala_3</artifactId>
<version>{{projectVersion}}</version>
</dependency>
```


## What is in the package?

As of now, Vert.x for Scala provides
As of now, Vert.x for Scala provides

- implicit conversions between Vert.x Futures/Promises and Scala Futures/Promises
- a base class for Verticle implementations, [[io.vertx.lang.scala.ScalaVerticle]]
Expand Down
12 changes: 6 additions & 6 deletions vertx-lang-scala/src/main/markdown/_docs/testing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ Vert.x for Scala also brings a test support artifact, which helps to write [Scal

# Installation

To install, add the `vertx-lang-scala3-test` artifact to your build descriptor. This module does not pin to a specific version of ScalaTest. That's why we additionally need to specify the ScalaTest version we desire:
To install, add the `vertx-lang-scala-test_3` artifact to your build descriptor. This module does not pin to a specific version of ScalaTest. That's why we additionally need to specify the ScalaTest version we desire:

## sbt

```sbt
libraryDependencies ++= Seq(
"io.vertx" % "vertx-lang-scala3-test" % "{{projectVersion}}" % Test,
"io.vertx" %% "vertx-lang-scala-test" % "{{projectVersion}}" % Test,
"org.scalatest" %% "scalatest" % Version.scalaTest % Test,
)
```

## Gradle

```groovy title="build.gradle"
testImplementation "io.vertx:vertx-lang-scala3-test:{{projectVersion}}"
testImplementation "io.vertx:vertx-lang-scala-test_3:{{projectVersion}}"
testImplementation "org.scalatest:scalatest_3:$scalatestVersion"
```

Expand All @@ -30,7 +30,7 @@ testImplementation "org.scalatest:scalatest_3:$scalatestVersion"
```xml title="pom.xml"
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-lang-scala3-test</artifactId>
<artifactId>vertx-lang-scala-test_3</artifactId>
<version>{{projectVersion}}</version>
<scope>test</scope>
</dependency>
Expand Down Expand Up @@ -67,7 +67,7 @@ final class MyWebVerticle extends ScalaVerticle:
.mapEmpty[Unit]()
```

Using `vertx-lang-scala3-test`, we can write a ScalaTest spec like this:
Using `vertx-lang-scala-test`, we can write a ScalaTest spec like this:

```scala sc:nocompile
//{
Expand All @@ -93,4 +93,4 @@ final class MyWebVerticleSpec extends VerticleTesting[MyWebVerticle], Matchers:
}
```

That's it, `vertx-lang-scala3-test` takes care of deploying `MyVerticle` to a `Vertx` instance and makes it ready for testing.
That's it, `vertx-lang-scala-test` takes care of deploying `MyVerticle` to a `Vertx` instance and makes it ready for testing.

0 comments on commit b3767ef

Please sign in to comment.