polysemy-plugin: Disambiguate obvious uses of effects.

[ bsd3, library, polysemy ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/polysemy-research/polysemy/tree/master/polysemy-plugin#readme

[Skip to Readme]
Versions [RSS] [faq],,,,,,,,,,,,,,,,,,, (info)
Change log ChangeLog.md
Dependencies base (>=4.9 && <5), containers (>=0.5 && <0.7), ghc (>=8.6.5 && <10), ghc-tcplugins-extra (>=0.3 && <0.5), polysemy (>=1.7), syb (==0.7.*), transformers (>= && <0.6) [details]
License BSD-3-Clause
Copyright 2019 Sandy Maguire
Author Sandy Maguire
Maintainer sandy@sandymaguire.me
Category Polysemy
Home page https://github.com/polysemy-research/polysemy#readme
Bug tracker https://github.com/polysemy-research/polysemy/issues
Source repo head: git clone https://github.com/polysemy-research/polysemy
Uploaded by isovector at 2021-11-24T05:59:15Z
Distributions LTSHaskell:, NixOS:, Stackage:
Downloads 7826 total (156 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-11-24 [all 1 reports]


[Index] [Quick Jump]

Manual Flags


Perform the corelint tests

Automatic Flags

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

For package maintainers and hackage trustees


Readme for polysemy-plugin-

[back to package description]


Build Status Hackage


It doesn't matter how beautiful your theory is, it doesn't matter how smart you are. If it doesn't agree with experiment, it's wrong.

Richard Feynman


A typechecker plugin that can disambiguate "obvious" uses of effects in polysemy.


Consider the following program:

foo :: Member (State Int) r => Sem r ()
foo = put 10

What does this program do? Any human will tell you that it changes the state of the Int to 10, which is clearly what's meant.

Unfortunately, polysemy can't work this out on its own. Its reasoning is "maybe you wanted to change some other State effect which is also a Num, but you just forgot to add a Member constraint for it."

This is obviously insane, but it's the way the cookie crumbles. polysemy-plugin is a typechecker plugin which will disambiguate the above program (and others) so the compiler will do what you want.


Add the following line to your package configuration:

ghc-options: -fplugin=Polysemy.Plugin


The polysemy-plugin will only disambiguate effects if there is exactly one relevant constraint in scope. For example, it will not disambiguate the following program:

bar :: Members '[ State Int
                , State Double
                ] r => Sem r ()
bar = put 10

because it is now unclear whether you're attempting to set the Int or the Double. Instead, you can manually write a type application in this case.

bar :: Members '[ State Int
                , State Double
                ] r => Sem r ()
bar = put @Int 10


This plugin is copied almost verbatim from simple-effects.