Wiringbits Scala Newbie Warts

Custom WartRemover warts from Wiringbits.

The collection intends to prevent common mistakes by developers that aren't very familiar with Scala.

For example, invoking UnsafeRunSync from cats-effect can lead to pretty bad application's behavior, with this library, you can prevent developers from invoking this method.

What's included

Cats Effect 2 Warts

• net.wiringbits.warts.UnsafeRunSync: Emits a warning when unsafeRunSync is invoked.
• net.wiringbits.warts.UnsafeRunAsyncAndForget: Emits a warning when unsafeRunAsyncAndForget is invoked.
• net.wiringbits.warts.UnsafeRunAsync: Emits a warning when unsafeRunAsync is invoked.
• net.wiringbits.warts.UnsafeRunCancelable: Emits a warning when unsafeRunCancelable is invoked.
• net.wiringbits.warts.UnsafeRunTimed: Emits a warning when unsafeRunTimed is invoked.
• net.wiringbits.warts.UnsafeToFuture: Emits a warning when unsafeToFuture is invoked.

Cats Effect 3 Warts

• net.wiringbits.warts.UnsafeRunSync: Emits a warning when unsafeRunSync is invoked.
• net.wiringbits.warts.UnsafeRunAndForget: Emits a warning when unsafeRunAndForget is invoked.
• net.wiringbits.warts.UnsafeRunAsync: Emits a warning when unsafeRunAsync is invoked.
• net.wiringbits.warts.UnsafeRunAsyncOutcome: Emits a warning when unsafeRunAsyncOutcome is invoked.
• net.wiringbits.warts.UnsafeRunCancelable: Emits a warning when unsafeRunCancelable is invoked.
• net.wiringbits.warts.UnsafeRunTimed: Emits a warning when unsafeRunTimed is invoked.
• net.wiringbits.warts.UnsafeToFuture: Emits a warning when unsafeToFuture is invoked.
• net.wiringbits.warts.UnsafeToFutureCancelable: Emits a warning when unsafeToFutureCancelable is invoked.

Usage

• Be sure to use wartremover in your project.
• Add the dependencies you are interested in:

// choose the modules you are interested in
lazy val wiringbitsWarts = List(
  "cats-effect-warts", // cats-effect 3
  "cats-effect2-warts" // cats-effect 2
)
libraryDependencies ++= wiringbitsWarts.map { customWart =>
  "net.wiringbits" %% customWart % "0.2.0" // pick the latest version
}
wartremoverClasspaths ++= {
  (Compile / dependencyClasspath).value.files
    .find(item => wiringbitsWarts.exists(item.name.contains))
    .map(_.toURI.toString)
    .toList
}

• Enable the warts:

wartremoverWarnings += Wart.custom("net.wiringbits.warts.UnsafeRunSync")

• Enable all unsafe warts:

wartremoverWarnings += Wart.custom("net.wiringbits.warts.Unsafe")

It is recommended to turn these warnings into errors when building the project in the CI.