sbt 0.13.8下consoleProject的initialCommands导入失效问题排查

这个问题是sbt 0.13.8版本的consoleProject任务对initialCommands的处理逻辑bug，结合Scala 2.10 REPL的编译机制共同导致的，具体逻辑链如下：

• sbt 0.13.8在启动consoleProject时，会把内置默认初始化代码、用户自定义的initialCommands内容拼接后提交给Scala 2.10 REPL。为了避免用户自定义的临时变量和内置初始化代码产生命名冲突，sbt会对提交的代码做块级作用域拆分：将单行的import语句单独包裹在独立的临时块中执行，将def、val等全局定义类代码保留在REPL的全局作用域中。
• 这种拆分逻辑直接割裂了导入语句的作用域：import scala.sys.process._执行完、临时块销毁后，它引入的为String类型提供#<方法的String到ProcessBuilder的隐式转换，会随着块的作用域消失而失效。后续全局作用域中定义的def less因为找不到这个隐式转换，自然会报“value #< is not a member of String”的错误。
• 这个逻辑也能完全匹配观察到的两个额外现象：
  • 如果把import的包名写错成无效路径，sbt还是会在那个独立的临时块中解析这个import语句，所以会正常报包不存在的编译错误，不会完全忽略import本身。
  • 手动逐行在REPL中输入时，每一行是独立的编译单元，REPL会将import的内容纳入后续所有编译单元的继承作用域中，不会做块级隔离，所以隐式转换可以正常被def的定义访问到。

针对这个作用域割裂的bug，不需要升级sbt版本也可以快速修复，常见的有效方案有以下几种：

• 移除隐式转换依赖，把import移到方法体内部
  最推荐的修复方式是把import scala.sys.process._语句从类级别移到less方法的方法体内部，绕开sbt对独立import行的块级隔离逻辑。修改后的配置代码如下：

  lazy val consoleSupportSettings: Seq[Setting[_]] = Seq(
    initialCommands in consoleProject := """
      |def less(s: String) = {
      |  import scala.sys.process._
      |  val codeCommand = scala.sys.process.Process("code -")
      |  (codeCommand #< new java.io.ByteArrayInputStream(s.getBytes)).!!
      |}
    """.stripMargin
  )
  

  这种写法下import语句属于def方法体的内部作用域，编译def的表达式时隐式转换可以正常生效，方法本身会保留在REPL的全局作用域中，进入consoleProject后可以直接调用。
• 把所有代码包裹在同一个大括号块中
  把import语句和def定义用大括号包裹成同一个独立代码块，让sbt的拆分逻辑把整个块作为一个整体处理，不会把import单独隔离：

  lazy val consoleSupportSettings: Seq[Setting[_]] = Seq(
    initialCommands in consoleProject := """
      |{
      |  import scala.sys.process._
      |  def less(s: String) = ("code -" #< new java.io.ByteArrayInputStream(s.getBytes)).!!
      |}
    """.stripMargin
  )
  

  注意这种写法定义的less方法会随着代码块的销毁消失，无法在整个consoleProject会话中全局调用，仅适合一次性执行的初始化逻辑。
• 升级sbt版本从根源规避bug
  sbt从0.13.13版本开始修复了consoleProject对initialCommands的块级隔离逻辑：所有用户自定义的initialCommands内容会被作为一个整体纳入REPL的全局作用域类，不会单独拆分import语句的作用域。升级sbt到0.13.13及以上版本后，原本编写的initialCommands代码就可以正常运行。

内容的提问来源于stack exchange，提问作者phdoerfler