relude: Custom prelude from Kowainik

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Goals

  1. Tutorial

  2. Migration guide from Prelude

  3. Haddock with examples for (almost) every function (all examples are tested with <code>doctest</code>)

  4. Documentation regarding internal module structure)

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


[Skip to Readme]

Properties

Versions 0.1.0, 0.1.0, 0.1.1, 0.2.0, 0.3.0, 0.4.0, 0.5.0, 0.6.0.0, 0.7.0.0, 1.0.0.0, 1.0.0.1, 1.1.0.0, 1.2.0.0, 1.2.1.0
Change log CHANGELOG.md
Dependencies base (>=4.8 && <5), bytestring, containers, deepseq, ghc-prim (>=0.4.0.0), hashable, mtl, stm, text, transformers, unordered-containers, utf8-string [details]
License MIT
Copyright 2016 Stephen Diehl, 2016-2018 Serokell, 2018 Kowainik
Author Stephen Diehl, @serokell, Kowainik
Maintainer Kowainik <xrom.xkov@gmail.com>
Category Prelude
Home page https://github.com/kowainik/relude
Bug tracker https://github.com/kowainik/relude/issues
Source repo head: git clone git@github.com:kowainik/relude.git
Uploaded by shersh at 2018-07-21T10:12:31Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Readme for relude-0.1.0

[back to package description]

Relude

Build Status Hackage Stackage LTS Stackage Nightly License: MIT

