Add-scalafix (#15)

* ➕ add scalafix plugin

* 🔧 Enabled semanticDb for scalafix.

* 🔧 removedUnused not supported in Scala 3.3.1

* 🎨 Ran OrganizeImports via Scalafix

* 📝 Added instructions for scalafix

* ♻️ Remove unused imports in some files.

* ♻️ Refactored build.sbt

* 👷 Added more settings to build.sbt

* 👷 Run organiseImports check in github workflow

* 👷 Added distribution value for java

* 👷 Added zulu java distrobution

* 👷 Replaced jvm with java-version

* 👷 Fixed scalafix rule for the check

* 🧪 Ensure scalafix is enforced

* 👷 Add --check flag to scalafix workflow

* 👷 Ran OrganizeImports so workfow check will pass

* 👷 Try to switch to scalafmt

* 🚚 Moved tests to folder that sbt checks

* ➕ Added test dependency

* 👷 Switched to sbt for running tests

* ➕ add scalafmt plugin

* 🎨

* 👷 Try workflow without extra java setup step.

* 👷 Removed quotes for sbt test command.

---------

Co-authored-by: ff137 <[email protected]>

.github/workflows/ci.yml

@@ -34,7 +34,8 @@ jobs:
         with:
           jvm: 21
       - run: scala-cli fmt --check .
-      - run: scala-cli --power test .
+      - run: sbt test
+      - run: sbt "scalafix --check OrganizeImports"
 
   build:
     name: Build and push Docker

.scalafix.conf

@@ -0,0 +1 @@
+OrganizeImports.removeUnused = false

README.md

@@ -62,3 +62,7 @@ docker run -it --rm \
   -e OPENAI_TOKEN='oai_key' \
   ghcr.io/didx-xyz/dawn-patrol
 ```
+
+## Scalafix
+
+To organise imports, while in sbt run: scalafix OrganizeImports

build.sbt

@@ -1,37 +1,61 @@
 scalaVersion := "3.3.1"
 
-scalacOptions ++= Seq("-Xmax-inlines", "50")
+lazy val circeVersion       = "0.14.6"
+lazy val pureconfigVersion  = "0.17.4"
+lazy val redis4CatsVersion  = "1.5.2"
+lazy val sttpClient3Version = "3.9.1"
+lazy val langchain4jVersion = "0.23.0"
+lazy val xefVersion         = "0.0.3"
 
-val circeVersion       = "0.14.6"
-val pureconfigVersion  = "0.17.4"
-val redis4CatsVersion  = "1.5.2"
-val sttpClient3Version = "3.9.1"
-val langchain4jVersion = "0.23.0"
-val xefVersion         = "0.0.3"
+lazy val root = (project in file("."))
+  .settings(
+    settings,
+    libraryDependencies ++= Seq(
+      "io.circe"                      %% "circe-core"                     % circeVersion,
+      "io.circe"                      %% "circe-parser"                   % circeVersion,
+      "io.circe"                      %% "circe-generic"                  % circeVersion,
+      "com.github.pureconfig"         %% "pureconfig-core"                % pureconfigVersion,
+      "com.github.pureconfig"         %% "pureconfig-cats-effect"         % pureconfigVersion,
+      "dev.profunktor"                %% "redis4cats-effects"             % redis4CatsVersion,
+      "dev.profunktor"                %% "redis4cats-log4cats"            % redis4CatsVersion,
+      "com.softwaremill.sttp.client4" %% "core"                           % "4.0.0-M6",
+      "com.softwaremill.sttp.client3" %% "core"                           % sttpClient3Version,
+      "com.softwaremill.sttp.client3" %% "circe"                          % sttpClient3Version,
+      "com.softwaremill.sttp.client3" %% "async-http-client-backend-cats" % sttpClient3Version,
+      "de.brendamour"                  % "jpasskit"                       % "0.3.3",
+      "com.outr"                      %% "scribe"                         % "3.12.2",
+      "com.lihaoyi"                   %% "upickle"                        % "3.1.3",
+      "dev.langchain4j"                % "langchain4j"                    % langchain4jVersion,
+      "dev.langchain4j"                % "langchain4j-hugging-face"       % langchain4jVersion,
+      "com.xebia"                     %% "xef-scala"                      % xefVersion,
+      "com.xebia"                      % "xef-pdf"                        % xefVersion,
+      "com.xebia"                      % "xef-reasoning-jvm"              % xefVersion,
+      "com.xebia"                      % "xef-openai"                     % xefVersion,
+      "ch.qos.logback"                 % "logback-classic"                % "1.4.11",
+      "org.apache.logging.log4j"       % "log4j-core"                     % "2.21.1",
+      "org.typelevel"                 %% "log4cats-slf4j"                 % "2.6.0",
+      "co.fs2"                        %% "fs2-core"                       % "3.9.3",
+      "org.typelevel"                 %% "munit-cats-effect"              % "2.0.0-M4" % "test"
+    )
+  )
 
-libraryDependencies ++= Seq(
-  "io.circe"                      %% "circe-core"                     % circeVersion,
-  "io.circe"                      %% "circe-parser"                   % circeVersion,
-  "io.circe"                      %% "circe-generic"                  % circeVersion,
-  "com.github.pureconfig"         %% "pureconfig-core"                % pureconfigVersion,
-  "com.github.pureconfig"         %% "pureconfig-cats-effect"         % pureconfigVersion,
-  "dev.profunktor"                %% "redis4cats-effects"             % redis4CatsVersion,
-  "dev.profunktor"                %% "redis4cats-log4cats"            % redis4CatsVersion,
-  "com.softwaremill.sttp.client4" %% "core"                           % "4.0.0-M6",
-  "com.softwaremill.sttp.client3" %% "core"                           % sttpClient3Version,
-  "com.softwaremill.sttp.client3" %% "circe"                          % sttpClient3Version,
-  "com.softwaremill.sttp.client3" %% "async-http-client-backend-cats" % sttpClient3Version,
-  "de.brendamour"                  % "jpasskit"                       % "0.3.3",
-  "com.outr"                      %% "scribe"                         % "3.12.2",
-  "com.lihaoyi"                   %% "upickle"                        % "3.1.3",
-  "dev.langchain4j"                % "langchain4j"                    % langchain4jVersion,
-  "dev.langchain4j"                % "langchain4j-hugging-face"       % langchain4jVersion,
-  "com.xebia"                     %% "xef-scala"                      % xefVersion,
-  "com.xebia"                      % "xef-pdf"                        % xefVersion,
-  "com.xebia"                      % "xef-reasoning-jvm"              % xefVersion,
-  "com.xebia"                      % "xef-openai"                     % xefVersion,
-  "ch.qos.logback"                 % "logback-classic"                % "1.4.11",
-  "org.apache.logging.log4j"       % "log4j-core"                     % "2.21.1",
-  "org.typelevel"                 %% "log4cats-slf4j"                 % "2.6.0",
-  "co.fs2"                        %% "fs2-core"                       % "3.9.3"
+// Settings
+lazy val compilerOptions = Seq(
+  "-Xmax-inlines",
+  "50",
+  "-unchecked",                    // Enable additional warnings where generated code depends on assumptions.
+  "-feature",                      // Emit warning and location for usages of features that should be imported explicitly.
+  "-language:existentials",        // Existential types (besides wildcard types) can be written and inferred
+  "-language:higherKinds",         // Allow higher-kinded types
+  "-language:implicitConversions", // Allow definition of implicit functions called views
+  "-language:postfixOps",          // Allow postfix operator notation, such as 1 to 10 toList (not recommended)
+  "-deprecation"
 )
+
+lazy val commonSettings = Seq(
+  scalacOptions ++= compilerOptions
+)
+
+lazy val scalafixSettings = Seq(semanticdbEnabled := true)
+
+lazy val settings = commonSettings ++ scalafixSettings

project/plugins.sbt

@@ -0,0 +1,3 @@
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.2")
+
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.11.1")

src/main/scala/xyz/didx/ConversationPollingHandler.scala

@@ -1,38 +1,29 @@
 package xyz.didx
 
-import scala.collection.mutable
-//import io.circe._
+import cats.data.EitherT
+import cats.effect.FiberIO
+import cats.effect.IO
+import cats.effect.Ref
+import cats.implicits.*
 import io.circe.parser.*
 import io.circe.syntax.*
 import org.typelevel.log4cats.Logger
-import org.typelevel.log4cats.slf4j.Slf4jLogger
 import sttp.client3.SttpBackend
+import xyz.didx.ai.AiHandler
+import xyz.didx.ai.model.ChatState
 import xyz.didx.config.ConfigReaders.*
-import xyz.didx.logging.LogWriter.*
 import xyz.didx.didcomm.*
+import xyz.didx.logging.LogWriter.*
+import xyz.didx.messages.*
+import xyz.didx.passkit.PasskitAgent
+import xyz.didx.registry.*
+import xyz.didx.signal.SignalBot
 
 import java.net.URI
-import xyz.didx.signal.SignalBot
-import cats.effect.kernel.Resource
-import xyz.didx.connection.RedisStorage
-import xyz.didx.messages.*
-import cats.data.EitherT
-import cats.effect.IO
-import cats.implicits.*
-import cats.syntax.traverse.*
+import scala.collection.mutable
 
 import SignalMessageCodec.memberDecoder
-import xyz.didx.registry.*
 import RegistryResponseCodec.encodeRegistryRequest
-import xyz.didx.didcomm.Service
-import xyz.didx.didcomm.ServiceEndpointNodes
-import xyz.didx.registry.RegistryClient
-import xyz.didx.openai.OpenAIAgent
-import xyz.didx.passkit.PasskitAgent
-import xyz.didx.ai.AiHandler
-import xyz.didx.ai.model.ChatState
-import cats.effect.Ref
-import cats.effect.FiberIO
 
 class ConversationPollingHandler(using logger: Logger[IO]):
   val appConf      = getConf(using logger)

src/main/scala/xyz/didx/DawnPatrol.scala

@@ -1,19 +1,17 @@
 package xyz.didx
-import cats.effect.*
-import cats.effect.IOApp
-import org.typelevel.log4cats.Logger
-import org.typelevel.log4cats.slf4j.Slf4jLogger
+
 import cats.effect.IO
+import cats.effect.IOApp
 import cats.effect.std.Dispatcher
 import fs2.Stream
-
-import scala.concurrent.duration.*
-
-import xyz.didx.ConversationPollingHandler
-import sttp.client3.asynchttpclient.cats.AsyncHttpClientCatsBackend
+import org.typelevel.log4cats.Logger
+import org.typelevel.log4cats.slf4j.Slf4jLogger
 import sttp.client3.SttpBackend
-import xyz.didx.config.ConfigReaders.getConf
+import sttp.client3.asynchttpclient.cats.AsyncHttpClientCatsBackend
 import xyz.didx.ai.handler.Opportunities
+import xyz.didx.config.ConfigReaders.getConf
+
+import scala.concurrent.duration.*
 
 object DawnPatrol extends IOApp.Simple:
   // override protected def blockedThreadDetectionEnabled = true

src/main/scala/xyz/didx/SignalBot.scala

@@ -1,27 +1,25 @@
 package xyz.didx.signal
 
 import cats.data.EitherT
+import cats.effect.FiberIO
 import cats.effect.IO
+import cats.effect.Ref
 import cats.implicits.*
+import fs2.Stream
+import io.circe.syntax.*
+import pureconfig.ConfigReader
+import pureconfig.ConfigSource
+import pureconfig.generic.derivation.default.*
+import sttp.client3.*
+import sttp.client3.circe.asJson
+import sttp.model.StatusCode
 import xyz.didx.messages.SignalMessage
 import xyz.didx.messages.SignalMessageCodec.signalMessageDecoder
 import xyz.didx.messages.SignalMessageCodec.signalSendMessage
 import xyz.didx.messages.SignalSendMessage
 import xyz.didx.messages.SignalSimpleMessage
-import fs2.Stream
-//import io.circe.*
-import io.circe.parser.*
-import io.circe.syntax.*
-import org.typelevel.log4cats.Logger
-import org.typelevel.log4cats.slf4j.Slf4jLogger
-import pureconfig.*
-import pureconfig.generic.derivation.default.*
-import sttp.client3.*
-import sttp.client3.circe.*
-import sttp.model.*
+
 import scala.concurrent.duration._
-import cats.effect.Ref
-import cats.effect.FiberIO
 
 case class SignalConfig(
   signalUrl: String,

src/main/scala/xyz/didx/ai/AiHandler.scala

@@ -1,15 +1,15 @@
 package xyz.didx.ai
 
-import scala.collection.mutable
-import xyz.didx.ai.model.ChatState
-import xyz.didx.ai.handler.OnboardingHandler
-import xyz.didx.ai.handler.ConfirmOnboardingHandler
+import cats.effect.IO
 import dev.langchain4j.data.segment.TextSegment
-import xyz.didx.ai.embedding.EmbeddingHandler
 import dev.langchain4j.store.embedding.EmbeddingMatch
+import xyz.didx.ai.embedding.EmbeddingHandler
+import xyz.didx.ai.handler.ConfirmOnboardingHandler
+import xyz.didx.ai.handler.OnboardingHandler
+import xyz.didx.ai.model.ChatState
 import xyz.didx.ai.model.OnboardingResult
-import xyz.didx.ai.model.ConfirmedOnboardingResult
-import cats.effect.IO
+
+import scala.collection.mutable
 import scala.util.Try
 
 object AiHandler {

src/main/scala/xyz/didx/ai/embedding/EmbeddingHandler.scala

@@ -1,18 +1,18 @@
 package xyz.didx.ai.embedding
 
-import scala.collection.JavaConverters._
+import dev.langchain4j.data.document.Metadata
 import dev.langchain4j.data.embedding.Embedding
 import dev.langchain4j.data.segment.TextSegment
-import dev.langchain4j.store.embedding.{EmbeddingMatch, EmbeddingStore}
-import dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
-import dev.langchain4j.model.huggingface.HuggingFaceEmbeddingModel;
-
 import dev.langchain4j.model.embedding.EmbeddingModel
-import dev.langchain4j.data.segment.TextSegment
-import dev.langchain4j.data.document.Metadata
+import dev.langchain4j.model.huggingface.HuggingFaceEmbeddingModel
+import dev.langchain4j.model.output.Response
+import dev.langchain4j.store.embedding.EmbeddingMatch
+import dev.langchain4j.store.embedding.EmbeddingStore
+import dev.langchain4j.store.embedding.inmemory.InMemoryEmbeddingStore
 import xyz.didx.ai.model.Opportunity
+
 import java.time.Duration
-import dev.langchain4j.model.output.Response
+import scala.collection.JavaConverters._
 
 object EmbeddingHandler {
   private val embeddingModel: EmbeddingModel = HuggingFaceEmbeddingModel

src/main/scala/xyz/didx/ai/handler/ConfirmOnboardingResult.scala

@@ -1,13 +1,14 @@
 package xyz.didx.ai.handler
 
-import scala.collection.mutable
-import com.xebia.functional.xef.prompt.PromptBuilder
 import com.xebia.functional.xef.prompt.Prompt
+import com.xebia.functional.xef.prompt.PromptBuilder
 import com.xebia.functional.xef.scala.conversation.*
 import com.xebia.functional.xef.store.ConversationId
+import xyz.didx.ai.model.AgentScript
 import xyz.didx.ai.model.ConfirmedOnboardingResult
 import xyz.didx.ai.model.OnboardingResult
-import xyz.didx.ai.model.AgentScript
+
+import scala.collection.mutable
 
 object ConfirmOnboardingHandler {
   def getConfirmation(

src/main/scala/xyz/didx/ai/handler/Onboarding.scala

@@ -1,12 +1,13 @@
 package xyz.didx.ai.handler
 
-import scala.collection.mutable
-import com.xebia.functional.xef.prompt.PromptBuilder
 import com.xebia.functional.xef.prompt.Prompt
+import com.xebia.functional.xef.prompt.PromptBuilder
 import com.xebia.functional.xef.scala.conversation.*
 import com.xebia.functional.xef.store.ConversationId
-import xyz.didx.ai.model.OnboardingResult
 import xyz.didx.ai.model.AgentScript
+import xyz.didx.ai.model.OnboardingResult
+
+import scala.collection.mutable
 import scala.util.Random
 
 object OnboardingHandler {

src/main/scala/xyz/didx/ai/handler/Opportunities.scala

@@ -1,19 +1,22 @@
 package xyz.didx.ai.handler
 
-import java.util.Base64
-import java.io.{ByteArrayInputStream, ByteArrayOutputStream}
-import java.util.zip.{GZIPInputStream, GZIPOutputStream}
-import sttp.client4.*
 import cats.data.EitherT
 import cats.effect.IO
+import io.circe
+import io.circe.generic.auto._
+import io.circe.parser.decode
+import sttp.client4.*
 import ujson.Value.Value
+import xyz.didx.ai.embedding.EmbeddingHandler
+import xyz.didx.ai.model.Opportunity
+
+import java.io.ByteArrayInputStream
+import java.io.ByteArrayOutputStream
+import java.util.Base64
+import java.util.zip.GZIPInputStream
+import java.util.zip.GZIPOutputStream
 import scala.util.Try
 import scala.util.chaining.scalaUtilChainingOps
-import io.circe.parser.decode
-import io.circe.generic.auto._
-import xyz.didx.ai.model.Opportunity
-import io.circe
-import xyz.didx.ai.embedding.EmbeddingHandler
 
 object Opportunities {
 

src/main/scala/xyz/didx/ai/model/Opportunity.scala

@@ -1,6 +1,9 @@
 package xyz.didx.ai.model
 
-import io.circe.{Decoder, DecodingFailure, HCursor}
+import io.circe.Decoder
+import io.circe.DecodingFailure
+import io.circe.HCursor
+
 import java.time.LocalDateTime
 import java.time.format.DateTimeFormatter
 import java.time.format.DateTimeParseException

src/main/scala/xyz/didx/ai/openai/OpenAIAgent.scala

@@ -5,7 +5,6 @@ import cats.effect.IO
 import cats.effect.Sync
 import cats.implicits._
 import cats.implicits._
-import xyz.didx.messages.SignalSimpleMessage
 import io.circe.*
 import io.circe.syntax.*
 import org.typelevel.log4cats.Logger
@@ -14,6 +13,7 @@ import pureconfig.*
 import pureconfig.generic.derivation.default.*
 import sttp.client3.*
 import sttp.client3.circe.*
+import xyz.didx.messages.SignalSimpleMessage
 
 case class APIConf(apiKey: String, orgId: String) derives ConfigReader:
   override def toString: String =