Setup project (#1)

Author: bcarter97

.scala-steward.conf

@@ -0,0 +1,16 @@
+# Reference conf file -> https://github.com/scala-steward-org/scala-steward/blob/master/docs/repo-specific-configuration.md
+
+# pullRequests.frequency allows to control how often or when Scala Steward
+# is allowed to create pull requests.
+pullRequests.frequency = "1 day"
+
+# If set, Scala Steward will only create or update `n` PRs each time it runs (see `pullRequests.frequency` above).
+# Useful if running frequently and/or CI build are costly
+updates.limit = 2
+
+# If "always", Scala Steward will always update the PR it created as long as
+# you don't change it yourself.
+updatePullRequests = "always"
+
+# If set, Scala Steward will use this message template for the commit messages and PR titles.
+commits.message = "Update ${artifactName} from ${currentVersion} to ${nextVersion}"

.scalafix.conf

@@ -0,0 +1,21 @@
+rules = [
+  RemoveUnused,
+  NoAutoTupling,
+  DisableSyntax,
+  LeakingImplicitClassVal,
+  NoValInForComprehension,
+  ProcedureSyntax
+]
+
+OrganizeImports {
+  coalesceToWildcardImportThreshold = 8
+  expandRelative = true
+  groupedImports = Merge
+  importSelectorsOrder = SymbolsFirst
+  removeUnused = false
+  groups = [
+    "java."
+    "*"
+    "scala."
+  ]
+}

.scalafix3.conf

@@ -0,0 +1,19 @@
+rules = [
+  NoAutoTupling,
+  DisableSyntax,
+  LeakingImplicitClassVal,
+  NoValInForComprehension
+]
+
+OrganizeImports {
+  coalesceToWildcardImportThreshold = 8
+  expandRelative = true
+  groupedImports = Merge
+  importSelectorsOrder = SymbolsFirst
+  removeUnused = false
+  groups = [
+    "java."
+    "*"
+    "scala."
+  ]
+}

.scalafmt.conf

@@ -0,0 +1,11 @@
+version = 3.7.3
+
+align.preset = most
+includeCurlyBraceInSelectChains = false
+maxColumn = 120
+newlines.sometimesBeforeColonInMethodReturnType = false
+project.git = true
+rewrite.rules = [SortImports, RedundantBraces, RedundantParens, PreferCurlyFors]
+runner.dialect = scala3
+spaces.beforeContextBoundColon = Always
+style = defaultWithAlign

aliases.sbt

@@ -0,0 +1,6 @@
+addCommandAlias("checkFix", "scalafixAll --check OrganizeImports; scalafixAll --check")
+addCommandAlias("runFix", "scalafixAll OrganizeImports; scalafixAll")
+addCommandAlias("checkFmt", "scalafmtCheckAll; scalafmtSbtCheck")
+addCommandAlias("runFmt", "scalafmtAll; scalafmtSbt")
+
+addCommandAlias("ciBuild", "checkFmt; checkFix; +test")

build.sbt

@@ -0,0 +1,45 @@
+import Dependencies.*
+
+lazy val scala3                 = "3.2.2"
+lazy val scala213               = "2.13.10"
+lazy val supportedScalaVersions = List(scala3, scala213)
+lazy val scmUrl                 = "https://github.com/sky-uk/fs2-kafka-topic-loader"
+
+ThisBuild / organization := "uk.sky"
+ThisBuild / description  := "Read the contents of provided Kafka topics"
+ThisBuild / licenses     := List("BSD New" -> url("https://opensource.org/licenses/BSD-3-Clause"))
+
+ThisBuild / scalaVersion       := scala213 // TODO - for development to get unused warnings
+ThisBuild / crossScalaVersions := supportedScalaVersions
+ThisBuild / semanticdbEnabled  := true
+ThisBuild / semanticdbVersion  := scalafixSemanticdb.revision
+
+ThisBuild / scalafixDependencies += Dependencies.Plugins.organizeImports
+
+tpolecatScalacOptions ++= Set(ScalacOptions.source3)
+
+lazy val root = (project in file("."))
+  .settings(
+    name := "fs2-kafka-topic-loader",
+    libraryDependencies ++= Seq(scalaTest)
+  )
+
+/** Scala 3 doesn't support two rules yet - RemoveUnused and ProcedureSyntax. So we require a different scalafix config
+  * for Scala 3
+  *
+  * RemoveUnused relies on -warn-unused which isn't available in scala 3 yet -
+  * https://scalacenter.github.io/scalafix/docs/rules/RemoveUnused.html
+  *
+  * ProcedureSyntax doesn't exist in Scala 3 - https://scalacenter.github.io/scalafix/docs/rules/ProcedureSyntax.html
+  */
+ThisBuild / scalafixConfig := {
+  CrossVersion.partialVersion(scalaVersion.value) match {
+    case Some((3, _)) => Some((ThisBuild / baseDirectory).value / ".scalafix3.conf")
+    case _            => None
+  }
+}
+
+Test / parallelExecution := false
+Test / fork              := true
+
+Global / onChangedBuildSource := ReloadOnSourceChanges

project/Dependencies.scala

@@ -0,0 +1,9 @@
+import sbt.*
+
+object Dependencies {
+  object Plugins {
+    lazy val organizeImports = "com.github.liancheng" %% "organize-imports" % "0.6.0"
+  }
+
+  lazy val scalaTest = "org.scalatest" %% "scalatest" % "3.2.15" % Test
+}

project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.8.2

project/plugins.sbt

@@ -0,0 +1,3 @@
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.0")
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.10.4")
+addSbtPlugin("io.github.davidgregory084" % "sbt-tpolecat" % "0.4.1")

src/main/scala/uk/sky/fs2/kafka/topicloader/TopicLoader.scala

@@ -0,0 +1,11 @@
+package uk.sky.fs2.kafka.topicloader
+
+object TopicLoader extends TopicLoader
+
+trait TopicLoader {
+
+  def load(): Unit = ()
+
+  def loadAndRun(): Unit = ()
+
+}