Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support Rename in SyntacticOrganizeImports #148

Merged
merged 1 commit into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ package fix
import scala.collection.concurrent
import scala.util.Random // assert: SyntacticOrganizeImports
import scala.collection.mutable
// assert: SyntacticOrganizeImports
import scala.collection.mutable.SortedMap
import scala.collection.mutable.SortedSet

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*
rule = SyntacticOrganizeImports
*/
package fix

import scala.collection.mutable.ArrayBuffer as A // assert: SyntacticOrganizeImports
import scala.collection.mutable.SortedMap

class SyntacticOrganizeImportsTest3
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*
rule = SyntacticOrganizeImports
*/
package fix

import scala.collection.mutable.{ArrayBuffer => A} // assert: SyntacticOrganizeImports
import scala.collection.mutable.SortedMap

class SyntacticOrganizeImportsTest4
86 changes: 60 additions & 26 deletions rules/src/main/scala/fix/SyntacticOrganizeImports.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import scalafix.Patch
import scalafix.v1.SyntacticDocument
import scalafix.v1.SyntacticRule
import scala.meta.Import
import scala.meta.Importer
import scala.meta.Importee
import scala.meta.Pkg
import scala.meta.inputs.Position
Expand All @@ -26,50 +27,68 @@ class SyntacticOrganizeImports extends SyntacticRule("SyntacticOrganizeImports")
loop(list, Nil).reverse
}

private def importToString(i: Import): String = {
val s = i.toString
if (i.importers.forall(_.importees.forall(!_.is[Importee.Wildcard]))) {
s
} else {
// for consistency OrganizeImports
// TODO https://github.com/scalacenter/scalafix/pull/1896 ?
val wildcardNewStyle = ".*"
if (s.endsWith(wildcardNewStyle)) {
s"${s.dropRight(wildcardNewStyle.length)}._"
} else {
s
}
private def importToString(importer: Importer): String = {
importer.pos match {
case _: Position.Range =>
val s = importer.syntax
// for consistency OrganizeImports
// TODO https://github.com/scalacenter/scalafix/pull/1896 ?
val wildcardNewStyle = ".*"
if (s.endsWith(wildcardNewStyle)) {
s"${s.dropRight(wildcardNewStyle.length)}._"
} else {
s
}
case Position.None =>
// for consistency OrganizeImports
// https://github.com/scalacenter/scalafix/blob/3ca6e5a129bb070bfa/scalafix-rules/src/main/scala/scalafix/internal/rule/OrganizeImports.scala#L798-L821
val syntax = importer.syntax

(isCurlyBraced(importer), syntax lastIndexOfSlice " }") match {
case (_, -1) =>
syntax
case (true, index) =>
syntax.patch(index, "}", 2).replaceFirst("\\{ ", "{")
case _ =>
syntax
}
}
}

override def fix(implicit doc: SyntacticDocument): Patch = {
doc.tree.collect { case p: Pkg =>
// find top-level imports
val imports = collectWhile(p.stats.dropWhile(!_.is[Import])) { case i: Import => i }.sortBy(_.pos.startLine)
// exclude Rename or multi Importees
val maybeMultiLine = imports.forall(_.importers.forall(_.importees.forall(!_.is[Importee.Rename])))
if (imports.nonEmpty && maybeMultiLine) {
val importers = imports.map(_.importers).collect { case i :: Nil => i }
if (imports.nonEmpty && (imports.lengthCompare(importers.size) == 0)) {
val start = imports.map(_.pos.startLine).min
val end = imports.map(_.pos.endLine).max

Seq(
imports.tail.zip(imports).find { case (x1, x2) => (x1.pos.startLine - x2.pos.startLine) != 1 }.map {
case (_, value) =>
doc.input.text.linesIterator.zipWithIndex
.slice(start, end + 1)
.filter(_._1.trim.isEmpty)
.map { case (_, emptyLineNumber) =>
Patch.lint(
SyntacticOrganizeImportsWarn(
Position.Range(
input = value.pos.input,
startLine = value.pos.startLine + 1,
input = doc.input,
startLine = emptyLineNumber,
startColumn = 0,
endLine = value.pos.startLine + 1,
endLine = emptyLineNumber + 1,
endColumn = 0
),
"there is empty line in top level imports"
)
)
},
imports
}
.toList
.asPatch,
importers
.sortBy(importToString)
.zip(imports)
.zip(importers)
.find { case (x1, x2) =>
x1.toString != x2.toString
importToString(x1) != importToString(x2)
}
.map { case (_, value) =>
Patch.lint(
Expand All @@ -79,12 +98,27 @@ class SyntacticOrganizeImports extends SyntacticRule("SyntacticOrganizeImports")
)
)
}
).flatten.asPatch
.asPatch
).asPatch
} else {
Patch.empty
}
}.asPatch
}

// https://github.com/scalacenter/scalafix/blob/3ca6e5a129bb070bfa/scalafix-rules/src/main/scala/scalafix/internal/rule/OrganizeImports.scala#L975-L980
private def isCurlyBraced(importer: Importer): Boolean = {
(importer.importees.size > 1) || {
importer.importees.exists {
case _: Importee.Rename =>
true
case _: Importee.Unimport =>
true
case _ =>
false
}
}
}
}

