sbt 2.x (sbt in Scala 3) #6746

eed3si9n · 2021-12-13T07:31:39Z

This is a work-in-progress port to Scala 3, some of which documented as sudori:

buildfile/src/main/scala/sbt/internal/Eval.scala

julianpeeters · 2023-02-05T22:57:38Z

main/src/main/scala/sbt/internal/GlobalPlugin.scala

@@ -20,6 +20,7 @@ import sbt.internal.util.Attributed
 import Def.{ ScopedKey, Setting }
 import Keys._
 import Configurations.{ Compile, Runtime }
+import sbt.ProjectExtra.{ extract, runUnloadHooks, setProject }


With the changes to LoadBuildConfiguration, it looks like there may need to be an update to the def build method, or else global plugins fail to load, due to being passed the wrong BASE directory:

java.lang.RuntimeException: /Users/julianpeeters/.sbt/2.0.0-alpha6-SNAPSHOT/plugins/global.sbt cannot be mapped using the root paths Map( BASE -> /Users/julianpeeters/Workspace/hello-global, SBT_BOOT -> /Users/julianpeeters/.sbt/boot, IVY_HOME -> /Users/julianpeeters/.ivy2, JAVA_HOME -> /Users/julianpeeters/.sdkman/candidates/java/17.0.1-oracle )

