https://github.com/sagifogel/proptics

Profunctor optics and lenses library for Scala
https://github.com/sagifogel/proptics

cats folds functional-programming lenses lenses-library optics prisms profunctor-optics scala spire traversals

Last synced: 3 months ago
JSON representation

Profunctor optics and lenses library for Scala

• Host: GitHub
• URL: https://github.com/sagifogel/proptics
• Owner: sagifogel
• License: mit
• Created: 2019-12-05T21:12:00.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-04T17:28:32.000Z (3 months ago)
• Last Synced: 2024-11-04T18:30:51.101Z (3 months ago)
• Topics: cats, folds, functional-programming, lenses, lenses-library, optics, prisms, profunctor-optics, scala, spire, traversals
• Language: Scala
• Homepage: https://sagifogel.github.io/Proptics
• Size: 31.8 MB
• Stars: 9
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Proptics Logo](./proptics.png)

[![CI](https://github.com/sagifogel/Proptics/actions/workflows/ci.yml/badge.svg)](https://github.com/sagifogel/Proptics/actions/workflows/ci.yml)

[![Maven Central](https://img.shields.io/maven-central/v/io.github.sagifogel/proptics-core_2.13.svg?color=32c954)](https://maven-badges.herokuapp.com/maven-central/io.github.sagifogel/proptics-core_2.13)

[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)

### Overview

Proptics is a Profunctor Optics and Lenses library for [Scala programming language](https://scala-lang.org).

It uses a Profunctor encoding for its internal representation of optics, you can learn about profunctors in the [profunctor](https://sagifogel.github.io/Proptics/docs/profunctors/profunctor) guide.

Proptics is available for Scala 2.12, Scala 2.13, Scala 3.0, and [Scala.js](http://www.scala-js.org/),

and is built on top of [Cats](https://typelevel.org/cats/), and [Spire](https://typelevel.org/spire/).

### Getting Started

Add to your `build.sbt`

```scala

libraryDependencies ++= Seq(

  "io.github.sagifogel" %% "proptics-core" % "0.5.2",

  "io.github.sagifogel" %% "proptics-profunctor" % "0.5.2",

  "io.github.sagifogel" %% "proptics-macros" % "0.5.2"

)

```

Quick links:

* [Website][website]

* [Guide][guide]

[website]: https://sagifogel.github.io/Proptics/

[guide]: https://sagifogel.github.io/Proptics/docs/overview

[proptics-api]: https://sagifogel.github.io/Proptics/api/proptics/

### Documentation

* There is a Scaladoc API documentation for the [library][proptics-api], which includes optics ([Lens](https://sagifogel.github.io/Proptics/api/proptics/Lens_), [Traversal](https://sagifogel.github.io/Proptics/api/proptics/Traversal_) [Fold](https://sagifogel.github.io/Proptics/api/proptics/Fold_), and more)

  [Profunctors](https://sagifogel.github.io/Proptics/api/proptics/profunctor/), and [Data types](https://sagifogel.github.io/Proptics/api/proptics/internal/)