Skip to content

Commit 81951b1

Browse files
committed
support additional message
1 parent 63dfe3f commit 81951b1

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ scalafix dependency:[email protected]::scalafix-rules:0.1.0
2323

2424
### NoFutureTraverse
2525

26-
Warns against or disallows the use of `Future.traverse` in your Scala code, to prevent a potentially unbounded number of concurrent tasks from being run at once.
26+
Warns against or disallows the use of `Future.traverse` and `Future.sequence` in your Scala code, to prevent a potentially unbounded number of concurrent tasks from being run at once.
2727

2828
```hocon
2929
rules = [
@@ -32,6 +32,7 @@ rules = [
3232
]
3333
3434
NoFutureTraverse {
35-
isError = true # Whether to treat violations as errors (default: false)
35+
isError = false # Whether to treat violations as errors (default: false)
36+
extraMessage = null # Additional deprecation message. Can be used to suggest an alternative.
3637
}
3738
```

rules/src/main/scala/fix/NoFutureTraverse.scala

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ import scalafix.lint._
88
import scalafix.v1._
99

1010
case class NoFutureTraverseConfig(
11-
isError: Boolean = false
11+
isError: Boolean = false,
12+
extraMessage: Option[String] = None
1213
)
1314
object NoFutureTraverseConfig {
1415
implicit val surface: Surface[NoFutureTraverseConfig] =
@@ -20,7 +21,7 @@ object NoFutureTraverseConfig {
2021
class NoFutureTraverse(config: NoFutureTraverseConfig) extends SemanticRule("NoFutureTraverse") {
2122

2223
case class Deprecation(position: Position, name: String) extends Diagnostic {
23-
override def message = s"$name is deprecated"
24+
override def message = s"$name is deprecated${config.extraMessage.map(s => s": $s").getOrElse("")}"
2425
override def severity =
2526
if (config.isError) LintSeverity.Error else LintSeverity.Warning
2627
}

0 commit comments

Comments
 (0)