def build(base: File, s: State, config: LoadBuildConfiguration): (BuildStructure, State) = { val newConverter = MappedFileConverter(config.converter.rootPaths2.toMap.updated("BASE", base.toPath), false) val newInject =r config.injectSettings.copy(global = config.injectSettings.global ++ globalPluginSettings) val globalConfig = config.copy( injectSettings = newInject, pluginManagement = config.pluginManagement.forGlobalPlugin, converter = newConverter )

See https://eed3si9n.com/simplifying-sbt-with-common-settings/ Problem ------- The behavior of bare settings is confusing in a multi-project build. This is partly due to the fact that to use `ThisBuild` scoping the build user needs to be aware of the task implementation, and know if the task is already defined at project level. Solution -------- This changes the interpretation of the baresettings to be common settings, which works similar to the way `ThisBuild` behaves in sbt 1.x, but since this would be a simple append at project-level, it should work for any tasks or settings.

Problem ------- In sbt 1, platform cross building is implemented using in the user-land using `%%%` operator, which clevery handles both Scala cross building and appending platform suffix like sjs1. However, in general symbolic `%%%` is confusing, and hard to explain. Solution -------- In sbt 2, we should subsume the idea of platform cross building, so `%%` can act as the current `%%%` operator. This adds a new setting called `platform`, which defaults to `Platform.jvm` by default. When a subprojects sets it to `Platform.sjs1`, `ModuleID`s defined using `%%` operator will inject the platform suffix `_sjs1` **in addition** to the Scala binary suffix `_2.13` etc. Note: Explicit JVM dependencies will now require `.platform(Platform.jvm)`.

adpi2 · 2023-10-17T11:36:41Z

util-collection/src/main/scala-2/sbt/internal/util/HList.scala

I suggest we remove those Scala 2 files if we don't need to cross-compile collectionProj anymore.

adpi2 · 2023-10-17T11:38:54Z

internal/util-logging/src/main/scala/sbt/util/LogExchange.scala

  // Construct these StringTypeTags manually, because they're used at the very startup of sbt
  // and we'll try not to initialize the universe by using the StringTypeTag.apply that requires a TypeTag
  // A better long-term solution could be to make StringTypeTag.apply a macro.
-  lazy val stringTypeTagThrowable = StringTypeTag[Throwable]("scala.Throwable")
-  lazy val stringTypeTagTraceEvent = StringTypeTag[TraceEvent]("sbt.internal.util.TraceEvent")
-  lazy val stringTypeTagSuccessEvent = StringTypeTag[SuccessEvent]("sbt.internal.util.SuccessEvent")
+  lazy val stringTypeTagThrowable = StringTypeTag.manually[Throwable]("java.lang.Throwable")
+  lazy val stringTypeTagTraceEvent =
+    StringTypeTag.manually[TraceEvent]("sbt.internal.util.TraceEvent")
+  lazy val stringTypeTagSuccessEvent =
+    StringTypeTag.manually[SuccessEvent]("sbt.internal.util.SuccessEvent")


Since StringTypeTag.apply is a macro, we don't need to initialize those manually anymore.

adpi2 · 2023-10-17T11:40:30Z

util-collection/src/main/scala/sbt/internal/util/Util.scala

-  def ignoreResult[T](f: => T): Unit = macro Macro.ignore
+  def ignoreResult[A](f: => A): Unit =
+    f; ()


Why was it a macro and it is not anymore? Should we inline it?

adpi2 · 2023-10-17T11:42:29Z

internal/util-complete/src/main/scala/sbt/internal/util/LineReader.scala

 @deprecated("Use LineReader apis", "1.4.0")
 private[sbt] object JLine {
-  @deprecated("For binary compatibility only", "1.4.0")
-  protected[this] val originalIn = new FileInputStream(FileDescriptor.in)
-


Should we remove JLine completely? It only contains deprecated methods.

adpi2 · 2023-10-17T11:44:59Z

util-collection/src/main/scala/sbt/internal/util/AList.scala

+/**
+ * Arity-generic List. An abstraction over structured Tuple/List type constructor `X1[f[a]]`.
+ */
+trait AList[K[F[_]]]:


AList on tuples was much more simpler to understand.

We do need to treat AList like a typeclass after all because
sbt.std.Transform.uniform needs to traverse over a List,
and we won't be able to magically connvert a List into a tuple.

We can use Tuple.fromArray(list.toArray) instead, if it doesn't impact the performance too much.

adpi2 · 2023-10-17T14:35:37Z

project/Scripted.scala

+
+        // bridge.runInParallel(
+        //   sourcePath,
+        //   bufferLog,
+        //   args.toArray,
+        //   launchOpts.toArray,
+        //   callback,
+        //   scalaVersion,
+        //   sbtVersion,
+        //   classpath.toArray,
+        //   instances
+        // )
        bridge.runInParallel(
          sourcePath,
          bufferLog,
          args.toArray,
+          launcherJar,
+          "java",
          launchOpts.toArray,
          callback,
-          scalaVersion,
-          sbtVersion,
-          classpath.toArray,


Do you remember the purpose of these changes?

adpi2 · 2023-10-17T14:36:48Z

build.sbt

 ThisBuild / scalafmtOnCompile := !(Global / insideCI).value
 ThisBuild / Test / scalafmtOnCompile := !(Global / insideCI).value
-ThisBuild / turbo := true
+// ThisBuild / turbo := true


Why disabling turbo mode? Does it make the tests flaky?

adpi2 · 2023-10-17T14:37:40Z

main/src/main/scala/sbt/internal/LintUnused.scala

+      pollInterval,
+      pushRemoteCacheArtifact,
+      sbt.nio.Keys.outputFileStamper,
      sbt.nio.Keys.watchTriggers,
      serverConnectionType,
      serverIdleTimeout,
      shellPrompt,
+      sLog,
+      traceLevel,


Do you have a clue why we need to add more keys to excludeLintKeys?

adpi2 · 2023-10-17T14:38:40Z

sbt-app/src/sbt-test/project1/Class.forName/build.sbt

Do you remember why you renamed project to project1?

adpi2 · 2023-10-17T14:46:22Z

core-macros/src/main/scala-2/sbt/internal/util/appmacro/LinterDSL.scala

LinterDS and TaskLinterDSL are not ported? What are they supposed to do? Should we try to port them or remove them?

eed3si9n · 2023-10-17T21:04:46Z

Many projects are configured with cross-compilation and many of them don't cross compile anymore. Do you know if there are some projects that we should keep cross-compiling? Or if we should drop cross-compilation in this branch.

We should probably drop Scala 2.x cross build.

Should we avoid using the new syntax to make it smoother to port back and from sbt 1.x

In some situations maybe, but you may have noticed I am a big fan of the new syntax, so I think we should just use Scala 3 as intended with all the bells and whistles.

eed3si9n · 2023-10-22T00:40:13Z

I'm on board with merging it now and continue working on the migration in separate PRs.

Yea. Let's merge this as-is, and I'll come back to this PR to respond to comments and todos.

eed3si9n force-pushed the wip/sbt-2.x branch from b7c42e6 to ac9e177 Compare December 20, 2021 07:01

eed3si9n force-pushed the wip/sbt-2.x branch from 5396fed to 3e9096a Compare January 23, 2022 00:37

eed3si9n force-pushed the wip/sbt-2.x branch from ee76225 to 112dba8 Compare January 31, 2022 19:15

This comment was marked as outdated.

Sign in to view

eed3si9n force-pushed the wip/sbt-2.x branch from d84224f to 98454a7 Compare August 29, 2022 04:44

eed3si9n force-pushed the wip/sbt-2.x branch 4 times, most recently from 3f47daf to ed2d460 Compare September 27, 2022 06:02

eed3si9n force-pushed the wip/sbt-2.x branch 7 times, most recently from 2f4b042 to f0c1976 Compare October 4, 2022 07:30

eed3si9n force-pushed the wip/sbt-2.x branch 14 times, most recently from 820528e to f498cb2 Compare October 11, 2022 04:59

eed3si9n force-pushed the wip/sbt-2.x branch 6 times, most recently from 9e814b4 to 8181a33 Compare January 20, 2023 18:48

def % support

9821f5e

eed3si9n force-pushed the wip/sbt-2.x branch 2 times, most recently from 2cdd136 to 25b835d Compare January 20, 2023 23:47

scripted tests

ec3eda3

eed3si9n force-pushed the wip/sbt-2.x branch from 25b835d to ec3eda3 Compare January 21, 2023 02:51

eed3si9n added 2 commits January 20, 2023 22:34

Add more keys to excludeLintKeys

a8213ab

Move the project scripted tests to project1

b456430

eed3si9n marked this pull request as ready for review January 26, 2023 20:19

eed3si9n changed the title ~~[wip] sbt 2.x~~ sbt 2.x (sbt in Scala 3) Jan 26, 2023

julianpeeters reviewed Feb 4, 2023

View reviewed changes

buildfile/src/main/scala/sbt/internal/Eval.scala Show resolved Hide resolved

julianpeeters reviewed Feb 5, 2023

View reviewed changes

eed3si9n added 2 commits March 11, 2023 17:02

Formatting

32ac1ef

eed3si9n force-pushed the wip/sbt-2.x branch from 7678bd5 to dbaa34b Compare March 11, 2023 22:02

mdedetrich mentioned this pull request May 5, 2023

Provide nicer implementation of publishLocal / skip for 2.0.x series #7170

Open

adpi2 approved these changes Oct 17, 2023 •

edited

Loading

View reviewed changes

eed3si9n merged commit 11cc8b5 into sbt:develop Oct 22, 2023

adpi2 mentioned this pull request Dec 14, 2023

sbt in Scala 3 follow-up #7462

Open

31 tasks

eed3si9n deleted the wip/sbt-2.x branch December 14, 2023 14:17

lolgab mentioned this pull request Jan 13, 2024

Scala 3 build.sc com-lihaoyi/mill#2969

Closed

adpi2 mentioned this pull request Feb 6, 2024

[sbt 2] Remove usage of Manifest in Structure.scala #7490

Merged

sbt 2.x (sbt in Scala 3) #6746

sbt 2.x (sbt in Scala 3) #6746

Uh oh!

Conversation

eed3si9n commented Dec 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eed3si9n commented Oct 17, 2023

Uh oh!

eed3si9n commented Oct 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

eed3si9n commented Dec 13, 2021 •

edited

Loading