relude is a custom prelude based on universum. relude tries to achieve the following goals:

  1. Avoid all partial functions (like head :: [a] -> a). The types of partial functions lie about their behavior and usage of such functions can lead to the unexpected bugs. Though you can still use some unsafe functions from Relude.Unsafe module, but they are not exported by default.

  2. Type-safety. We like to make invalid states unrepresantable. And if it's possible to express this concept through the types then we will do it.

    Example:

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

    instead of

    whenNotNull :: Applicative f => [a] -> ([a] -> f ()) -> f ()
    
  3. Performance. Prefer Text over String, use spaceleak-free functions (like our custom sum and product), introduce {-# INLINE #-} and {-# SPECIALIZE #-} pragmas where appropriate.

  4. Minimalism (low number of dependencies). We don't force users of relude to stick to some specific lens or text formatting or logging library.

  5. Convenience (like lifted to MonadIO functions, more reexports). But we want to bring common types and functions (like containers and bytestrng) into scope because they are used in almost every application anyways.

  6. Provide excellent documentation.

  7. User-friendliness. Ability to quickly migrate to relude if you're familiar with the common libraries like text and containers.

  8. Exploration. Experiment with new ideas and proposals without introducing breaking changes.

This README contains introduction to Relude and a tutorial on how to use it.

Structure of this tutorial

This tutorial has several parts:

  1. Motivation.
  2. Get started.
  3. Difference from Prelude.
  4. Reexports.
  5. What's new?
  6. Migration guide.

This is neither a tutorial on Haskell nor tutorial on each function contained in Relude. For detailed documentation of every function together with examples and usage, see Haddock documentation.

Motivation

We decided to base relude on universum due to the following reasons:

  1. universum helps to achieve our goals more than any other custom prelude.
  2. We worked on universum a lot (just check contributors statistics) and we know its internal structure.

The motivation to create another alternative prelude instead of modifying existing one is that it's hard to change preludes in any way. relude uses approach with Extra.* modules which are not exported by default so it's quite easy to bring something new (that satisfies relude goals) and let users decide to use it or not.

Unlike universum, we are:

  1. Not trying to replace Foldable with custom Container type class. We only forbid elem and notElem functions for sets due to performance reasons.
  2. Have less dependencies: no vector, no microlens, no safe-exceptions, no type-operators.
  3. Have a lot of other different improvements.

Get started

If you want to start using relude in your project and explore it with the help of compiler, set everything up according to the instructions below.

base-noprelude

This is the recommended way to use custom prelude. It requires you to perform the following steps:

  1. Replace base dependency with corresponding version of base-noprelude in your .cabal file.
  2. Add the following Prelude module to your project (both to filesystem and to exposed-modules):
    module Prelude
           ( module Relude
           ) where
    
    import Relude
    
  3. Optionally modify your Prelude to include more or less functions. Probably you want to hide something from Relude module. Or maybe you want to add something from Relude.Extra.* modules!

This is a very convenient way to add a custom prelude to your project because you don't need to import module manually inside each file and enable the NoImplicitPrelude extension.

Per-file configuration

Disable the built-in prelude at the top of your file:

{-# LANGUAGE NoImplicitPrelude #-}

Or directly in your project .cabal file, if you want to use in every module by default:

default-extensions: NoImplicitPrelude

Then add the following import to your modules:

import Relude

Difference from Prelude

Reexports

Commonly used libraries

First of all, we reexport some generally useful modules: Control.Applicative, Data.Traversable, Data.Monoid, Control.DeepSeq, Data.List, and lots of others. Just remove unneeded imports after importing Relude (you can use .hlint.yaml file for this).

Then, some commonly used types: Map/HashMap/IntMap, Set/HashSet/IntSet, Seq, Text and ByteString (as well as synonyms LText and LByteString for lazy versions).

liftIO and MonadIO are exported by default. A lot of IO functions are generalized to MonadIO.

deepseq is exported. For instance, if you want to force deep evaluation of some value (in IO), you can write evaluateNF a. WHNF evaluation is possible with evaluateWHNF a.

We also reexport big chunks of these libraries: mtl, stm.

Bifunctor type class with useful instances is exported.

Text

We export Text and LText, and some functions work with Text instead of String – specifically, IO functions (readFile, putStrLn, etc) and show. In fact, show is polymorphic and can produce strict or lazy Text, String, or ByteString. Also, toText/toLText/toString can convert Text|LText|String types to Text/LText/String. If you want to convert to and from ByteString use encodeUtf8/decodeUtf8 functions.

Debugging and undefineds

trace, traceM, traceShow, etc. are available by default. GHC will warn you if you accidentally leave them in code, however (same for undefined).

We also have data Undefined = Undefined (which, too, comes with warnings).

Exceptions

TODO: write about reexports, Bug and Exc pattern.

What's new?

Finally, we can move to part describing the new cool features we bring with relude.

Migration guide

In order to replace default Prelude with relude you should start with instructions given in get started section.

This section describes what you need to change to make your code compile with relude.

  1. Enable -XOverloadedStrings extension by default for your project.

  2. Since head, tail, last and init work for NonEmpty you should refactor your code in one of the multiple ways described below:

    1. Change [a] to NonEmpty a where it makes sense.
    2. Use functions which return Maybe. There is the viaNonEmpty function for this. And you can use it like viaNonEmpty last l.
      • viaNonEmpty head l is safeHead l
      • tail is drop 1. It's almost never a good idea to use tail from Prelude.
    3. Add import qualified Relude.Unsafe as Unsafe and replace function with qualified usage.
  3. If you use fromJust or !! you should use them from import qualified Relude.Unsafe as Unsafe.

  4. If you use foldr or forM_ or similar for something like Maybe a or Either a b it's recommended to replace usages of such function with monomorhpic alternatives:

    • Maybe

      • (?:) :: Maybe a -> a -> a
      • fromMaybe :: a -> Maybe a -> a
      • maybeToList :: Maybe a -> [a]
      • maybeToMonoid :: Monoid m => Maybe m -> m
      • maybe :: b -> (a -> b) -> Maybe a -> b
      • whenJust :: Applicative f => Maybe a -> (a -> f ()) -> f ()
      • whenJustM :: Monad m => m (Maybe a) -> (a -> m ()) -> m ()
    • Either

      • fromLeft :: a -> Either a b -> a
      • fromRight :: b -> Either a b -> b
      • either :: (a -> c) -> (b -> c) -> Either a b -> c
      • whenRight_ :: Applicative f => Either l r -> (r -> f ()) -> f ()
      • whenRightM_ :: Monad m => m (Either l r) -> (r -> m ()) -> m ()
  5. Forget about String type.

    • Replace putStr and putStrLn with putText and putTextLn.
    • Replace (++) with (<>) for String-like types.
    • Try to use fmt library if you need to construct messages.
    • Use toText/toLText/toString functions to convert to Text/LazyText/String types.
    • Use encodeUtf8/decodeUtf8 to convert to/from ByteString.
  6. Run hlint using .hlint.yaml file from relude package to cleanup code and imports.