step4を加筆

Author: shinharad

build.sbt

@@ -2,9 +2,6 @@ ThisBuild / scalaVersion := "3.0.0-RC1"
 ThisBuild / version      := "0.0.1-SNAPSHOT"
 
 ThisBuild / scalacOptions ++= Seq(
-  "-explain",
-  "-explain-types"
-
   // TODO
 )
 
@@ -52,14 +49,19 @@ lazy val step04 =
     .settings(commonSettings)
     .settings(
       scalacOptions ++= Seq(
+        // Scala 3.0 Migration mode
+
         // 以下のコンパイラオプションを有効にすることで、
-        // MigrationMode.scala のエラーが警告になったり、自動的に書き換わります
+        // Scala 2.13 と Scala 3.0 の非互換性に関する詳細なエラーを表示したり、
+        // コードが自動的に書き換わります
+
+        // 以下を有効にすると詳細なエラーが表示されます
+        // "-explain",
 
-        // このコメントアウトを外すと、
-        // マイグレーションモードとして Scala3 でのコンパイルエラーが警告に変わります
+        // 以下を有効にすると、非互換性のエラーが警告に変わります
         // "-source:3.0-migration"
 
-        // このコメントアウトを外すと、MigrationMode.scala が書き換わります
+        // 以下を有効にすると、非互換性の警告箇所が自動的に書き換わります
         // "-source:3.0-migration", "-rewrite"
       )
     )

docs/README.md

@@ -16,7 +16,8 @@ Enums や Algebraic Data Types (ADTs) で新しいシンタックスが追加さ
 
 ### Step4
 
-Scala2 と Scala3 の互換性で、モジュール間の依存関係や移行ツール、マイグレーションモードについて触れていきます。
+Step4 では、主に Scala2 と Scala3 の互換性・非互換性について取り上げます。ソースコードレベルやコンパイルタイム、ランタイム、メタプログラミング、モジュール間でどのような互換性・非互換性があるかを確認し、非互換性に対してどのようなツールを使用して Scala3 へ移行するのかを確認します。
+
 
 ### Step5
 

docs/step01/04_Migration_guideを俯瞰してみる.md

@@ -61,16 +61,14 @@ https://scalacenter.github.io/scala-3-migration-guide/docs/tutorials/sbt-migrati
 
 https://scalacenter.github.io/scala-3-migration-guide/docs/incompatibilities/table.html
 
-Reference と内容が重複してるので今回は対象外とします。
-
 ```plantuml
 @startmindmap
 * Incompatibilities
 **[#38c0c4] Incompatibility Table
-** Syntactic Changes
-** Dropped Features
+**[#38c0c4] Syntactic Changes
+**[#38c0c4] Dropped Features
 ** Contextual Abstractions
-** Other Changed Features
+**[#38c0c4] Other Changed Features
 @endmindmap
 ```
 

docs/step04/01_CompatibilityReference.md

@@ -22,7 +22,7 @@
 
 ## 概要
 
-Scala 2.13 と Scala 3.0 の互換性について、Source Level、Compile Time、Runtime、Metaprogramming の観点で確認します。また、それぞれのバージョンの依存関係についても、公式ドキュメントに分かりやすい例が記載されているので見ていきたいと思います。
+Scala 2.13 と Scala 3.0 の互換性について、Source Level、Compile Time、Runtime、Metaprogramming の観点で確認します。また、それぞれのバージョンの依存関係についても、公式ドキュメントに分かりやすい例が記載されているので併せて見ていきたいと思います。
 
 ## ドキュメント参照先
 
@@ -37,16 +37,16 @@ Scala 2.13 と Scala 3.0 の互換性について、Source Level、Compile Time
 - いくつかの構文は単純化されたり、制限されたり、完全に削除されたりしている
 - これらの決定は正当な理由があってなされたものであり、適切な回避策が可能であることを考慮されたもの
 - いずれにしても、すべての非互換性に対応したクロスコンパイルソリューションがあるため、移行は簡単かつスムーズに行える
-  - 非互換性については、この後の Incompatibility Table で確認します
-- Scala 2.13 のソースコードは、マイグレーションモードや各種ツールを使うことで、Scala3 のソースコードへ簡単に変換することができる
+  - 非互換性については、この後の Incompatibility Table で確認する
+- Scala 2.13 のソースコードは、Scala 3 Migration Mode や各種ツールを使うことで、Scala3 のソースコードへ簡単に変換することができる
 
 ## Compile Time
 
 - コンパイラが、型やメソッドのシグネチャなどの情報をクラスファイルから読み取る際のフォーマットが、Scala2 と Scala3 で異なる
   - Scala2 では、シグネチャは Pickle format で格納されている
   - Scala3 では、シグネチャのレイアウトよりも多くの機能を持つ TASTy format で格納されている
 - Scala3 コンパイラは、Scala 2.13 の Pickle format と TASTy format の両方を読み取ることができる
