zio-magic-comments


License

License

GroupId

GroupId

com.timushev
ArtifactId

ArtifactId

zio-magic-comments_2.13
Last Version

Last Version

0.1.0
Release Date

Release Date

Type

Type

jar
Description

Description

zio-magic-comments
zio-magic-comments
Project URL

Project URL

https://github.com/rtimush/zio-magic-comments
Project Organization

Project Organization

com.timushev
Source Code Management

Source Code Management

https://github.com/rtimush/zio-magic-comments

Download zio-magic-comments_2.13

How to add to project

<!-- https://jarcasting.com/artifacts/com.timushev/zio-magic-comments_2.13/ -->
<dependency>
    <groupId>com.timushev</groupId>
    <artifactId>zio-magic-comments_2.13</artifactId>
    <version>0.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.timushev/zio-magic-comments_2.13/
implementation 'com.timushev:zio-magic-comments_2.13:0.1.0'
// https://jarcasting.com/artifacts/com.timushev/zio-magic-comments_2.13/
implementation ("com.timushev:zio-magic-comments_2.13:0.1.0")
'com.timushev:zio-magic-comments_2.13:jar:0.1.0'
<dependency org="com.timushev" name="zio-magic-comments_2.13" rev="0.1.0">
  <artifact name="zio-magic-comments_2.13" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.timushev', module='zio-magic-comments_2.13', version='0.1.0')
)
libraryDependencies += "com.timushev" % "zio-magic-comments_2.13" % "0.1.0"
[com.timushev/zio-magic-comments_2.13 "0.1.0"]

Dependencies

compile (3)

Group / Artifact Type Version
org.scala-lang : scala-library jar 2.13.5
ch.epfl.scala : scalafix-core_2.13 jar 0.9.26
io.github.kitlangton : zio-magic_2.13 jar 0.1.12

Project Modules

There are no modules declared in this project.

zio-magic-comments

ZioMagicComments is a Scalafix rule that adds explanatory graphs as comments to zio-magic methods:

class Demo {
  val program: URIO[Cake, Unit] = ...

  //         Cake.live         ⎫
  //      ┌──────┴─────┐       ⎬ added by ZioMagicComments
  // Clock.live  Blocking.live ⎭
  val magically =
    program.provideMagicLayer(
      Cake.live,
      Clock.live,
      Blocking.live
    )
}

Getting started

Follow the Scalafix documentation to make it possible to run Scalafix rules in your build. Then either run

sbt> scalafix dependency:[email protected]:zio-magic-comments:0.1.0

or include the rule in your build.sbt:

ThisBuild / scalafixDependencies += "com.timushev" %% "zio-magic-comments" % "0.1.0"

Demo

Versions

Version
0.1.0