case class SyntacticOrganizeImportsWarn(
Expand Down
3 changes: 3 additions & 0 deletions sbt-test/SyntacticOrganizeImports/test-1/.scalafix.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
rules = [
SyntacticOrganizeImports
]
10 changes: 10 additions & 0 deletions sbt-test/SyntacticOrganizeImports/test-1/A.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package foo

import scala.util.Random

import scala.util.Success


import scala.util.Try

trait A
1 change: 1 addition & 0 deletions sbt-test/SyntacticOrganizeImports/test-1/build.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ThisBuild / scalafixDependencies += "com.github.xuwei-k" %% "scalafix-rules" % sys.props("scalafix-rules.version")
67 changes: 67 additions & 0 deletions sbt-test/SyntacticOrganizeImports/test-1/expect.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
[{
"message": "[SyntacticOrganizeImports] there is empty line in top level imports",
"position": {
"line": 3,
"lineContent": "",
"sourcePath": "${BASE}/A.scala",
"startLine": 3,
"startColumn": 0,
"endLine": 4,
"endColumn": 0
}
}, {
"message": "[SyntacticOrganizeImports] there is empty line in top level imports",
"position": {
"line": 5,
"lineContent": "",
"sourcePath": "${BASE}/A.scala",
"startLine": 5,
"startColumn": 0,
"endLine": 6,
"endColumn": 0
}
}, {
"message": "[SyntacticOrganizeImports] there is empty line in top level imports",
"position": {
"line": 6,
"lineContent": "",
"sourcePath": "${BASE}/A.scala",
"startLine": 6,
"startColumn": 0,
"endLine": 7,
"endColumn": 0
}
}, {
"message": "[SyntacticOrganizeImports] there is empty line in top level imports",
"position": {
"line": 3,
"lineContent": "",
"sourcePath": "${BASE}/A.scala",
"startLine": 3,
"startColumn": 0,
"endLine": 4,
"endColumn": 0
}
}, {
"message": "[SyntacticOrganizeImports] there is empty line in top level imports",
"position": {
"line": 5,
"lineContent": "",
"sourcePath": "${BASE}/A.scala",
"startLine": 5,
"startColumn": 0,
"endLine": 6,
"endColumn": 0
}
}, {
"message": "[SyntacticOrganizeImports] there is empty line in top level imports",
"position": {
"line": 6,
"lineContent": "",
"sourcePath": "${BASE}/A.scala",
"startLine": 6,
"startColumn": 0,
"endLine": 7,
"endColumn": 0
}
}]
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("scalafix.version"))
addSbtPlugin("com.github.xuwei-k" % "warning-diff-scalafix-plugin" % "0.2.1")
2 changes: 2 additions & 0 deletions sbt-test/SyntacticOrganizeImports/test-1/test
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
> warningsAll
$ must-mirror target/warnings/warnings.json expect.json