feat: add Scalafix rule for organizing imports (#348)

sbt · Jan 18, 2022 · 3b603d9 · 3b603d9
1 parent 01628a1
commit 3b603d9
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 4 deletions.
diff --git a/.scalafix.conf b/.scalafix.conf
@@ -0,0 +1,12 @@
+OrganizeImports {
+  blankLines = Manual
+  coalesceToWildcardImportThreshold = null
+  expandRelative = false
+  groupExplicitlyImportedImplicitsSeparately = false
+  groupedImports = AggressiveMerge
+  groups = [ "*" ]
+  importSelectorsOrder = Ascii
+  importsOrder = Ascii
+  preset = DEFAULT
+  removeUnused = true
+}
diff --git a/.scalafmt.conf b/.scalafmt.conf
@@ -7,7 +7,8 @@ maxColumn                        = 100
 indentOperator.preset            = "spray"
 unindentTopLevelOperators        = true
 spaces.inImportCurlyBraces       = true
-rewrite.rules                    = ["AsciiSortImports", "RedundantBraces", "RedundantParens"]
+rewrite.rules                    = ["Imports", "RedundantBraces", "RedundantParens"]
+rewrite.imports.sort             = "ascii"
 docstrings.blankFirstLine        = true
 trailingCommas                   = "preserve"
 newlines.beforeCurlyLambdaParams = "multilineWithCaseOnly"
diff --git a/src/main/scala/de/heikoseeberger/sbtfresh/Fresh.scala b/src/main/scala/de/heikoseeberger/sbtfresh/Fresh.scala
@@ -68,7 +68,10 @@ private final class Fresh(
   def writeReadme(): Path =
     write("README.md", Template.readme(name, license))
 
-  def writeScalafmt(): Path =
+  def writeScalafixConf(): Path =
+    write(".scalafix.conf", Template.scalafixConf)
+
+  def writeScalafmtConf(): Path =
     write(".scalafmt.conf", Template.scalafmtConf)
 
   private def write(path: String, content: String) =

diff --git a/src/main/scala/de/heikoseeberger/sbtfresh/FreshPlugin.scala b/src/main/scala/de/heikoseeberger/sbtfresh/FreshPlugin.scala
@@ -122,7 +122,8 @@ object FreshPlugin extends AutoPlugin {
     fresh.writeNotice()
     fresh.writePlugins()
     fresh.writeReadme()
-    fresh.writeScalafmt()
+    fresh.writeScalafixConf()
+    fresh.writeScalafmtConf()
     if (setUpGit) fresh.initialCommit()
 
     state.reboot(true)

diff --git a/src/main/scala/de/heikoseeberger/sbtfresh/Template.scala b/src/main/scala/de/heikoseeberger/sbtfresh/Template.scala
@@ -202,6 +202,20 @@ private object Template {
         |""".stripMargin
   }
 
+  def scalafixConf: String =
+    """|OrganizeImports {
+       |  blankLines = Manual
+       |  coalesceToWildcardImportThreshold = null
+       |  expandRelative = false
+       |  groupExplicitlyImportedImplicitsSeparately = false
+       |  groupedImports = AggressiveMerge
+       |  groups = [ "*" ]
+       |  importSelectorsOrder = Ascii
+       |  importsOrder = Ascii
+       |  preset = DEFAULT
+       |  removeUnused = true
+       |}""".stripMargin
+
   def scalafmtConf: String =
     """|version = "3.3.1"
        |
@@ -212,7 +226,8 @@ private object Template {
        |indentOperator.preset            = "spray"
        |unindentTopLevelOperators        = true
        |spaces.inImportCurlyBraces       = true
-       |rewrite.rules                    = ["AsciiSortImports", "RedundantBraces", "RedundantParens"]
+       |rewrite.rules                    = ["Imports", "RedundantBraces", "RedundantParens"]
+       |rewrite.imports.sort             = "ascii"
        |docstrings.blankFirstLine        = true
        |trailingCommas                   = "preserve"
        |newlines.beforeCurlyLambdaParams = "multilineWithCaseOnly"

diff --git a/src/sbt-test/sbt-fresh/default/test b/src/sbt-test/sbt-fresh/default/test
@@ -1,5 +1,6 @@
 > fresh organization=org name=acme setUpGit=true
 $ exists .gitignore
+$ exists .scalafix.conf
 $ exists .scalafmt.conf
 $ exists build.sbt
 $ exists LICENSE