Add scalafmt plugin to scala-sttp4-jsoniter client generator (#23378)

YB0y · web-flow · commit ab17676651fc · 2026-04-01T01:17:28.000+08:00
* Add scalafmt plugin to scala-sttp4-jsoniter client generator

* Regenerate samples after rebase
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaSttp4JsoniterClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaSttp4JsoniterClientCodegen.java
@@ -187,6 +187,8 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("helpers.mustache", invokerFolder,
                 "Helpers.scala"));
         supportingFiles.add(new SupportingFile("project/build.properties.mustache", "project", "build.properties"));
+        supportingFiles.add(new SupportingFile("project/plugins.mustache", "project", "plugins.sbt"));
+        supportingFiles.add(new SupportingFile("scalafmt.mustache", "", ".scalafmt.conf"));
     }
 
     @Override
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/project/plugins.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/project/plugins.mustache
@@ -0,0 +1 @@
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.6")
diff --git a/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/scalafmt.mustache b/modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/scalafmt.mustache
@@ -0,0 +1,58 @@
+version=3.10.6
+runner.dialect = scala213
+project {
+  git = false
+  excludeFilters = [
+    scalafmt-benchmarks/src/resources,
+    sbt-test
+    bin/issue
+  ]
+  layout = StandardConvention
+}
+align {
+  preset = none
+  stripMargin = true
+}
+binPack {
+  importSelectors = fold
+}
+newlines {
+  avoidForSimpleOverflow = all
+  ignoreInSyntax = false
+  source = fold
+}
+rewrite {
+  rules = [
+    AvoidInfix,
+    Imports,
+    RedundantBraces,
+    RedundantParens,
+    SortModifiers,
+  ]
+  imports {
+    selectors = fold
+    removeRedundantSelectors = true
+    sort = ascii
+    groups = [
+      ["org\\.scalafmt\\..*"],
+      ["scala\\.meta\\..*", "org\\.scalameta\\..*"],
+      ["sbt\\..*"],
+      ["java.?\\..*"],
+      ["scala\\..*"],
+      ["org\\..*"],
+      ["com\\..*"],
+    ]
+  }
+  redundantBraces {
+    preset = all
+    oneStatApply {
+      parensMaxSpan = 300
+      bracesMinSpan = 300
+    }
+  }
+  redundantParens {
+    preset = all
+  }
+  sortModifiers.preset = styleGuide
+  trailingCommas.style = "always"
+}
diff --git a/samples/client/petstore/scala-sttp4-jsoniter/.openapi-generator/FILES b/samples/client/petstore/scala-sttp4-jsoniter/.openapi-generator/FILES
@@ -1,6 +1,8 @@
+.scalafmt.conf
 README.md
 build.sbt
 project/build.properties
+project/plugins.sbt
 src/main/scala/org/openapitools/client/api/PetApi.scala
 src/main/scala/org/openapitools/client/api/StoreApi.scala
 src/main/scala/org/openapitools/client/api/UserApi.scala
diff --git a/samples/client/petstore/scala-sttp4-jsoniter/.scalafmt.conf b/samples/client/petstore/scala-sttp4-jsoniter/.scalafmt.conf
@@ -0,0 +1,58 @@
+version=3.10.6
+runner.dialect = scala213
+project {
+  git = false
+  excludeFilters = [
+    scalafmt-benchmarks/src/resources,
+    sbt-test
+    bin/issue
+  ]
+  layout = StandardConvention
+}
+align {
+  preset = none
+  stripMargin = true
+}
+binPack {
+  importSelectors = fold
+}
+newlines {
+  avoidForSimpleOverflow = all
+  ignoreInSyntax = false
+  source = fold
+}
+rewrite {
+  rules = [
+    AvoidInfix,
+    Imports,
+    RedundantBraces,
+    RedundantParens,
+    SortModifiers,
+  ]
+  imports {
+    selectors = fold
+    removeRedundantSelectors = true
+    sort = ascii
+    groups = [
+      ["org\\.scalafmt\\..*"],
+      ["scala\\.meta\\..*", "org\\.scalameta\\..*"],
+      ["sbt\\..*"],
+      ["java.?\\..*"],
+      ["scala\\..*"],
+      ["org\\..*"],
+      ["com\\..*"],
+    ]
+  }
+  redundantBraces {
+    preset = all
+    oneStatApply {
+      parensMaxSpan = 300
+      bracesMinSpan = 300
+    }
+  }
+  redundantParens {
+    preset = all
+  }
+  sortModifiers.preset = styleGuide
+  trailingCommas.style = "always"
+}
diff --git a/samples/client/petstore/scala-sttp4-jsoniter/project/plugins.sbt b/samples/client/petstore/scala-sttp4-jsoniter/project/plugins.sbt
@@ -0,0 +1 @@
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.6")
diff --git a/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/README.md b/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/README.md
@@ -1,4 +1,4 @@
-# org.openapitools.server - Kotlin Server library for Polymorphism example with allOf and discriminator
+# org.openapitools.server - Kotlin Server library for Basic polymorphism example with discriminator
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
diff --git a/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/src/main/kotlin/org/openapitools/server/models/Cat.kt b/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/src/main/kotlin/org/openapitools/server/models/Cat.kt
@@ -1,5 +1,5 @@
 /**
- * Polymorphism example with allOf and discriminator
+ * Basic polymorphism example with discriminator
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: 1.0
@@ -11,24 +11,22 @@
 */
 package org.openapitools.server.models
 
