Merge branch 'main' into feature/grouping

Author: alejandrohdezma

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.12.16, 2.13.8]
+        scala: [2.12.17, 2.13.10]
         java: [adopt-hotspot@8, adopt-hotspot@11]
     runs-on: ${{ matrix.os }}
     steps:
@@ -118,22 +118,22 @@ jobs:
             ~/Library/Caches/Coursier/v1
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
-      - name: Download target directories (2.12.16)
+      - name: Download target directories (2.12.17)
         uses: actions/download-artifact@v2
         with:
-          name: target-${{ matrix.os }}-2.12.16-${{ matrix.java }}
+          name: target-${{ matrix.os }}-2.12.17-${{ matrix.java }}
 
-      - name: Inflate target directories (2.12.16)
+      - name: Inflate target directories (2.12.17)
         run: |
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (2.13.8)
+      - name: Download target directories (2.13.10)
         uses: actions/download-artifact@v2
         with:
-          name: target-${{ matrix.os }}-2.13.8-${{ matrix.java }}
+          name: target-${{ matrix.os }}-2.13.10-${{ matrix.java }}
 
-      - name: Inflate target directories (2.13.8)
+      - name: Inflate target directories (2.13.10)
         run: |
           tar xf targets.tar
           rm targets.tar

.mergify.yml

@@ -10,10 +10,10 @@ pull_request_rules:
   - name: merge scala-steward's PRs
     conditions:
       - author=scala-steward
-      - status-success=Build and Test (ubuntu-latest, 2.12.16, adopt-hotspot@8)
-      - status-success=Build and Test (ubuntu-latest, 2.12.16, adopt-hotspot@11)
-      - status-success=Build and Test (ubuntu-latest, 2.13.8, adopt-hotspot@8)
-      - status-success=Build and Test (ubuntu-latest, 2.13.8, adopt-hotspot@11)
+      - status-success=Build and Test (ubuntu-latest, 2.12.17, adopt-hotspot@8)
+      - status-success=Build and Test (ubuntu-latest, 2.12.17, adopt-hotspot@11)
+      - status-success=Build and Test (ubuntu-latest, 2.13.10, adopt-hotspot@8)
+      - status-success=Build and Test (ubuntu-latest, 2.13.10, adopt-hotspot@11)
     actions:
       merge:
         method: squash

.scala-steward.conf

@@ -1,2 +1,6 @@
 updatePullRequests = "always"
 
+updates.pin = [
+  # We may drop this when we drop JDK 8 since minimum JDK is 11 from logback-classic 1.4.0
+  { groupId = "ch.qos.logback", artifactId="logback-classic", version="1.3." }
+]

build.sbt

@@ -22,8 +22,8 @@ val moduleCrossPlatformMatrix: Map[String, List[Platform]] = Map(
   "mill-plugin" -> List(JVMPlatform)
 )
 
-val Scala212 = "2.12.16"
-val Scala213 = "2.13.8"
+val Scala212 = "2.12.17"
+val Scala213 = "2.13.10"
 
 /// sbt-github-actions configuration
 
@@ -140,6 +140,11 @@ lazy val core = myCrossProject("core")
         // https/repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/2.12.6/jackson-core-2.12.6.jar:module-info.class
         // https/repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-databind/2.12.6.1/jackson-databind-2.12.6.1.jar:module-info.class
         MergeStrategy.discard
+      case PathList("META-INF", "sisu", "javax.inject.Named") =>
+        // (core / assembly) deduplicate: different file contents found in the following:
+        // https/repo1.maven.org/maven2/org/codehaus/plexus/plexus-archiver/4.5.0/plexus-archiver-4.5.0.jar:META-INF/sisu/javax.inject.Named
+        // https/repo1.maven.org/maven2/org/codehaus/plexus/plexus-io/3.4.0/plexus-io-3.4.0.jar:META-INF/sisu/javax.inject.Named
+        MergeStrategy.first
       case otherwise =>
         val defaultStrategy = (assembly / assemblyMergeStrategy).value
         defaultStrategy(otherwise)

docs/help.md

