Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Feature: SBT - disable docs publish #578

Merged
merged 3 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
enableScalaJs: Boolean,
scalaVersion: Option[String],
sbtVersion: Option[String],
enableDocs: Option[Boolean],
)

object SbtOptions {
Expand All @@ -23,6 +24,7 @@
enableScalaJs = true,
scalaVersion = None,
sbtVersion = None,
enableDocs = None,

Check warning on line 27 in idealingua-v1/idealingua-v1-core/src/main/scala/izumi/idealingua/model/publishing/manifests/ScalaBuildManifest.scala

View check run for this annotation

Codecov / codecov/patch

idealingua-v1/idealingua-v1-core/src/main/scala/izumi/idealingua/model/publishing/manifests/ScalaBuildManifest.scala#L27

Added line #L27 was not covered by tests
)
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,18 @@

object SbtDslOp {

final case class Append[T](v: T, scope: Scope = Scope.ThisBuild) extends SbtDslOp
final case class Append[T](v: T, scope: List[Scope]) extends SbtDslOp
object Append {
def apply[T](v: T, scope: Scope = Scope.ThisBuild): Append[T] = {
new Append[T](v, List(scope))

Check warning on line 10 in idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtDslOp.scala

View check run for this annotation

Codecov / codecov/patch

idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtDslOp.scala#L10

Added line #L10 was not covered by tests
}
}

final case class Assign[T](v: T, scope: Scope = Scope.ThisBuild) extends SbtDslOp
final case class Assign[T](v: T, scope: List[Scope]) extends SbtDslOp
object Assign {
def apply[T](v: T, scope: Scope = Scope.ThisBuild): Assign[T] = {
new Assign[T](v, List(scope))

Check warning on line 17 in idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtDslOp.scala

View check run for this annotation

Codecov / codecov/patch

idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtDslOp.scala#L17

Added line #L17 was not covered by tests
}
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,15 @@
parts.mkString(" ")
}

def renderScope(scope: Scope, key: String): String = {
scope match {
case Scope.ThisBuild =>
s"ThisBuild / $key"
case Scope.Project =>
key
def renderScope(scopes: List[Scope], key: String): String = {
if (scopes == List(Scope.Project)) {
key

Check warning on line 24 in idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtRenderer.scala

View check run for this annotation

Codecov / codecov/patch

idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtRenderer.scala#L23-L24

Added lines #L23 - L24 were not covered by tests
} else {
(scopes ++ List(Scope.Custom(key))).map {
case Scope.ThisBuild => "ThisBuild"
case Scope.Project => "ThisProject"
case Scope.Custom(scope) => scope
}.mkString(" / ")

Check warning on line 30 in idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtRenderer.scala

View check run for this annotation

Codecov / codecov/patch

idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/SbtRenderer.scala#L30

Added line #L30 was not covered by tests
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@
Seq("resolvers" -> Append(RawExpr("Opts.resolver.sonatypeReleases")))
}

val docs = Seq(
"publishArtifact" -> Assign(options.manifest.sbt.enableDocs.getOrElse(false), List(Scope.ThisBuild, Scope.Custom("packageDoc"))),

Check warning on line 117 in idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/ScalaLayouter.scala

View check run for this annotation

Codecov / codecov/patch

idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/ScalaLayouter.scala#L116-L117

Added lines #L116 - L117 were not covered by tests
)

val metadata = Seq(
"name" -> Assign(options.manifest.common.name, Scope.Project),
"organization" -> Assign(options.manifest.common.group),
Expand All @@ -122,7 +126,7 @@
)

val renderer = new SbtRenderer()
val keys = (metadata ++ resolvers ++ deps ++ circeDerivationWorkaround).map(renderer.renderOp)
val keys = (docs ++ metadata ++ resolvers ++ deps ++ circeDerivationWorkaround).map(renderer.renderOp)

Check warning on line 129 in idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/ScalaLayouter.scala

View check run for this annotation

Codecov / codecov/patch

idealingua-v1/idealingua-v1-transpilers/src/main/scala/izumi/idealingua/translator/toscala/layout/ScalaLayouter.scala#L129

Added line #L129 was not covered by tests

val content = keys ++ projDefs ++ Seq(bundle, agg)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ object Scope {

case object Project extends Scope

case class Custom(scope: String) extends Scope
}
Loading