-- Scala 2.13.4 では、Scala 3.0 ライブラリの利用を可能にする TASTy reader が追加されていて、従来のすべての機能に加え、以下の新機能もサポートする
+- Scala 2.13.4 では、Scala 3.0 ライブラリの利用を可能にする TASTy reader が追加されていて、従来のすべての機能に加え、以下の新機能もサポートしている
   - Enums
   - Intersection types
   - Higher-kinded type lambdas
@@ -62,7 +62,7 @@ Scala 2.13 と Scala 3.0 の互換性について、Source Level、Compile Time
   (Scala 2.13.4)-->(Scala 2.13.4 アーティファクト)
   ```
 
-**:warning: TASTy reader は、Scala3 のすべての機能をサポートしているわけではないので、注意が必要**
+**:warning: TASTy reader は、Scala3 のすべての機能をサポートしているわけではないので注意が必要**
 
 
 ## Runtime

docs/step04/02_TourOfTheMigrationTools.md

@@ -30,8 +30,8 @@ Scala 2.13 から Scala 3.0 への移行をサポートするいくつかのツ
 ## The Scala 3 compiler
 
 - Scala3 コンパイラ自体が強力な移行ツールとなっている
-- Scala 2.13 のコードをコンパイルするのに最適なマイグレーションモードを備えていて、必要に応じてコードを書き換えてくれる
-  - 詳細は、次の Scala 3 Migration Mode で確認します
+- Scala 3 Migration Mode を備えていて、必要に応じて Scala 2.13 のコードを Scala3 のコードへ書き換えてくれる
+  - 詳細は、この後の Scala 3 Migration Mode で確認する
 - このツールを使用して、コミュニティではすでにかなりの数のライブラリが移行されている
   - [Scala 3 Community Build](https://github.com/lampepfl/dotty/tree/master/community-build/community-projects)
 

docs/step04/03_Scala3MigrationMode.md

@@ -15,7 +15,7 @@
 
 ## 概要
 
-Scala 2.13 のコードベースを Scala 3.0 へ移植していく際のマイグレーションモードについて確認しましょう。
+Scala 2.13 のコードベースを Scala 3.0 へ移行していく際の Migration Mode について確認しましょう。
 
 ## ドキュメント参照先
 
@@ -32,15 +32,13 @@ Scala 2.13 のコードベースを Scala 3.0 へ移植していく際のマイ
 ## Automatic rewrites
 
 - Migration Mode の `-source:3.0-migration` と `-rewrite` オプションを指定してコンパイルすると、ほとんどすべての警告はコンパイラによって自動的に解決してくれる
-- `-rewrite` は、Step1 で確認したとおり、コードを自動的に書き換えてくれる機能
+- `-rewrite` は、Step1 で確認したとおり、コードを自動的に書き換えてくれるコンパイラオプション
 - Migration Mode でコンパイルエラーになった場合は、`-rewrite` が適用されない
 
-:bulb: 本リポジトリの step04 プロジェクトでは、Scala3 で予約語となっている `given` や `enum` をクラス名や変数名にしていた場合に、どのような警告が表示され、どのように書き換えられるかを試すことができます。
-
 ## Error explanations
 
 - Migration Modeの `-source:3.0-migration` は、すべての機能を処理できるわけではなくて、場合によっては、 Scala 2.13 と Scala 3.0 の非互換性のためにエラーが残ることもある
-- この場合は、`-source:3.0-migration` を `-explain` や `-explain-types` と組み合わせて指定することで、エラーの詳細を知ることができる
+- その場合は、`-source:3.0-migration` を `-explain` や `-explain-types` と組み合わせて指定することで、エラーの詳細を知ることができる
   - `-explain` : エラーの詳細を表示する
   - `-explain-types` 型エラーを詳細に表示する
-- `-explain` や `-explain-types` は、移行モードに限定されるものではなくて、Scala3 の学習やコーディングを支援してくれる
+- `-explain` や `-explain-types` は、移行モードに限定されるものではなくて、Scala3 の学習やコーディングを支援してくれるコンパイラオプション

docs/step04/04_IncompatibilityTable.md

@@ -1,28 +1,50 @@
-# IncompatibilityTable {ignore=true}
+# Incompatibility Table {ignore=true}
 
 <!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
 
 <!-- code_chunk_output -->
 
 - [概要](#概要)
 - [ドキュメント参照先](#ドキュメント参照先)
-- [Incompatibility Table](#incompatibility-table)
+- [Incompatibility Table](#incompatibility-table-1)
 
 <!-- /code_chunk_output -->
 
 ## 概要
 
-*** TO BE FILLED IN ***
+最後に Scala 2.13 と Scala 3.0 との非互換性について確認しましょう。
 
+ここで言う非互換性とは、Scala 2.13 ではコンパイルできても Scala 3.0 ではコンパイルできないコードのことを指します。コードベースを Scala 2.13 から Scala 3.0 へ移行するには、ソースコードの非互換性をすべて見つけ出して修正する必要があります。
 
 ## ドキュメント参照先
 
 [Scala 3 Migration guide](https://scalacenter.github.io/scala-3-migration-guide/) からこちらを参照します。
 
 - [Incompatibility Table](https://scalacenter.github.io/scala-3-migration-guide/docs/incompatibilities/table.html)
 
+補足としてこちらも参照します。
+
+- [Syntactic Changes](https://scalacenter.github.io/scala-3-migration-guide/docs/incompatibilities/syntactic-changes.html)
+- [Dropped Features](https://scalacenter.github.io/scala-3-migration-guide/docs/incompatibilities/dropped-features.html)
+- [Other Changed Features](https://scalacenter.github.io/scala-3-migration-guide/docs/incompatibilities/other-changed-features.html)
+
 ## Incompatibility Table
 
 https://scalacenter.github.io/scala-3-migration-guide/docs/incompatibilities/table.html
 
-*** TO BE FILLED IN ***
+Incompatibility Table は、Scala 2.13 と Scala 3.0 のそれぞれの非互換性について、どのような移行方法があるのかがまとめられています。
+
+観点としては、
+
+- Scala 2.13 で Deprecation だったかどうか
+- Scala 3.0 Migration Mode で自動的に書き換えられるか
+- Scalafix Rule で検出できるか
+
+また、まれに Scala 2.13 と Scala 3.0 で実行時の非互換性が発生することもあるので注意が必要です。
+
+---
+
+ここからは、Incompatibility Table をざっと眺めながら、Scala 3.0 Migration Mode の rewrite を実際に動かしてみたいと思います。
+
+本リポジトリの step04 のプロジェクトには、非互換なソースコードがコメントアウトの状態で書いてあります。それらのコメントアウトを一つずつ外し、`build.sbt` のコンパイラオプションを切り替えることで、エラーが警告になったり、rewrite が発動したりを確認することができます。
+

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/01_syntacticChanges/01_RestrictedKeywords.scala

@@ -0,0 +1,27 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `01_syntacticChange`
+package `01_restrictedKeywords`
+
+// Scala 3.0 Migration mode の動作確認をします
+// 以下のコメントアウトを外して、
+// build.sbt の step04 の scalacOptions の設定を変えてみてください
+
+//---
+// scalacOptions の以下を順番に有効にしてみてください
+// - "-explain"
+// - "-source:3.0-migration"
+// - "-source:3.0-migration", "-rewrite"
+
+// object given {
+//   val enum = ???
+//   println(enum)
+// }
+
+//---
+// scalacOptions の以下を有効にしてみてください
+// - "-explain"
+// （これに関してはマイグレーションモードが効かないらしい）
+
+// def then(): Unit = ()
+
+object Dummy

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/01_syntacticChanges/02_ProcedureSyntax.scala

@@ -0,0 +1,21 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `01_syntacticChange`
+package `02_procedureSyntax`
+
+//---
+// scalacOptions の以下を順番に有効にしてみてください
+// - "-explain"
+// - "-source:3.0-migration"
+// - "-source:3.0-migration", "-rewrite"
+
+// trait Foo {
+//   def print()
+// }
+
+// object Bar {
+//   def print() {
+//     println("bar")
+//   }
+// }
+
+object Dummy

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/01_syntacticChanges/03_ParenthesesAroundLambdaParameter.scala

@@ -0,0 +1,12 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `01_syntacticChange`
+package `03_parenthesesAroundLambdaParameter`
+
+//---
+// scalacOptions の以下を順番に有効にしてみてください
+// - "-source:3.0-migration"
+// - "-source:3.0-migration", "-rewrite"
+
+// val f = { x: Int => x * x }
+
+object Dummy

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/01_syntacticChanges/04_OpenBraceIndentationForPassingAnArgument.scala

@@ -0,0 +1,31 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `01_syntacticChange`
+package `04_openBraceIndentationForPassingAnArgument`
+
+def test(name: String)(f: => Unit) = ???
+
+//---
+// scalacOptions の以下を順番に有効にしてみてください
+// - "-explain"
+// - "-source:3.0-migration"
+
+// Scala2 では、改行後の引数を中括弧で囲めるが推奨されていない
+// Scala3 では警告が表示される
+// def no1(): Unit =
+//   test("my test")
+//   {
+//     assert(1 == 1)
+//   }
+
+// Scala2 では、このように書くのが正しい
+def no2(): Unit =
+  test("my test") {
+    assert(1 == 1)
+  }
+
+// no1 を Scala3 で敢えて書くならこう書くのが正しい
+def no3(): Unit =
+  test("my test")
+    {
+    assert(1 == 1)
+  }

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/01_syntacticChanges/05_WrongIndentation.scala

@@ -0,0 +1,29 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `01_syntacticChange`
+package `05_wrongIndentation`
+
+// 以下のコメントアウトしているコードは、Scala2 ではコンパイルが通るが、
+// Scala3 ではインデントが間違ってるのでコンパイルが通らない
+// この場合は、scalafmt などでコードフォーマットする必要がある
+
+// val foo_wrong =
+//     Vector(1) ++
+//   Vector(2) ++
+//     Vector(3)
+
+// def bar_wrong: (Int, Int) = {
+//   val foo = 1.0
+//   val bar = foo
+//     (1, 1)
+// }
+
+val foo =
+  Vector(1) ++
+  Vector(2) ++
+  Vector(3)
+
+def bar: (Int, Int) = {
+  val foo = 1.0
+  val bar = foo
+  (1, 1)
+}

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/01_syntacticChanges/06__AsATypeParameter.scala

@@ -0,0 +1,17 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `01_syntacticChange`
+package `06__AsATypeParameter`
+
+trait Foo[T]
+
+// Scala2 では、これはコンパイルが通る
+// def foo[_: Foo]: Unit = ???
+
+// これは、fooというメソッドの型パラメータ `_` に Context Bound として `trait Foo[_]` を指定したものだが、
+// このような書き方は、Scala コンパイラのバグを巧みに利用したもので、想定外な使われ方だったため、Scala3 では廃止された
+// 
+// 参考)
+// https://www.reddit.com/r/scala/comments/fczcvo/mysterious_context_bounds_in_fastparse_2/fjecokn/
+
+// Scala3 からは型パラメータを明示する
+def foo[T: Foo]: Unit = ???

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/01_syntacticChanges/07_+and-AsTypeParameter.scala

@@ -0,0 +1,14 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `01_syntacticChange`
+package `07_+and-AsTypeParameter`
+
+// Scala2 では、型パラメータに `+` や `-` を指定してもコンパイルが通ったが、Scala3 ではエラーになる
+// def foo[+]: Unit = ???
+// def foo[-]: Unit = ???
+
+// Scala3 ではこのようにする
+def foo[T]: Unit = ???
+
+// ただし、型の識別子としての `+` や `-` はまだ有効
+type + = String
+type - = Int

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/02_droppedFeatures/01_SymbolLiterals.scala

@@ -0,0 +1,15 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `02_droppedFeatures`
+package `01_SymbolLiterals`
+
+//---
+// scalacOptions の以下を順番に有効にしてみてください
+// - "-explain"
+// - "-source:3.0-migration"
+// - "-source:3.0-migration", "-rewrite"
+
+// val values: Map[Symbol, Int] = Map('abc -> 1)
+
+// val abc = values('abc)
+
+object Dummy

step04/src/main/scala/com/github/shinharad/gettingStartedWithScala3/02_droppedFeatures/02_DoWhileConstruct.scala

@@ -0,0 +1,17 @@
+package com.github.shinharad.gettingStartedWithScala3
+package `02_droppedFeatures`
+package `02_DoWhileConstruct`
+
+//---
+// scalacOptions の以下を順番に有効にしてみてください
+// - "-source:3.0-migration"
+// - "-source:3.0-migration", "-rewrite"
+
+def no1(): Unit = {
+  def f(i: Int): Int = ???
+  var i = 1
+
+  // do {
+  //   i += 1
+  // } while (f(i) == 0)
+}