@@ -3,7 +3,9 @@
 All command line arguments for the `scala-steward` application.
 
 ```
-Usage: scala-steward --workspace <file> --repos-file <file> [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] --git-ask-pass <file> [--sign-commits] [--vcs-type <vcs-type>] [--vcs-api-host <uri>] --vcs-login <string> [--do-not-fork] [--add-labels] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--bitbucket-server-use-default-reviewers] [--gitlab-merge-when-pipeline-succeeds] [--github-app-id <integer> --github-app-key-file <file>] [--url-checker-test-url <uri>] [--default-maven-repo <string>] [--refresh-backoff-period <duration>]
+Usage:
+    scala-steward validate-repo-config
+    scala-steward --workspace <file> --repos-file <file> [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] --git-ask-pass <file> [--sign-commits] [--vcs-type <vcs-type>] [--vcs-api-host <uri>] --vcs-login <string> [--do-not-fork] [--add-labels] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--bitbucket-server-use-default-reviewers] [--gitlab-merge-when-pipeline-succeeds] [--github-app-id <integer> --github-app-key-file <file>] [--url-checker-test-url <uri>] [--default-maven-repo <string>] [--refresh-backoff-period <duration>]
 
 
 
@@ -78,4 +80,8 @@ Options and flags:
         default: https://repo1.maven.org/maven2/
     --refresh-backoff-period <duration>
         Period of time a failed build won't be triggered again; default: 0days
+
+Subcommands:
+    validate-repo-config
+        Validate the repo config file and exit; report errors if any
 ```

modules/core/src/main/resources/default.scala-steward.conf

