diff --git a/hls-graph.cabal b/hls-graph.cabal --- a/hls-graph.cabal +++ b/hls-graph.cabal @@ -1,6 +1,6 @@ cabal-version: 2.4 name: hls-graph -version: 1.9.0.0 +version: 2.0.0.0 synopsis: Haskell Language Server internal graph API description: Please see the README on GitHub at diff --git a/src/Development/IDE/Graph/Internal/Types.hs b/src/Development/IDE/Graph/Internal/Types.hs --- a/src/Development/IDE/Graph/Internal/Types.hs +++ b/src/Development/IDE/Graph/Internal/Types.hs @@ -54,8 +54,13 @@ type TheRules = Map.HashMap TypeRep Dynamic +-- | A computation that defines all the rules that form part of the computation graph. +-- +-- 'Rules' has access to 'IO' through 'MonadIO'. Use of 'IO' is at your own risk: if +-- you write 'Rules' that throw exceptions, then you need to make sure to handle them +-- yourself when you run the resulting 'Rules'. newtype Rules a = Rules (ReaderT SRules IO a) - deriving newtype (Monad, Applicative, Functor, MonadIO, MonadFail) + deriving newtype (Monad, Applicative, Functor, MonadIO) data SRules = SRules { rulesExtra :: !Dynamic, @@ -67,6 +72,12 @@ --------------------------------------------------------------------- -- ACTIONS +-- | An action representing something that can be run as part of a 'Rule'. +-- +-- 'Action's can be pure functions but also have access to 'IO' via 'MonadIO' and 'MonadUnliftIO. +-- It should be assumed that actions throw exceptions, these can be caught with +-- 'Development.IDE.Graph.Internal.Action.actionCatch'. In particular, it is +-- permissible to use the 'MonadFail' instance, which will lead to an 'IOException'. newtype Action a = Action {fromAction :: ReaderT SAction IO a} deriving newtype (Monad, Applicative, Functor, MonadIO, MonadFail, MonadThrow, MonadCatch, MonadMask, MonadUnliftIO)