Merge pull request #500 from MasseGuillaume/feature/495-custom-id

Add id for CustomMessage (fix #495)

project/Dependencies.scala

@@ -4,7 +4,7 @@ import org.scalajs.sbtplugin.ScalaJSPlugin.autoImport._
 
 object Dependencies {
   val scalametaV = "2.1.2"
-  val metaconfigV = "0.5.3"
+  val metaconfigV = "0.5.4"
   def semanticdbSbt = "0.4.0"
   def dotty = "0.1.1-bin-20170530-f8f52cc-NIGHTLY"
   def scala210 = "2.10.6"

scalafix-core/shared/src/main/scala/scalafix/config/CustomMessage.scala

@@ -0,0 +1,38 @@
+package scalafix
+package config
+
+import metaconfig.{Conf, ConfError, ConfDecoder, Configured, Metaconfig}
+import org.langmeta._
+import scalafix.internal.config.MetaconfigPendingUpstream.XtensionConfScalafix
+
+import scala.language.implicitConversions
+
+class CustomMessage[T](
+    val value: T,
+    val message: Option[String],
+    val id: Option[String])
+
+object CustomMessage {
+  def decoder[T](field: String)(
+      implicit ev: ConfDecoder[T]): ConfDecoder[CustomMessage[T]] =
+    ConfDecoder.instance[CustomMessage[T]] {
+      case obj: Conf.Obj => {
+        (obj.get[T](field) |@|
+          obj.getOption[String]("message") |@|
+          obj.getOption[String]("id")).map {
+          case ((value, message0), id) =>
+            val message =
+              message0.map(msg =>
+                if (msg.isMultiline) {
+                  "\n" + msg.stripMargin
+                } else {
+                  msg
+              })
+
+            new CustomMessage(value, message, id)
+        }
+      }
+      case els =>
+        ev.read(els).map(value => new CustomMessage(value, None, None))
+    }
+}

scalafix-core/shared/src/main/scala/scalafix/internal/config/DisableConfig.scala

@@ -1,4 +1,5 @@
-package scalafix.internal.config
+package scalafix
+package internal.config
 
 import metaconfig.ConfDecoder
 import MetaconfigPendingUpstream.XtensionConfScalafix
@@ -8,14 +9,13 @@ import scalafix.internal.util.SymbolOps
 case class DisableConfig(symbols: List[CustomMessage[Symbol.Global]] = Nil) {
   def allSymbols = symbols.map(_.value)
 
-  private val messageBySymbol: Map[String, String] =
+  private val messageBySymbol: Map[String, CustomMessage[Symbol.Global]] =
     symbols
-      .flatMap(custom =>
-        custom.message.map(message =>
-          (SymbolOps.normalize(custom.value).syntax, message)))
+      .map(custom => (SymbolOps.normalize(custom.value).syntax, custom))
       .toMap
 
-  def customMessage(symbol: Symbol.Global): Option[String] =
+  def customMessage(
+      symbol: Symbol.Global): Option[CustomMessage[Symbol.Global]] =
     messageBySymbol.get(SymbolOps.normalize(symbol).syntax)
 
   implicit val customMessageReader: ConfDecoder[CustomMessage[Symbol.Global]] =

scalafix-core/shared/src/main/scala/scalafix/internal/config/DisableSyntaxConfig.scala

@@ -1,4 +1,5 @@
-package scalafix.internal.config
+package scalafix
+package internal.config
 
 import metaconfig.{Conf, ConfError, ConfDecoder, Configured}
 import org.langmeta._

scalafix-core/shared/src/main/scala/scalafix/internal/rule/Disable.scala

@@ -51,11 +51,18 @@ final case class Disable(index: SemanticdbIndex, config: DisableConfig)
         case _ =>
           "" -> pos
       }
-      val message = config
-        .customMessage(symbol)
+      val custom = config.customMessage(symbol)
+
+      val message = custom
+        .flatMap(_.message)
         .getOrElse(s"${signature.name} is disabled$details")
+
+      val id = custom
+        .flatMap(_.id)
+        .getOrElse(signature.name)
+
       errorCategory
-        .copy(id = signature.name)
+        .copy(id = id)
         .at(message, caret)
     }
   }

scalafix-core/shared/src/main/scala/scalafix/internal/rule/DisableSyntax.scala

@@ -35,7 +35,7 @@ final case class DisableSyntax(
       while (matcher.find()) {
         regexLintMessages +=
           errorCategory
-            .copy(id = pattern)
+            .copy(id = regex.id.getOrElse(pattern))
             .at(message, pos(matcher.start))
       }
     }

scalafix-core/shared/src/main/scala/scalafix/package.scala

@@ -34,6 +34,9 @@ package object scalafix {
   @deprecated("Renamed to Rule", "0.5.0")
   val Rewrite = rule.Rule
 
+  type CustomMessage[T] = scalafix.config.CustomMessage[T]
+  val CustomMessage = scalafix.config.CustomMessage
+
   type SemanticRule = rule.SemanticRule
   type Rule = rule.Rule
   val Rule = rule.Rule

scalafix-tests/input/src/main/scala/test/Disable.scala

@@ -5,6 +5,7 @@ Disable.symbols = [
   "test.Disable.D.disabledFunction"
   {
     symbol = "scala.Option.get"
+    id = "Option.get"
     message =
       """|Option.get is the root of all evils
          |
@@ -47,7 +48,7 @@ case object Disable {
     def asInstanceOf: O = "test"
   }
   val yy = AA.asInstanceOf // OK, no errors
-  Option(1).get /* assert: Disable.get
+  Option(1).get /* assert: Disable.Option.get
             ^
 Option.get is the root of all evils
 

scalafix-tests/input/src/main/scala/test/DisableSyntax.scala

@@ -11,6 +11,7 @@ DisableSyntax.noSemicolons = true
 DisableSyntax.noXml = true
 DisableSyntax.regex = [
   {
+    id = offensive
     pattern = "[P|p]imp"
     message = "Please consider a less offensive word such as Extension"
   }
@@ -39,7 +40,7 @@ case object DisableSyntax {
   <a>xml</a>                // assert: DisableSyntax.noXml
 	                          // assert: DisableSyntax.noTabs
 
-  implicit class StringPimp(value: String) { // assert: DisableSyntax.[P|p]imp
+  implicit class StringPimp(value: String) { // assert: DisableSyntax.offensive
     def -(other: String): String = s"$value - $other"
   }