@@ -28,10 +28,10 @@ updates.ignore = [
   { groupId = "org.scala-lang", artifactId = "scala3-library_sjs1", version = { exact = "3.2.1" } },
 
   // Ignore the next Scala 2.13 version until it is announced.
-  { groupId = "org.scala-lang", artifactId = "scala-compiler", version = { exact = "2.13.10" } },
-  { groupId = "org.scala-lang", artifactId = "scala-library",  version = { exact = "2.13.10" } },
-  { groupId = "org.scala-lang", artifactId = "scala-reflect",  version = { exact = "2.13.10" } },
-  { groupId = "org.scala-lang", artifactId = "scalap",         version = { exact = "2.13.10" } },
+  { groupId = "org.scala-lang", artifactId = "scala-compiler", version = { exact = "2.13.11" } },
+  { groupId = "org.scala-lang", artifactId = "scala-library",  version = { exact = "2.13.11" } },
+  { groupId = "org.scala-lang", artifactId = "scala-reflect",  version = { exact = "2.13.11" } },
+  { groupId = "org.scala-lang", artifactId = "scalap",         version = { exact = "2.13.11" } },
 
   // Ignore the next Scala 2.12 version until it is announced.
   { groupId = "org.scala-lang", artifactId = "scala-compiler", version = { exact = "2.12.18" } },

modules/core/src/main/scala/org/scalasteward/core/Main.scala

@@ -23,7 +23,7 @@ import org.scalasteward.core.application.{Cli, Context}
 object Main extends IOApp {
   override def run(args: List[String]): IO[ExitCode] =
     Cli.parseArgs(args) match {
-      case Cli.ParseResult.Success(config) => Context.step0[IO](config).use(_.stewardAlg.runF)
+      case Cli.ParseResult.Success(config) => Context.step0[IO](config).use(_.runF)
       case Cli.ParseResult.Help(help)      => Console[IO].println(help).as(ExitCode.Success)
       case Cli.ParseResult.Error(error)    => Console[IO].errorln(error).as(ExitCode.Error)
     }

modules/core/src/main/scala/org/scalasteward/core/application/Cli.scala

@@ -257,6 +257,15 @@ object Cli {
       .withDefault(default)
   }
 
+  private val configFile: Opts[File] =
+    Opts.argument[File]()
+
+  private val validateConfigFile: Opts[File] =
+    Opts.subcommand(
+      name = "validate-repo-config",
+      help = "Validate the repo config file and exit; report errors if any"
+    )(configFile)
+
   private val configOpts: Opts[Config] = (
     workspace,
     reposFile,
@@ -276,12 +285,19 @@ object Cli {
     refreshBackoffPeriod
   ).mapN(Config.apply)
 
-  val command: Command[Config] =
-    Command("scala-steward", "")(configOpts)
+  val command: Command[StewardUsage] =
+    Command("scala-steward", "")(
+      validateConfigFile
+        .map(StewardUsage.ValidateRepoConfig(_))
+        .orElse(
+          configOpts
+            .map(StewardUsage.Regular(_))
+        )
+    )
 
   sealed trait ParseResult extends Product with Serializable
   object ParseResult {
-    final case class Success(config: Config) extends ParseResult
+    final case class Success(config: StewardUsage) extends ParseResult
     final case class Help(help: String) extends ParseResult
     final case class Error(error: String) extends ParseResult
   }

modules/core/src/main/scala/org/scalasteward/core/application/Config.scala

@@ -135,4 +135,10 @@ object Config {
   final case class GitLabCfg(
       mergeWhenPipelineSucceeds: Boolean
   )
+
+  sealed trait StewardUsage
+  object StewardUsage {
+    final case class Regular(config: Config) extends StewardUsage
+    final case class ValidateRepoConfig(file: File) extends StewardUsage
+  }
 }

modules/core/src/main/scala/org/scalasteward/core/application/Context.scala

@@ -16,8 +16,10 @@
 
 package org.scalasteward.core.application
 
+import better.files.File
 import cats.effect._
 import cats.effect.implicits._
+import cats.MonadThrow
 import cats.syntax.all._
 import eu.timepit.refined.auto._
 import org.http4s.Uri
@@ -48,6 +50,8 @@ import org.scalasteward.core.vcs.github.{GitHubAppApiAlg, GitHubAuthAlg}
 import org.scalasteward.core.vcs.{VCSApiAlg, VCSExtraAlg, VCSRepoAlg, VCSSelection}
 import org.typelevel.log4cats.Logger
 import org.typelevel.log4cats.slf4j.Slf4jLogger
+import org.scalasteward.core.application.Config.StewardUsage
+import org.scalasteward.core.repoconfig.ValidateRepoConfigAlg
 
 final class Context[F[_]](implicit
     val buildToolDispatcher: BuildToolDispatcher[F],
@@ -77,10 +81,29 @@ final class Context[F[_]](implicit
 )
 
 object Context {
-  def step0[F[_]](config: Config)(implicit F: Async[F]): Resource[F, Context[F]] =
+
+  sealed trait StewardContext[F[_]] {
+    def runF: F[ExitCode]
+  }
+  object StewardContext {
+    final case class Regular[F[_]](context: Context[F]) extends StewardContext[F] {
+      override def runF: F[ExitCode] = context.stewardAlg.runF
+    }
+
+    final case class ValidateRepoConfig[F[_]](file: File)(implicit
+        val validateRepoConfigAlg: ValidateRepoConfigAlg[F],
+        val logger: Logger[F]
+    ) extends StewardContext[F] {
+      override def runF: F[ExitCode] = validateRepoConfigAlg.validateAndReport(file)
+    }
+  }
+
+  def step0[F[_]](
+      usage: Config.StewardUsage
+  )(implicit F: Async[F]): Resource[F, StewardContext[F]] =
     for {
-      logger <- Resource.eval(Slf4jLogger.fromName[F]("org.scalasteward.core"))
-      _ <- Resource.eval(printBanner(logger))
+      logger0 <- Resource.eval(Slf4jLogger.fromName[F]("org.scalasteward.core"))
+      _ <- Resource.eval(printBanner(logger0))
       _ <- Resource.eval(F.delay(System.setProperty("http.agent", userAgentString)))
       userAgent <- Resource.eval(F.fromEither(`User-Agent`.parse(userAgentString)))
       middleware = ClientConfiguration
@@ -94,22 +117,46 @@ object Context {
         ClientConfiguration.disableFollowRedirect[F],
         middleware
       )
-      fileAlg = FileAlg.create(logger, F)
-      processAlg = ProcessAlg.create(config.processCfg)(logger, F)
-      workspaceAlg = WorkspaceAlg.create(config)(fileAlg, logger, F)
-      context <- Resource.eval(
-        step1(config)(
-          defaultClient,
-          UrlCheckerClient(urlCheckerClient),
-          fileAlg,
-          logger,
-          processAlg,
-          workspaceAlg,
-          F
-        )
-      )
+      fileAlg0 = FileAlg.create(logger0, F)
+      context <- usage match {
+        case StewardUsage.Regular(config) =>
+          initRegular(config)(
+            defaultClient,
+            UrlCheckerClient(urlCheckerClient),
+            fileAlg0,
+            logger0,
+            F
+          ).map(StewardContext.Regular(_))
+
+        case StewardUsage.ValidateRepoConfig(file) =>
+          implicit val fileAlg: FileAlg[F] = fileAlg0
+          implicit val logger: Logger[F] = logger0
+          Resource.pure[F, StewardContext[F]](initValidateRepoConfig(file))
+      }
+
     } yield context
 
+  def initRegular[F[_]](config: Config)(implicit
+      client: Client[F],
+      urlCheckerClient: UrlCheckerClient[F],
+      fileAlg: FileAlg[F],
+      logger: Logger[F],
+      F: Async[F]
+  ): Resource[F, Context[F]] = {
+    implicit val processAlg = ProcessAlg.create(config.processCfg)
+    implicit val workspaceAlg = WorkspaceAlg.create(config)
+    Resource.eval(step1(config))
+  }
+
+  def initValidateRepoConfig[F[_]](file: File)(implicit
+      fileAlg: FileAlg[F],
+      logger: Logger[F],
+      F: MonadThrow[F]
+  ): StewardContext.ValidateRepoConfig[F] = {
+    implicit val validateRepoConfigAlg = new ValidateRepoConfigAlg[F]()
+    StewardContext.ValidateRepoConfig[F](file)
+  }
+
   def step1[F[_]](config: Config)(implicit
       client: Client[F],
       urlCheckerClient: UrlCheckerClient[F],