new format for package name already defined error (+tests)

Author: Aurélien Richez

compiler/src/dotty/tools/dotc/reporting/diagnostic/ErrorMessageID.java

@@ -112,6 +112,7 @@ public enum ErrorMessageID {
     UndefinedNamedTypeParameterID,
     IllegalStartOfStatementID,
     TraitIsExpectedID,
+    PackageNameAlreadyDefinedID
     ;
 
     public int errorNumber() {

compiler/src/dotty/tools/dotc/reporting/diagnostic/messages.scala

@@ -1916,4 +1916,12 @@ object messages {
           |"""
     }
   }
+
+  case class PackageNameAlreadyDefined(pkg: Symbol)(implicit ctx: Context) extends Message(PackageNameAlreadyDefinedID) {
+
+    override def msg: String = hl"${pkg} is already defined, cannot be a package"
+    override def kind: String = "Syntax"
+    override def explanation: String =
+      "An object cannot have the same name as an existing package. Rename ${pkg} or the package with the same name."
+  }
 }

compiler/src/dotty/tools/dotc/typer/Typer.scala

@@ -1522,7 +1522,7 @@ class Typer extends Namer with TypeAssigner with Applications with Implicits wit
       val packageContext =
         if (pkg is Package) ctx.fresh.setOwner(pkg.moduleClass).setTree(tree)
         else {
-          ctx.error(em"$pkg is already defined, cannot be a package", tree.pos)
+          ctx.error(PackageNameAlreadyDefined(pkg), tree.pos)
           ctx
         }
       val stats1 = typedStats(tree.stats, pkg.moduleClass)(packageContext)

compiler/test/dotty/tools/dotc/reporting/ErrorMessagesTests.scala

@@ -1172,4 +1172,18 @@ class ErrorMessagesTests extends ErrorMessagesTest {
       val TraitIsExpected(symbol) :: Nil = messages
       assertEquals("class B", symbol.show)
     }
+
+  @Test def packageNameAlreadyDefined =
+    checkMessagesAfter("frontend") {
+      """
+        |package bar { }
+        |object bar { }
+        |
+      """.stripMargin
+    }.expect { (ictx, messages) =>
+      implicit val ctx: Context = ictx
+
+      assertMessageCount(1, messages)
+      assert(messages.head.isInstanceOf[PackageNameAlreadyDefined])
+    }
 }