Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pureharm/pureharm-effects-cats
cats + cats-effect + fs2 modules of "pureharm"
https://github.com/pureharm/pureharm-effects-cats
cats-effect fs2 pureharm scala
Last synced: 5 days ago
JSON representation
cats + cats-effect + fs2 modules of "pureharm"
- Host: GitHub
- URL: https://github.com/pureharm/pureharm-effects-cats
- Owner: pureharm
- License: apache-2.0
- Created: 2021-03-16T17:31:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-01T07:47:44.000Z (over 3 years ago)
- Last Synced: 2024-10-30T01:43:07.461Z (9 days ago)
- Topics: cats-effect, fs2, pureharm, scala
- Language: Scala
- Homepage:
- Size: 248 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pureharm-effects-cats
See [changelog](./CHANGELOG.md).
## modules
### Scala versions
Scala `2.13`, `3.0.1`, for JVM and JS.
The available modules are:
- `"com.busymachines" %% "pureharm-effects-cats" % "0.5.0"`
- in future versions this will be the only module. N.B. that this module is mutually exclusive with the one below, the latter existing for migration purposes towards cats-effect 3
- [cats](https://github.com/typelevel/cats/releases) `2.6.1`
- [cats-effect](https://github.com/typelevel/cats-effect/releases) `3.2.1`
- [cats-retry](https://github.com/cb372/cats-retry) `3.0.0` — currently inlined into pureharm, and made available in the standard namespace w/ syntax
- [fs2-core](https://github.com/typelevel/fs2/releases) `3.0.6`
- [pureharm-core-anomaly](https://github.com/busymachines/pureharm-core/releases) `0.3.0`
- [pureharm-core-sprout](https://github.com/busymachines/pureharm-core/releases) `0.3.0`
- `"com.busymachines" %% "pureharm-effects-cats-2" % "0.5.0"`
- [cats](https://github.com/typelevel/cats/releases) `2.6.1`
- [cats-effect](https://github.com/typelevel/cats-effect/releases) `2.5.2`
- [fs2-core](https://github.com/typelevel/fs2/releases) `2.5.9`
- [cats-retry](https://github.com/cb372/cats-retry) `3.0.0` — currently inlined into pureharm, and made available in the standard namespace w/ syntax
- [pureharm-core-anomaly](https://github.com/busymachines/pureharm-core/releases) `0.3.0`
- [pureharm-core-sprout](https://github.com/busymachines/pureharm-core/releases) `0.3.0`
## usage
Under construction. See [release notes](https://github.com/busymachines/pureharm-effects-cats/releases) and tests for examples.
The recommended way of making use of this module is to create your own "effects" package giving you seemless pure-functional scala experience without import confusion. It's for developers who realized that you can't really write any production apps without treating `cats`, `cats-effect`, `fs2` as being standard library.
```scala
package myapp
import busymachines.pureharm
package object effects extends pureharm.effects.PureharmEffectsAliases with pureharm.effects.PureharmEffectsSyntax {
//write your own custom opiniated things here!
}
//everywhere else in your code just do:
import myapp.effects._
//instead of:
import cats._
import cats.syntax.all._
import cats.effect._
import cats.effect.syntax.all._
import cats.effect.std._
import cats.effect.std.syntax.all._
import fs2._
import retry._
import retry.syntax.all._
```
## Copyright and License
All code is available to you under the Apache 2.0 license, available
at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) and also in
the [LICENSE](./LICENSE) file.