Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gabro committed Aug 10, 2017
1 parent 3056dd8 commit ef136ee
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
6 changes: 3 additions & 3 deletions scalafix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Install the scalafix sbt plugin (globally or in a specific project):

```scala
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.5.0-M2")
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.5.0-M3")
```

run
Expand All @@ -26,12 +26,12 @@ sbt scalafix github:typelevel/cats/v1.0.0

- [x] traverse1_, intercalate1 and sequence1_ in Reducible were renamed to nonEmptyTraverse_, nonEmptyIntercalate and nonEmptySequence_ respectively.

- [x] cats.free.Inject is moved from cats-free to cats-core and renamed to cats.InjectK; cats.data.Prod is renamed to cats.data.Tuple2K; cats.data.Coproduct is renamed to cats.data.EitherK

# WIP

- [ ] cats no longer publishes the all-inclusive bundle package "org.typelevel" % "cats", use cats-core, cats-free, or cats-law accordingly instead. If you need cats.free, use "org.typelevel" % "cats-free", if you need cats-laws use "org.typelevel" % "cats-laws", if neither, use "org.typelevel" % "cats-core".

- [ ] cats.free.Inject is moved from cats-free to cats-core and renamed to cats.InjectK; cats.data.Prod is renamed to cats.data.Tuple2K; cats.data.Coproduct is renamed to cats.data.EitherK

- [ ] FunctorFilter, MonadCombine, MonadFilter, MonadReader, MonadState, MonadTrans, MonadWriter and TraverseFilter are no longer in cats, the functionalities they provided are inhereted by the new cats-mtl project. Please check here for migration guide.

- [ ] Apply syntax on tuple (e.g. (x, y, z).map3(...)) was moved from cats.syntax.tuple._ to cats.syntax.apply._ and renamed to mapN, contramapN and imapN respectively.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/*
rewrite = "scala:fix.v1_0_0.RenameInjectProdAndCoproduct"
*/
package fix
package to1_0_0

import cats.free.Inject
import cats.data.{ Coproduct, Prod }

object RenameInjectProdAndCoproductTests {
def inject[F[_], G[_]](implicit inj: Inject[F, G]) = ???
def prod[F[_], G[_], A](implicit prod: Prod[F, G, A]) = ???
def coprod[F[_], G[_], A](implicit coprod: Coproduct[F, G, A]) = ???
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package fix
package to1_0_0

import cats.InjectK
import cats.data.{ EitherK, Tuple2K }

object RenameInjectProdAndCoproductTests {
def inject[F[_], G[_]](implicit inj: InjectK[F, G]) = ???
def prod[F[_], G[_], A](implicit prod: Tuple2K[F, G, A]) = ???
def coprod[F[_], G[_], A](implicit coprod: EitherK[F, G, A]) = ???
}

0 comments on commit ef136ee

Please sign in to comment.