Merge pull request #809 from olafurpg/apis

Second steps towards scalafix.v1

Author: olafurpg

build.sbt

@@ -38,6 +38,7 @@ lazy val core = project
     libraryDependencies ++= List(
       scalameta,
       symtab,
+      metap,
       googleDiff,
       "com.geirsson" %% "metaconfig-typesafe-config" % metaconfigV,
       "org.scala-lang" % "scala-reflect" % scalaVersion.value % Provided

docs/rule-authors/setup.md

@@ -56,10 +56,10 @@ scalafix-testkit features include:
 
 - Assert that a linter error is expected at a particular line by suffixing the
   line with the comment `// assert: <LintCategory>`. For an example, see the
-  NoInfer test suite:
+  Disable test suite:
 
 ```scala
-val x = List(1, "")// assert: NoInfer.any
+val x = List(1, "")// assert: Disable.Any
 ```
 
 It's also possible to assert the offset position and the message contents with a

docs/rules/DisableUnless.md

@@ -174,7 +174,7 @@ foo(null)
 ```
 
 ```scala
-List(1, "") // scalafix:ok NoInfer.any
+List(1, "") // scalafix:ok Disable.Any
 ```
 
 Optionally, you can include an arbitrary description at the end of any

docs/rules/ExplicitUnit.md

@@ -2,7 +2,7 @@ import sbt._
 /* scalafmt: { maxColumn = 120 }*/
 
 object Dependencies {
-  val scalametaV = "4.0.0-M8"
+  val scalametaV = "4.0.0-M10"
   val metaconfigV = "0.8.3"
   def dotty = "0.9.0-RC1"
   def scala210 = "2.10.6"
@@ -25,13 +25,14 @@ object Dependencies {
   def semanticdbPluginLibrary = "org.scalameta" % "semanticdb-scalac-core" % scalametaV cross CrossVersion.full
   def scalameta = "org.scalameta" %% "contrib" % scalametaV
   def symtab = "org.scalameta" %% "symtab" % scalametaV
+  def metap = "org.scalameta" %% "metap" % scalametaV
   def scalatest = "org.scalatest" %% "scalatest" % "3.2.0-SNAP10"
   def scalacheck = "org.scalacheck" %% "scalacheck" % "1.14.0"
 
   def testsDeps = List(
     // integration property tests
     "com.geirsson" %% "coursier-small" % "1.0.0-M4",
-    "org.renucci" %% "scala-xml-quote" % "0.1.4",
+    "org.scala-lang.modules" %% "scala-xml" % "1.1.0",
     "org.typelevel" %% "catalysts-platform" % "0.0.5",
     "org.typelevel" %% "cats-core" % "0.9.0",
     "com.typesafe.slick" %% "slick" % "3.2.0-M2",

docs/rules/NoFinalize.md

@@ -61,8 +61,6 @@ object ScalafixBuild extends AutoPlugin with GhpagesKeys {
     )
 
     lazy val testsInputOutputSetting = Seq(
-      // TODO: Remove once scala-xml-quote is merged into scala-xml
-      resolvers += Resolver.bintrayRepo("allanrenucci", "maven"),
       libraryDependencies ++= testsDeps
     )
 

docs/rules/NoInfer.md

@@ -5,10 +5,11 @@ import scalafix.interfaces.ScalafixDiagnostic
 import scalafix.interfaces.ScalafixMainCallback
 import scalafix.internal.config
 import scalafix.internal.config.ScalafixReporter
-import scalafix.internal.util.LintSyntax
-import scalafix.lint.LintDiagnostic
+import scalafix.lint.Diagnostic
+import scalafix.lint.RuleDiagnostic
 import scalafix.lint.LintID
 import scalafix.lint.LintSeverity
+import scalafix.rule.RuleName
 
 object MainCallbackImpl {
 
@@ -31,13 +32,16 @@ object MainCallbackImpl {
 
   def fromJava(underlying: ScalafixMainCallback): ScalafixReporter =
     new ScalafixReporter {
-      override def lint(d: LintDiagnostic): Unit = {
-        val diagnostic = ScalafixDiagnosticImpl.fromScala(d)
+      override def lint(ruleDiagnostic: RuleDiagnostic): Unit = {
+        val diagnostic = ScalafixDiagnosticImpl.fromScala(ruleDiagnostic)
         underlying.reportDiagnostic(diagnostic)
       }
       def report(msg: String, pos: Position, sev: LintSeverity): Unit = {
         val diagnostic = ScalafixDiagnosticImpl.fromScala(
-          new LintSyntax.EagerLintDiagnostic(msg, pos, sev, "", LintID.empty)
+          RuleDiagnostic(
+            Diagnostic(id = "", msg, pos, "", sev),
+            RuleName.empty,
+            None)
         )
         underlying.reportDiagnostic(diagnostic)
       }

docs/rules/RemoveXmlLiterals.md

@@ -1,66 +1,46 @@
 package scalafix.internal.interfaces
 import java.util.Optional
-import scala.meta.inputs.Input
-import scala.meta.inputs.Position
 import scalafix.interfaces.ScalafixDiagnostic
 import scalafix.interfaces.ScalafixLintID
 import scalafix.interfaces.ScalafixPosition
 import scalafix.interfaces.ScalafixSeverity
-import scalafix.lint.LintDiagnostic
 import scalafix.lint.LintID
 import scalafix.lint.LintSeverity
+import scalafix.lint.RuleDiagnostic
 
 object ScalafixDiagnosticImpl {
-  def fromScala(diagnostic: LintDiagnostic): ScalafixDiagnostic =
-    new ScalafixDiagnostic {
-      override def severity(): ScalafixSeverity = diagnostic.severity match {
-        case LintSeverity.Info => ScalafixSeverity.INFO
-        case LintSeverity.Warning => ScalafixSeverity.WARNING
-        case LintSeverity.Error => ScalafixSeverity.ERROR
-      }
-      override def message(): String = diagnostic.message
-      override def explanation(): String = diagnostic.explanation
-      override def position(): Optional[ScalafixPosition] =
-        PositionImpl.optionalFromScala(diagnostic.position)
-      override def lintID(): Optional[ScalafixLintID] =
-        if (diagnostic.id == LintID.empty) {
-          Optional.empty()
-        } else {
-          Optional.of(new ScalafixLintID {
-            override def ruleName(): String = diagnostic.id.rule
-            override def categoryID(): String = diagnostic.id.categoryID
-          })
-        }
+  def fromScala(diagnostic: RuleDiagnostic): ScalafixDiagnostic =
+    DelegateJavaDiagnostic(diagnostic)
+
+  def fromJava(scalafixDiagnostic: ScalafixDiagnostic): RuleDiagnostic = {
+    scalafixDiagnostic match {
+      case DelegateJavaDiagnostic(underlying) =>
+        underlying
+      case _ =>
+        throw new IllegalArgumentException(
+          "Unexpected diagnostic: " + scalafixDiagnostic.toString)
     }
+  }
+}
 
-  def fromJava(diagnostic: ScalafixDiagnostic): LintDiagnostic =
-    new LintDiagnostic {
-      override def message: String = diagnostic.message()
-      override def position: Position = {
-        if (diagnostic.position().isPresent) {
-          val spos = diagnostic.position().get
-          val input = Input.VirtualFile(
-            spos.input().filename(),
-            spos.input().text().toString
-          )
-          Position.Range(input, spos.startOffset(), spos.endOffset())
-        } else {
-          Position.None
-        }
-      }
-      override def severity: LintSeverity = diagnostic.severity() match {
-        case ScalafixSeverity.INFO => LintSeverity.Info
-        case ScalafixSeverity.WARNING => LintSeverity.Warning
-        case ScalafixSeverity.ERROR => LintSeverity.Error
-      }
-      override def explanation: String = diagnostic.explanation()
-      override def id: LintID = {
-        if (diagnostic.lintID().isPresent) {
-          val lintID = diagnostic.lintID().get
-          LintID(lintID.ruleName(), lintID.categoryID())
-        } else {
-          LintID.empty
-        }
-      }
+case class DelegateJavaDiagnostic(diagnostic: RuleDiagnostic)
+    extends ScalafixDiagnostic {
+  override def severity(): ScalafixSeverity = diagnostic.severity match {
+    case LintSeverity.Info => ScalafixSeverity.INFO
+    case LintSeverity.Warning => ScalafixSeverity.WARNING
+    case LintSeverity.Error => ScalafixSeverity.ERROR
+  }
+  override def message(): String = diagnostic.message
+  override def explanation(): String = diagnostic.explanation
+  override def position(): Optional[ScalafixPosition] =
+    PositionImpl.optionalFromScala(diagnostic.position)
+  override def lintID(): Optional[ScalafixLintID] =
+    if (diagnostic.id == LintID.empty) {
+      Optional.empty()
+    } else {
+      Optional.of(new ScalafixLintID {
+        override def ruleName(): String = diagnostic.id.rule
+        override def categoryID(): String = diagnostic.id.category
+      })
     }
 }

docs/users/configuration.md

@@ -4,7 +4,6 @@ import metaconfig.generic.Setting
 import metaconfig.generic.Settings
 import metaconfig.internal.Case
 import org.apache.commons.text.StringEscapeUtils
-import scalafix.rule.ScalafixRules
 
 object CompletionsOps {
   private def option(kebab: String): String =
@@ -47,7 +46,7 @@ object CompletionsOps {
   }
 
   private def zshNames: String =
-    ScalafixRules.allNamesDescriptions
+    Rules.allNamesDescriptions
       .map {
         case (name, description) =>
           s""""$name[${StringEscapeUtils.escapeXSI(description)}]""""
@@ -62,7 +61,7 @@ _scalafix()
     COMPREPLY=()
     cur="$${COMP_WORDS[COMP_CWORD]}"
     prev="$${COMP_WORDS[COMP_CWORD-1]}"
-    rules="${ScalafixRules.allNames.mkString(" ")}"
+    rules="${Rules.allNames.mkString(" ")}"
     opts="$bashArgs"
 
     case "$${prev}" in