-import org.openapitools.server.models.Pet
 
 /**
- * A representation of a cat
+ * A pet cat
  * @param huntingSkill The measured skill for hunting
+ * @param petType 
  */
 data class Cat(
     /* The measured skill for hunting */
     
     @field:com.fasterxml.jackson.annotation.JsonProperty("huntingSkill")
     val huntingSkill: Cat.HuntingSkill,
     
-    @field:com.fasterxml.jackson.annotation.JsonProperty("name")
-    override val name: kotlin.String,
-    
     @field:com.fasterxml.jackson.annotation.JsonProperty("petType")
-    override val petType: kotlin.String
-) : Pet(name = name, petType = petType)
+    override val petType: kotlin.String = "cat",
+
+) : Pet(petType = petType)
 {
     /**
     * The measured skill for hunting
diff --git a/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/src/main/kotlin/org/openapitools/server/models/Dog.kt b/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/src/main/kotlin/org/openapitools/server/models/Dog.kt
@@ -1,5 +1,5 @@
 /**
- * Polymorphism example with allOf and discriminator
+ * Basic polymorphism example with discriminator
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: 1.0
@@ -11,24 +11,19 @@
 */
 package org.openapitools.server.models
 
-import org.openapitools.server.models.Pet
 
 /**
- * A representation of a dog
+ * A pet dog
+ * @param petType 
  * @param packSize the size of the pack the dog is from
  */
 data class Dog(
+    
+    @field:com.fasterxml.jackson.annotation.JsonProperty("petType")
+    override val petType: kotlin.String = "dog",
     /* the size of the pack the dog is from */
     
     @field:com.fasterxml.jackson.annotation.JsonProperty("packSize")
-    val packSize: kotlin.Int = 0,
-    
-    @field:com.fasterxml.jackson.annotation.JsonProperty("name")
-    override val name: kotlin.String,
-    
-    @field:com.fasterxml.jackson.annotation.JsonProperty("petType")
-    override val petType: kotlin.String
-) : Pet(name = name, petType = petType)
-{
-}
+    val packSize: kotlin.Int = 0
+) : Pet(petType = petType)
 
diff --git a/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/src/main/kotlin/org/openapitools/server/models/Pet.kt b/samples/server/others/kotlin-server/polymorphism-allof-and-discriminator/src/main/kotlin/org/openapitools/server/models/Pet.kt
@@ -1,5 +1,5 @@
 /**
- * Polymorphism example with allOf and discriminator
+ * Basic polymorphism example with discriminator
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: 1.0
@@ -11,23 +11,20 @@
 */
 package org.openapitools.server.models
 
+import org.openapitools.server.models.Cat
+import org.openapitools.server.models.Dog
 
 /**
  * 
- * @param name 
  * @param petType 
  */
 @com.fasterxml.jackson.annotation.JsonTypeInfo(use = com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME, include = com.fasterxml.jackson.annotation.JsonTypeInfo.As.PROPERTY, property = "petType", visible = true)
 @com.fasterxml.jackson.annotation.JsonSubTypes(
-    com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = Cat::class, name = "Cat"),
-    com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = Dog::class, name = "Dog")
+    com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = Cat::class, name = "cat"),
+    com.fasterxml.jackson.annotation.JsonSubTypes.Type(value = Dog::class, name = "dog")
 )
 sealed class Pet(
     
-    @field:com.fasterxml.jackson.annotation.JsonProperty("name")
-    open val name: kotlin.String
-,
-    
     @field:com.fasterxml.jackson.annotation.JsonProperty("petType")
     open val petType: kotlin.String
 

Original file line number	Diff line number	Diff line change
`@@ -187,6 +187,8 @@ public void processOpts() {`
`187`	`187`	`supportingFiles.add(new SupportingFile("helpers.mustache", invokerFolder,`
`188`	`188`	`"Helpers.scala"));`
`189`	`189`	`supportingFiles.add(new SupportingFile("project/build.properties.mustache", "project", "build.properties"));`
	`190`	`+ supportingFiles.add(new SupportingFile("project/plugins.mustache", "project", "plugins.sbt"));`
	`191`	`+ supportingFiles.add(new SupportingFile("scalafmt.mustache", "", ".scalafmt.conf"));`
`190`	`192`	`}`
`191`	`193`
`192`	`194`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.6")`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# org.openapitools.server - Kotlin Server library for Polymorphism example with allOf and discriminator`
	`1`	`+# org.openapitools.server - Kotlin Server library for Basic polymorphism example with discriminator`
`2`	`2`
`3`	`3`	`No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)`
`4`	`4`