Monadoc

relude

Version 1.2.2.0 revision 0 uploaded by vrom911.

Package meta

Synopsis
Safe, performant, user-friendly and lightweight Haskell Standard Library
Description

relude is an alternative prelude library. If you find the default Prelude unsatisfying, despite its advantages, consider using relude instead.

Relude goals and design principles

  • Productivity. You can be more productive with a "non-standard" standard library, and relude helps you with writing safer and more efficient code faster.

  • Total programming. Usage of partial functions can lead to unexpected bugs and runtime exceptions in pure code. The types of partial functions lie about their behaviour. And even if it is not always possible to rely only on total functions, relude strives to encourage best-practices and reduce the chances of introducing a bug.

    PartialTotal
    head :: [a] -> ahead :: NonEmpty a -> a
    tail :: [a] -> [a]tail :: NonEmpty a -> [a]
    read :: Read a => String -> areadMaybe :: Read a => String -> Maybe a
    fromJust :: Maybe a -> afromMaybe :: a -> Maybe a -> a

  • Type-safety. We use the "make invalid states unrepresentable" motto as one of our guiding principles. If it is possible, we express this concept through the types.

    Example: whenNotNull :: Applicative f => [a] -> (NonEmpty a -> f ()) -> f ()

  • Performance. We prefer Text over String, use space-leaks-free functions (e.g. our custom performant sum and product), introduce {-# INLINE #-} and {-# SPECIALIZE #-} pragmas where appropriate, and make efficient container types (e.g. Map, HashMap, Set) more accessible.

  • Minimalism (low number of dependencies). We do not force users of relude to stick to any specific lens or text formatting or logging library. Where possible, relude depends only on boot libraries. The Dependency graph of relude can give you a clearer picture.

  • Convenience. Despite minimalism, we want to bring commonly used types and functions into scope, and make available functions easier to use. Some examples of conveniences:

    1. No need to add containers, unordered-containers, text and bytestring to dependencies in your .cabal file to use the main API of these libraries

    2. No need to import types like NonEmpty, Text, Set, Reader[T], MVar, STM

    3. Functions like liftIO, fromMaybe, sortWith are available by default as well

    4. IO actions are lifted to MonadIO

  • Excellent documentation.

    1. Tutorial

    2. Migration guide from Prelude

    3. Haddock for every function with examples tested by doctest.

    4. Documentation regarding internal module structure

    5. relude-specific HLint rules: .hlint.yaml

  • User-friendliness. Anyone should be able to quickly migrate to relude. Only some basic familiarity with the common libraries like text and containers should be enough (but not necessary).

  • Exploration. We have space to experiment with new ideas and proposals without introducing breaking changes. relude uses the approach with Extra.* modules which are not exported by default. The chosen approach makes it quite easy for us to provide new functionality without breaking anything and let the users decide to use it or not.

Author
Dmitrii Kovanikov, Veronika Romashkina, Stephen Diehl, Serokell
Bug reports
https://github.com/kowainik/relude/issues
Category
Prelude
Copyright
2016 Stephen Diehl, 2016-2018 Serokell, 2018-2023 Kowainik
Homepage
https://github.com/kowainik/relude
Maintainer
Kowainik <xrom.xkov@gmail.com>
Package URL
n/a
Stability
stable

Components