scala fmt

Author: pjfanning

.scalafmt.conf

@@ -1,5 +1,6 @@
 # https://scalameta.org/scalafmt/docs/configuration.html
 version = "3.5.9"
+runner.dialect = scala213source3
 maxColumn = 140
 project.git = true
 

src/main/scala-2/com/github/swagger/scala/converter/ErasureHelper.scala

@@ -40,7 +40,7 @@ private[converter] object ErasureHelper {
     } catch {
       case NonFatal(t) => {
         if (logger.isDebugEnabled) {
-          //use this form because of Scala 2.11 & 2.12 compile issue
+          // use this form because of Scala 2.11 & 2.12 compile issue
           logger.debug(s"Unable to get type info ${Option(cls.getName).getOrElse("null")}", t)
         } else {
           logger.info("Unable to get type info {}", Option(cls.getName).getOrElse("null"))

src/main/scala/com/github/swagger/scala/converter/SwaggerScalaModelConverter.scala

@@ -26,25 +26,29 @@ object SwaggerScalaModelConverter {
   val objectMapper: ObjectMapper = Json.mapper().registerModule(DefaultScalaModule)
   private var requiredBasedOnAnnotation = true
 
-  /** [[io.swagger.v3.oas.annotations.media.Schema]] annotation has required = [[false]] by default
-    * This means that all fields that aren't [[Option]] will, counter to what you would expect based on the type,
-    * <b>not</b> be required by default.
-    * If this behavior is undesired, set [[SwaggerScalaModelConverter.setRequiredBasedOnAnnotation]] to [[true]]
-    * and the required property on the annotation will be ignored, unless the field is an [[Option]].
+  /** If you use swagger annotations to override what is automatically derived, then be aware that
+    * [[io.swagger.v3.oas.annotations.media.Schema]] annotation has required = [[false]], by default. You are advised to set the required
+    * flag on this annotation to the correct value. If you would prefer to have the Schema annotation required flag ignored and to rely on
+    * the this module inferring the value (as ot would if you don't annotate the classes or fields), then set
+    * [[SwaggerScalaModelConverter.setRequiredBasedOnAnnotation]] to [[true]] and the required property on the annotation will be ignored,
+    * unless the field is an [[Option]].
     *
-    * @param value true by default
+    * @param value
+    *   true by default
     */
   def setRequiredBasedOnAnnotation(value: Boolean = true): Unit = {
     requiredBasedOnAnnotation = value
   }
 
-  /** [[io.swagger.v3.oas.annotations.media.Schema]] annotation has required = [[false]] by default
-    * This means that all fields that aren't [[Option]] will, counter to what you would expect based on the type,
-    * <b>not</b> be required by default.
-    * If this behavior is undesired, set [[SwaggerScalaModelConverter.setRequiredBasedOnAnnotation]] to [[true]]
-    * and the required property on the annotation will be ignored, unless the field is an [[Option]].
+  /** If you use swagger annotations to override what is automatically derived, then be aware that
+    * [[io.swagger.v3.oas.annotations.media.Schema]] annotation has required = [[false]], by default. You are advised to set the required
+    * flag on this annotation to the correct value. If you would prefer to have the Schema annotation required flag ignored and to rely on
+    * the this module inferring the value (as ot would if you don't annotate the classes or fields), then set
+    * [[SwaggerScalaModelConverter.setRequiredBasedOnAnnotation]] to [[true]] and the required property on the annotation will be ignored,
+    * unless the field is an [[Option]].
     *
-    * @return value: true by default
+    * @return
+    *   value: true by default
     */
   def isRequiredBasedOnAnnotation: Boolean = requiredBasedOnAnnotation
 }

src/test/scala/com/github/swagger/scala/converter/ModelPropertyParserTest.scala

@@ -169,7 +169,9 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
     nullSafeSeq(model.value.getRequired) shouldBe empty
   }
 
-  it should "prioritize required as specified in annotation by default" in new PropertiesScope[ModelWOptionIntSchemaOverrideForRequired](true) {
+  it should "prioritize required as specified in annotation by default" in new PropertiesScope[ModelWOptionIntSchemaOverrideForRequired](
+    true
+  ) {
     val requiredIntWithDefault = model.value.getProperties.get("requiredIntWithDefault")
     requiredIntWithDefault shouldBe an[IntegerSchema]
     requiredIntWithDefault.asInstanceOf[IntegerSchema].getDefault shouldEqual 5
@@ -416,8 +418,8 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
     stringsField shouldBe a[ArraySchema]
     val arraySchema = stringsField.asInstanceOf[ArraySchema]
     arraySchema.getUniqueItems() shouldBe (null)
-    arraySchema.getItems shouldBe a[ObjectSchema] //probably type erasure - ideally this would eval as StringSchema
-    //next line used to fail (https://github.com/swagger-akka-http/swagger-akka-http/issues/171)
+    arraySchema.getItems shouldBe a[ObjectSchema] // probably type erasure - ideally this would eval as StringSchema
+    // next line used to fail (https://github.com/swagger-akka-http/swagger-akka-http/issues/171)
     Json.mapper().writeValueAsString(model.value)
   }