Reformat with scalafmt 3.0.0

Author: scala-steward

readme/src/main/scala/org/scalafmt/readme/Readme.scala

@@ -43,9 +43,7 @@ object Readme {
 
   /** repl session, inspired by tut.
     *
-    * Example: code="1 + 1" returns
-    * "scala> 1 + 1
-    * res0: Int = 2"
+    * Example: code="1 + 1" returns "scala> 1 + 1 res0: Int = 2"
     */
   def repl(code: String) = {
     import scala.meta._
@@ -232,16 +230,16 @@ object Readme {
       )
     )
 
-  /** This looks way too hacky. But can't seem to find a typeclass
-    * that ought to "encode" the ``ModKey`` enum.
+  /** This looks way too hacky. But can't seem to find a typeclass that ought to
+    * "encode" the ``ModKey`` enum.
     *
-    * Additionally, a Vector of Strings is simply concatenated, hence
-    * the extra .mkString.
+    * Additionally, a Vector of Strings is simply concatenated, hence the extra
+    * .mkString.
     * {{{
-    *    [error]  found   : Vector[org.scalafmt.config.SortSettings.ModKey]
-    *    [error]  required: scalatags.Text.Modifier
-    *    [error]     (which expands to)  scalatags.generic.Modifier[scalatags.text.Builder]
-    *    [error]           @code{rewrite.sortModifiers.order} = @rewriteSortModifiers.rewrite.sortModifiers.order
+    *     [error]  found   : Vector[org.scalafmt.config.SortSettings.ModKey]
+    *     [error]  required: scalatags.Text.Modifier
+    *     [error]     (which expands to)  scalatags.generic.Modifier[scalatags.text.Builder]
+    *     [error]           @code{rewrite.sortModifiers.order} = @rewriteSortModifiers.rewrite.sortModifiers.order
     * }}}
     */
   val rewriteSortModifiersDefaultString =

scalafmt-cli/src/main/scala/org/scalafmt/cli/CliOptions.scala

@@ -17,15 +17,15 @@ object CliOptions {
 
   /** Tries to read configuration from
     *
-    * 1. .scalafmt.conf in root dir of current git repo
-    *     IF the following setting is enabled: project.git = true
-    * 2. .scalafmt.conf from init.common.workingDirectory
+    *   1. .scalafmt.conf in root dir of current git repo IF the following
+    *      setting is enabled: project.git = true 2. .scalafmt.conf from
+    *      init.common.workingDirectory
     *
     * I am happy to add alternative fallback methods for other VCS.
     *
     * WARNING. Throws an exception if the .scalafmt.conf error exists but
-    * contains an error. Why? Because this method is only supposed to be
-    * called directly from main.
+    * contains an error. Why? Because this method is only supposed to be called
+    * directly from main.
     */
   def auto(parsed: CliOptions): CliOptions = {
     val auxOut =
@@ -109,8 +109,8 @@ case class CliOptions(
 
   val writeMode: WriteMode = writeModeOpt.getOrElse(WriteMode.Override)
 
-  /** Create a temporary file that contains configuration string specified by `--config-str`.
-    * This temporary file will be passed to `scalafmt-dynamic`.
+  /** Create a temporary file that contains configuration string specified by
+    * `--config-str`. This temporary file will be passed to `scalafmt-dynamic`.
     * See https://github.com/scalameta/scalafmt/pull/1367#issuecomment-464744077
     */
   private[this] val tempConfigPath: Option[Path] = configStr.map { s =>
@@ -119,12 +119,13 @@ case class CliOptions(
     file
   }
 
-  /** - If --config-str is specified (and tempConfigPath is defined),
-    *   this returns the path to a temporary file.
-    * - If both tempConfigPath and config are None,
-    *   this return the path to `.scalafmt.conf` on the working directory.
+  /**   - If --config-str is specified (and tempConfigPath is defined), this
+    *     returns the path to a temporary file.
+    *   - If both tempConfigPath and config are None, this return the path to
+    *     `.scalafmt.conf` on the working directory.
     *
-    * @return A path to a configuration file
+    * @return
+    *   A path to a configuration file
     */
   def configPath: Path =
     configPathOpt.get
@@ -138,10 +139,12 @@ case class CliOptions(
     .orElse(gitOps.rootDir.flatMap(tryGetConfigFile))
 
   /** Parse the scalafmt configuration and try to encode it to `ScalafmtConfig`.
-    * If `--config-str` is specified, this will parse the configuration string specified by `--config-str`.
-    * Otherwise, a contents of configuration file specified by `configPath` will be parsed.
+    * If `--config-str` is specified, this will parse the configuration string
+    * specified by `--config-str`. Otherwise, a contents of configuration file
+    * specified by `configPath` will be parsed.
     *
-    * If `--config-str` is not specified and configuration file is missing, this will return the default configuration
+    * If `--config-str` is not specified and configuration file is missing, this
+    * will return the default configuration
     */
   def scalafmtConfig: Configured[ScalafmtConfig] =
     hoconOpt.fold(Configured.ok(ScalafmtConfig.default))(Config.fromConf(_))
@@ -215,8 +218,7 @@ case class CliOptions(
       .flatMap(x => Try(Codec(x)).toOption)
       .getOrElse(ScalafmtConfig.default.encoding)
 
-  /** Returns None if .scalafmt.conf is not found or
-    * version setting is missing.
+  /** Returns None if .scalafmt.conf is not found or version setting is missing.
     */
   private[cli] def getVersionIfDifferent: Option[String] =
     getHoconValueOpt[String]("version").filter(_ != Versions.version)

scalafmt-cli/src/main/scala/org/scalafmt/cli/FileFetchMode.scala

@@ -8,8 +8,9 @@ sealed trait FileFetchMode
 
 object FileFetchMode {
 
-  /** The read instance is practically is not exhaustive due to the RecursiveSearch and GitFiles are the fallback used in the absence of
-    * other options
+  /** The read instance is practically is not exhaustive due to the
+    * RecursiveSearch and GitFiles are the fallback used in the absence of other
+    * options
     */
   implicit val read: Read[FileFetchMode] = Read.reads {
     case "diff" => DiffFiles("master")

scalafmt-cli/src/main/scala/org/scalafmt/cli/TermDisplay.scala

@@ -55,9 +55,8 @@ object Terminal {
 
     /** Clear the current line
       *
-      * n=0: clear from cursor to end of line
-      * n=1: clear from cursor to start of line
-      * n=2: clear entire line
+      * n=0: clear from cursor to end of line n=1: clear from cursor to start of
+      * line n=2: clear entire line
       */
     def clearLine(n: Int): Unit = control(n, 'K')
   }

scalafmt-cli/src/main/scala/org/scalafmt/cli/WriteMode.scala

@@ -2,8 +2,8 @@ package org.scalafmt.cli
 
 /** Determines the mode in which Scalafmt will behave
   *
-  * Override = Replace the file with its formatted form
-  * Stdout = Print the formatted file to Stdout (leaving the original file untouched)
+  * Override = Replace the file with its formatted form Stdout = Print the
+  * formatted file to Stdout (leaving the original file untouched)
   */
 sealed trait WriteMode
 

scalafmt-core/jvm/src/main/scala/org/scalafmt/internal/PriorityQueue.scala

@@ -6,7 +6,8 @@ package org.scalafmt.internal
   * native-image compiler is unable to work with
   * `scala.collection.mutable.PriorityQueue` currently.
   *
-  * @tparam T the values inside the queue
+  * @tparam T
+  *   the values inside the queue
   */
 class PriorityQueue[T](implicit ord: Ordering[T]) {
   private[this] val q = new java.util.PriorityQueue[T](11, ord.reversed())

scalafmt-core/shared/src/main/scala/org/scalafmt/Scalafmt.scala

@@ -22,8 +22,9 @@ import org.scalafmt.internal.FormatWriter
 import org.scalafmt.rewrite.Rewrite
 import org.scalafmt.util.{FileOps, MarkdownFile, MarkdownPart}
 
-/** WARNING. This API is discouraged when integrating with Scalafmt from a build tool
-  * or editor plugin. It is recommended to use the `scalafmt-dynamic` module instead.
+/** WARNING. This API is discouraged when integrating with Scalafmt from a build
+  * tool or editor plugin. It is recommended to use the `scalafmt-dynamic`
+  * module instead.
   */
 object Scalafmt {
 
@@ -34,16 +35,20 @@ object Scalafmt {
   // XXX: don't modify signature, scalafmt-dynamic expects it via reflection
   /** Format Scala code using scalafmt.
     *
-    * WARNING. This API is discouraged when integrating with Scalafmt from a build tool
-    * or editor plugin. It is recommended to use the `scalafmt-dynamic` module instead.
+    * WARNING. This API is discouraged when integrating with Scalafmt from a
+    * build tool or editor plugin. It is recommended to use the
+    * `scalafmt-dynamic` module instead.
     *
-    * @param code Code string to format.
-    * @param style Configuration for formatting output.
-    * @param range EXPERIMENTAL. Format a subset of lines.
-    * @return [[Formatted.Success]] if successful,
-    *         [[Formatted.Failure]] otherwise. If you are OK with throwing
-    *         exceptions, use [[Formatted.Success.get]] to get back a
-    *         string.
+    * @param code
+    *   Code string to format.
+    * @param style
+    *   Configuration for formatting output.
+    * @param range
+    *   EXPERIMENTAL. Format a subset of lines.
+    * @return
+    *   [[Formatted.Success]] if successful, [[Formatted.Failure]] otherwise. If
+    *   you are OK with throwing exceptions, use [[Formatted.Success.get]] to
+    *   get back a string.
     */
   def format(
       code: String,
@@ -177,7 +182,8 @@ object Scalafmt {
 
   /** Utility method to change dialect on ScalafmtConfig.
     *
-    * Binary compatibility is guaranteed between releases, unlike with ScalafmtConfig.copy.
+    * Binary compatibility is guaranteed between releases, unlike with
+    * ScalafmtConfig.copy.
     */
   def configWithDialect(
       config: ScalafmtConfig,

scalafmt-core/shared/src/main/scala/org/scalafmt/config/Align.scala

@@ -5,59 +5,55 @@ import metaconfig.annotation.ExtraName
 import metaconfig.generic.Surface
 
 /** @param openParenCallSite
-  *   If true AND bin-packing is true, then call-site
-  *   arguments won't be aligned by the opening
-  *   parenthesis. For example, this output
-  *   will be disallowed
+  *   If true AND bin-packing is true, then call-site arguments won't be aligned
+  *   by the opening parenthesis. For example, this output will be disallowed
   *
-  *   function(a,
-  *            b,
-  *            c)
-  * @param openParenDefnSite Same as [[openParenCallSite]], except definition site.
-  * @param tokens The tokens to vertically align by. The "owner" is the
-  *               scala.meta.Tree.getClass.getName of the deepest tree node
-  *               that "owns" the token to align by.
+  * function(a, b, c)
+  * @param openParenDefnSite
+  *   Same as [[openParenCallSite]], except definition site.
+  * @param tokens
+  *   The tokens to vertically align by. The "owner" is the
+  *   scala.meta.Tree.getClass.getName of the deepest tree node that "owns" the
+  *   token to align by.
   *
-  *               Examples:
+  * Examples:
   *
-  *               align.tokens = ["="] // align = owned by any tree node (not recommended)
+  * align.tokens = ["="] // align = owned by any tree node (not recommended)
   *
-  *               align.tokens = [
-  *                 { code = "=", owner = "Param" } // align = when owned by parameter tree nodes
-  *               ]
+  * align.tokens = [ { code = "=", owner = "Param" } // align = when owned by
+  * parameter tree nodes ]
   *
-  *               Pro tip. if you use for example
+  * Pro tip. if you use for example
   *
-  *               preset = defaultWithAlign
+  * preset = defaultWithAlign
   *
-  *               and want to add one extra token (for example "|>") to align by, write
+  * and want to add one extra token (for example "|>") to align by, write
   *
-  *               align.tokens."+" = [ "|> ]
+  * align.tokens."+" = [ "|> ]
   *
-  *               NOTE. Adding more alignment tokens may potentially decrease the
-  *               vertical alignment in formatted output. Customize at your own
-  *               risk, I recommend you try and stick to the default settings.
-  * @param arrowEnumeratorGenerator If true, aligns by `<-` in for comprehensions.
+  * NOTE. Adding more alignment tokens may potentially decrease the vertical
+  * alignment in formatted output. Customize at your own risk, I recommend you
+  * try and stick to the default settings.
+  * @param arrowEnumeratorGenerator
+  *   If true, aligns by `<-` in for comprehensions.
   * @param openParenCtrlSite
-  *   If true, aligns by ( in if/while/for. If false,
-  *   indents by continuation indent at call site.
+  *   If true, aligns by ( in if/while/for. If false, indents by continuation
+  *   indent at call site.
   * @param tokenCategory
-  *   Customize which token kinds can align together. By default, only tokens with
-  *   the same `Token.productPrefix` align. To for example align = and <-,
-  *   set the values to:
-  *     Map("Equals" -> "Assign", "LeftArrow" -> "Assign")
+  *   Customize which token kinds can align together. By default, only tokens
+  *   with the same `Token.productPrefix` align. To for example align = and <-,
+  *   set the values to: Map("Equals" -> "Assign", "LeftArrow" -> "Assign")
   *   Note. Requires mixedTokens to be true.
   * @param treeCategory
   *   Customize which tree kinds can align together. By default, only trees with
   *   the same `Tree.productPrefix` align. To for example align Defn.Val and
-  *   Defn.Var, set the values to:
-  *     Map("Defn.Var" -> "Assign", "Defn.Val" -> "Assign")
-  *   Note. Requires mixedOwners to be true.
+  *   Defn.Var, set the values to: Map("Defn.Var" -> "Assign", "Defn.Val" ->
+  *   "Assign") Note. Requires mixedOwners to be true.
   * @param stripMargin
   *   If set, indent lines with a strip-margin character in a multiline string
   *   constant relative to the opening quotes (or the strip-margin character if
-  *   present) on the first line; otherwise, indent relative to the beginning
-  *   of the first line, as usual.
+  *   present) on the first line; otherwise, indent relative to the beginning of
+  *   the first line, as usual.
   */
 case class Align(
     allowOverflow: Boolean = false,

scalafmt-core/shared/src/main/scala/org/scalafmt/config/AlignToken.scala

@@ -9,8 +9,10 @@ import metaconfig.generic.Surface
 
 /** Configuration option for aligning tokens.
   *
-  * @param code string literal value of the token to align by.
-  * @param owners array of owner specs.
+  * @param code
+  *   string literal value of the token to align by.
+  * @param owners
+  *   array of owner specs.
   */
 case class AlignToken(
     code: String,
@@ -34,8 +36,10 @@ object AlignToken {
   private def pattern(value: String): jurPattern =
     value.r.pattern
 
-  /** @param regex regexp for class name of scala.meta.Tree "owner".
-    * @param parent optional regexp for class name of owner's parent.
+  /** @param regex
+    *   regexp for class name of scala.meta.Tree "owner".
+    * @param parent
+    *   optional regexp for class name of owner's parent.
     */
   case class Owner(
       regex: Option[String] = None,

scalafmt-core/shared/src/main/scala/org/scalafmt/config/BinPack.scala

@@ -2,29 +2,30 @@ package org.scalafmt.config
 
 import metaconfig._
 
-/** @param unsafeCallSite      DO NOT USE! This option is buggy for complicated expressions.
-  *                            The only reason this option exists is to support
-  *                            the [[literalArgumentLists]] option, which enables callSite
-  *                            only for simple expressions.
+/** @param unsafeCallSite
+  *   DO NOT USE! This option is buggy for complicated expressions. The only
+  *   reason this option exists is to support the [[literalArgumentLists]]
+  *   option, which enables callSite only for simple expressions.
   *
-  *                            If true, will fit as many arguments on each line,
-  *                            only breaking at commas. If false, a function
-  *                            call's arguments will either be all on the same
-  *                            line or will have one line each.
-  * @param unsafeDefnSite            Same as [[unsafeCallSite]], except for definition site.
+  * If true, will fit as many arguments on each line, only breaking at commas.
+  * If false, a function call's arguments will either be all on the same line or
+  * will have one line each.
+  * @param unsafeDefnSite
+  *   Same as [[unsafeCallSite]], except for definition site.
   * @param literalArgumentLists
-  *                            If true, automatically sets the style to bin-pack for argument lists
-  *                            that only consist of literals.
-  * @param literalsMinArgCount Argument list must be longer than this setting
-  *                            to be eligible for [[literalArgumentLists]].
-  * @param literalsInclude     Regexes for literal type names. For example, "Int"
-  *                            or "Byte".
-  * @param literalsExclude     Regexes for literal to exclude from [[literalArgumentLists]].
-  * @param parentConstructors  Parent constructors are C and D in
-  *                            "class A extends B with C and D". If "Always",
-  *                            scalafmt will fit as many parent constructors
-  *                            on a single line. If "Never", each parent
-  *                            constructor gets its own line.
+  *   If true, automatically sets the style to bin-pack for argument lists that
+  *   only consist of literals.
+  * @param literalsMinArgCount
+  *   Argument list must be longer than this setting to be eligible for
+  *   [[literalArgumentLists]].
+  * @param literalsInclude
+  *   Regexes for literal type names. For example, "Int" or "Byte".
+  * @param literalsExclude
+  *   Regexes for literal to exclude from [[literalArgumentLists]].
+  * @param parentConstructors
+  *   Parent constructors are C and D in "class A extends B with C and D". If
+  *   "Always", scalafmt will fit as many parent constructors on a single line.
+  *   If "Never", each parent constructor gets its own line.
   */
 case class BinPack(
     unsafeCallSite: BinPack.Unsafe = BinPack.Unsafe.Never,