Implement API for errors

Co-Authored-By: Jamie Thompson <[email protected]>

Author: anatoliykmetyuk

library/src/scala/compiletime/testing/Error.scala

@@ -0,0 +1,12 @@
+package scala.compiletime.testing
+
+/** Represents a compile-time error.
+ *
+ *  @see scala.compiletime.testing.typeCheckErrors
+ *
+ *  IMPORTANT: No stability guarantees are provided on the format of these
+ *  errors. This means the format and the API may change from
+ *  version to version. This API is to be used for testing purposes
+ *  only.
+ */
+final case class Error(message: String, lineContent: String, column: Int, kind: ErrorKind)

library/src/scala/compiletime/testing/ErrorKind.scala

@@ -0,0 +1,7 @@
+package scala.compiletime.testing
+
+/** An error can be either a parse-time or a typecheck-time */
+sealed trait ErrorKind  // TODO make this enum, so far not doable because ScalaJS compilation fails on it
+object ErrorKind
+  case object Parser extends ErrorKind
+  case object Typer extends ErrorKind

library/src/scala/compiletime/testing/package.scala

@@ -1,7 +1,5 @@
 package scala.compiletime
 
-import scala.quoted._
-
 package object testing {
 
   /** Whether the code type checks in the current context?
@@ -15,4 +13,20 @@ package object testing {
   inline def typeChecks(inline code: String): Boolean =
     error("`typeChecks` was not checked by the compiler")
 
+  /** Whether the code type checks in the current context? If not,
+   *  returns a list of errors encountered on compilation.
+   *  IMPORTANT: No stability guarantees are provided on the format of these
+   *  errors. This means the format and the API may change from
+   *  version to version. This API is to be used for testing purposes
+   *  only.
+   *
+   *  @param code The code to be type checked
+   *
+   *  @return a list of errors encountered during parsing and typechecking.
+   *
+   *  The code should be a sequence of expressions or statements that may appear in a block.
+   */
+  inline def typeCheckErrors(inline code: String): List[Error] =
+    error("`typeCheckErrors` was not checked by the compiler")
+
 }