Skip to main content

Validate Ident Prefix

If you are building with sbt, add the following to your build.sbt:

autoCompilerPlugins := true
addCompilerPlugin("org.bitlap" %% "rolls-compiler-plugin" % "<version>")

lazy val reader = scala.io.Source.fromFile("config.properties")
lazy val config = {
  val ret = reader.getLines().toList.map(p => s"-P:RollsCompilerPlugin:$p")
  reader.close()
  ret
}

scalacOptions ++= config

Add the following properties to config.properties:

# Multiple annotations split by '|'
# Why is '|' ?, see https://github.com/lampepfl/dotty/pull/17448#event-9286210944
validateIdentPrefix=caliban.schema.Annotations.GQLDescription
validateShouldStartsWith=star

What will be verified ?​

  • Validate parameter name within primary constructor:
    • when parameter type is a case class or function type and has annotations.
    • annotations can be on parameter or parameter type.
  • Validate case class name (use .capitalize to validate case classes):
    • when primary constructor or type constructor has annotations.
    • when parameter type is function type or case class and has annotations.
import caliban.schema.Annotations.GQLDescription

final case class StarDictInput(
  @GQLDescription("dictName")
  dictName: Option[String],
  @GQLDescription("dictCode")
  dictCode: Option[String],
  @GQLDescription("starDictPayload")
  starDictPayload: StarDictPayload,
  @GQLDescription("dictFunction")
  dictFunction: String => StarDictPayload
)

final case class StarDictPayload(
  @GQLDescription("id")
  id: Option[String],
  @GQLDescription("name")
  name: Option[String]
)

The above code will provide compiler error:

parameter names of the primary constructor don't startsWith star in StarDictInput
Expected: starDictFunction 
Actual: dictFunction

  final case class StarDictInput(

Because dictFunction does not startsWith star