chore: add Debug.scala (zio#1327)

build.sbt

@@ -5,7 +5,7 @@ import sbt.librarymanagement.ScalaArtifacts.isScala3
 val releaseDrafterVersion = "5"
 
 // Setting default log level to INFO
-val _ = sys.props += ("ZHttpLogLevel" -> ZHttpLogLevel)
+val _ = sys.props += ("ZHttpLogLevel" -> Debug.ZHttpLogLevel)
 
 // CI Configuration
 ThisBuild / githubWorkflowJavaVersions := Seq(JavaSpec.graalvm("21.1.0", "11"), JavaSpec.temurin("8"))
@@ -139,6 +139,6 @@ lazy val zhttpLogging = (project in file("zio-http-logging"))
 lazy val example = (project in file("./example"))
  .settings(stdSettings("example"))
  .settings(publishSetting(false))
- .settings(runSettings("example.HelloWorld"))
+ .settings(runSettings(Debug.Main))
  .settings(libraryDependencies ++= Seq(`jwt-core`))
  .dependsOn(zhttp)

project/BuildHelper.scala

@@ -10,8 +10,6 @@ object BuildHelper extends ScalaSettings {
  val ScoverageVersion = "1.9.3"
  val JmhVersion = "0.4.3"
 
- val ZHttpLogLevel = "INFO"
-
  private val stdOptions = Seq(
  "-deprecation",
  "-encoding",
@@ -66,7 +64,7 @@ object BuildHelper extends ScalaSettings {
  Test / parallelExecution := true,
  incOptions ~= (_.withLogRecompileOnMacro(false)),
  autoAPIMappings := true,
- ThisBuild / javaOptions := Seq("-Dio.netty.leakDetectionLevel=paranoid", s"-DZHttpLogLevel=${ZHttpLogLevel}"),
+ ThisBuild / javaOptions := Seq("-Dio.netty.leakDetectionLevel=paranoid", s"-DZHttpLogLevel=${Debug.ZHttpLogLevel}"),
  ThisBuild / fork := true,
  )
 

project/Debug.scala

@@ -0,0 +1,20 @@
+/**
+ * Contains a list of configurations to play around with while debugging the
+ * internals of ZIO Http.
+ */
+object Debug {
+
+ /**
+ * Sets the global log level for ZIO Http. NOTE: A clean build will be
+ * required once this is changed. After which you can run the compiler in
+ * watch mode.
+ *
+ * Possible Values: DEBUG, ERROR, INFO, TRACE, WARN
+ */
+ val ZHttpLogLevel = "INFO"
+
+ /**
+ * Sets the main application to execute in the example project.
+ */
+ val Main = "example.WebSocketAdvanced"
+}