effectful-plugin: A GHC plugin for improving disambiguation of effects.

[ bsd3, control ] [ Propose Tags ]

Instruct GHC to do a better job with disambiguation of effects.

See the README for more information.


[Skip to Readme]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 1.0.0.0
Change log CHANGELOG.md
Dependencies base (>=4.13 && <5), containers (>=0.5), effectful-core (>=1.0.0.0 && <3.0.0.0), ghc (>=8.6 && <9.3), ghc-tcplugins-extra (>=0.3 && <0.5) [details]
License BSD-3-Clause
Author Andrzej Rybczak
Maintainer andrzej@rybczak.net
Revised Revision 3 made by arybczak at 2022-08-12T18:18:34Z
Category Control
Bug tracker https://github.com/haskell-effectful/effectful/issues
Source repo head: git clone https://github.com/haskell-effectful/effectful.git
Uploaded by arybczak at 2022-07-13T20:07:21Z
Distributions LTSHaskell:1.0.0.0, NixOS:1.0.0.0
Downloads 80 total (13 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2022-07-13 [all 1 reports]

Readme for effectful-plugin-1.0.0.0

[back to package description]

effectful-plugin

A GHC plugin for improving disambiguation of effects.

Usage

To enable the plugin, add the following GHC option to your project file:

ghc-options: -fplugin=Effectful.Plugin

What it does

The following code:

action :: [State Int, State String] :>> es => Eff es ()
action = do
  x <- get
  put (x + 1)

will not compile out of the box because GHC doesn't know that you meant to get an Int since the function + as well as the literal 1 are polymorphic. You have to write:

action :: [State Int, State String] :>> es => Eff es ()
action = do
  x <- get @Int
  put (x + 1)

Which is slightly annoying. This plugin tells GHC extra information so code like this can type-check without having to spell types to the compiler.

Acknowledgements

Thanks to Xy Ren for her work on cleff-plugin effectful-plugin is based on.