Skip to content

Commit a67392d

Browse files
Atryclaude
andcommitted
Rename Compatibility.DocUrl to Compatibility.URL
`URL` reads better than `DocUrl` for the api-doc value type of the `apiMappings` map. The alias resolves to `java.net.URL` on sbt 1.x and `java.net.URI` on sbt 2.x. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent f813aa6 commit a67392d

10 files changed

Lines changed: 11 additions & 13 deletions

File tree

src/main/scala-2.12/com/thoughtworks/sbtApiMappings/Compatibility.scala

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package com.thoughtworks.sbtApiMappings
22

33
import java.io.File
4-
import java.net.URL
54

65
import sbt._
76
import sbtcompat.PluginCompat
@@ -12,7 +11,7 @@ import sbtcompat.PluginCompat
1211
private[sbtApiMappings] object Compatibility {
1312

1413
/** The value type of the `apiMappings` map. */
15-
type DocUrl = URL
14+
type URL = java.net.URL
1615

1716
/** Convert a real [[java.io.File]] (e.g. a JDK bootstrap classpath jar) to an
1817
* `apiMappings` key. On sbt 1.x the key is already a `File`.

src/main/scala-3/com/thoughtworks/sbtApiMappings/Compatibility.scala

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package com.thoughtworks.sbtApiMappings
22

33
import java.io.File
4-
import java.net.URI
54

65
import sbt._
76
import sbtcompat.PluginCompat
@@ -12,8 +11,8 @@ import xsbti.HashedVirtualFileRef
1211
*/
1312
private[sbtApiMappings] object Compatibility:
1413

15-
/** The value type of the `apiMappings` map. */
16-
type DocUrl = URI
14+
/** The value type of the `apiMappings` map (a `java.net.URI` on sbt 2.x). */
15+
type URL = java.net.URI
1716

1817
/** Convert a real [[java.io.File]] (e.g. a JDK bootstrap classpath jar) to an
1918
* `apiMappings` key.

src/main/scala/com/thoughtworks/sbtApiMappings/ApiMappings.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ object ApiMappings extends AutoPlugin {
2929
object autoImport {
3030
val apiMappingRules =
3131
SettingKey[
32-
PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.DocUrl]
32+
PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.URL]
3333
](
3434
"api-mapping-rules",
3535
"Rules to create api-mappings"

src/main/scala/com/thoughtworks/sbtApiMappings/BootstrapApiMappings.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ object BootstrapApiMappings extends AutoPlugin {
2020

2121
object autoImport {
2222
val bootstrapJavadocURL =
23-
SettingKey[Compatibility.DocUrl](
23+
SettingKey[Compatibility.URL](
2424
"bootstrap-javadoc-url",
2525
"Javadoc URL for classpath used by bootstrap class loader"
2626
)

src/main/scala/com/thoughtworks/sbtApiMappings/JavadocIoApiMappingRule.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ object JavadocIoApiMappingRule extends AutoPlugin {
2727
}
2828

2929
private def javadocIoRule
30-
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.DocUrl] = {
30+
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.URL] = {
3131
case nonSbtModuleID.extract(organization, libraryName, revision) =>
3232
url(
3333
s"https://javadoc.io/page/$organization/$libraryName/$revision/"

src/main/scala/com/thoughtworks/sbtApiMappings/PlayApiMappingRule.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ object PlayApiMappingRule extends AutoPlugin {
2424
}
2525

2626
private def playRule
27-
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.DocUrl] = {
27+
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.URL] = {
2828
case moduleID.extract(
2929
"com.typesafe.play",
3030
libraryName,

src/main/scala/com/thoughtworks/sbtApiMappings/ScalaApiMappingRule.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ object ScalaApiMappingRule extends AutoPlugin {
2525
}
2626

2727
private def scalaRule
28-
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.DocUrl] = {
28+
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.URL] = {
2929
case moduleID.extract("org.scala-lang", "scala-library", revision) =>
3030
url(s"http://scala-lang.org/files/archive/api/$revision/")
3131
case moduleID.extract("org.scala-lang", libraryName, revision)

src/main/scala/com/thoughtworks/sbtApiMappings/SonatypeApiMappingRule.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ object SonatypeApiMappingRule extends AutoPlugin {
4242
}
4343

4444
private def sonatypeRule
45-
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.DocUrl] = {
45+
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.URL] = {
4646
case nonSbtModuleID.extract(
4747
baseName,
4848
organization,

src/main/scala/com/thoughtworks/sbtApiMappings/SonatypeApiMappingRuleForSbtPlugins.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ object SonatypeApiMappingRuleForSbtPlugins extends AutoPlugin {
4747
}
4848

4949
private def sonatypeRule
50-
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.DocUrl] = {
50+
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.URL] = {
5151
case sbtModuleID.extract(
5252
baseName,
5353
organization,

src/main/scala/com/thoughtworks/sbtApiMappings/SparkApiMappingRule.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ object SparkApiMappingRule extends AutoPlugin {
2424
}
2525

2626
private def sparkRule
27-
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.DocUrl] = {
27+
: PartialFunction[Attributed[PluginCompat.FileRef], Compatibility.URL] = {
2828
case moduleID.extract("org.apache.spark", _, revision) =>
2929
url(s"https://spark.apache.org/docs/$revision/api/scala/")
3030
}

0 commit comments

Comments
 (0)