tvl-depot/users/Profpatsch/my-prelude
Profpatsch 8c4730c433 chore(users/Profpatsch/*): more cabal maintenance
Change-Id: Ib1714abce2815873eb50dbeac088e812fa9098ab
Reviewed-on: https://cl.tvl.fyi/c/depot/+/8686
Tested-by: BuildkiteCI
Reviewed-by: Profpatsch <mail@profpatsch.de>
Autosubmit: Profpatsch <mail@profpatsch.de>
2023-07-13 23:03:09 +00:00
..
Aeson.hs feat(users/Profpatsch/mailbox-org): list & update filters 2023-01-02 02:14:55 +00:00
default.nix chore(users/Profpatsch/*): more cabal maintenance 2023-07-13 23:03:09 +00:00
my-prelude.cabal chore(users/Profpatsch/*): more cabal maintenance 2023-07-13 23:03:09 +00:00
MyPrelude.hs feat(users/Profpatsch/netencode): Add initial Haskell parser 2023-01-08 23:10:28 +00:00
Pretty.hs feat(users/Profpatsch/my-prelude): add RunCommand.hs 2023-04-22 17:17:03 +00:00
README.md feat(users/Profpatsch/my-prelude): add RunCommand.hs 2023-04-22 17:17:03 +00:00
RunCommand.hs feat(users/Profpatsch/my-prelude): add RunCommand.hs 2023-04-22 17:17:03 +00:00
Test.hs feat(users/Profpatsch/my-prelude): Add Test.hs 2023-01-07 14:28:37 +00:00

My Haskell Prelude

Contains various modules Ive found useful when writing Haskell.

Contents

A short overview:

MyPrelude.hs

A collection of re-exports and extra functions. This does not replace the Prelude module from base, but rather should be imported in addition to Prelude.

Stuff like bad functions from prelude (partial stuff, or plain horrible stuff) are handled by a custom .hlint file, which you can find in ../.hlint.yaml.

The common style of haskell they try to enable is what I call “left-to-right Haskell”, where one mostly prefers forward-chaining operators like &/<&>/>>= to backwards operators like $/<$>/<=<. In addition, all transformation function should follow the scheme of aToB instead of B.fromA, e.g. Text.unpack/Text.pack -> textToString/stringToText. Includes a bunch of text conversion functions one needs all the time, in the same style.

These have been battle-tested in a production codebase of ~30k lines of Haskell.

Label.hs

A very useful collection of anonymous labbeled tuples and enums of size 2 and 3. Assumes GHC >9.2 for RecordDotSyntax support.

Pretty.hs

Colorful multiline pretty-printing of Haskell values.

Test.hs

A wrapper around hspec which produces colorful test diffs.

Aeson.hs

Helpers around Json parsing.

Data.Error.Tree

Collect errors (from Data.Error) into a tree, then display them in a nested fashion. Super useful for e.g. collecting and displaying nested parsing errors.

RunCommand.hs

A module wrapping the process API with some helpful defaults for executing commands and printing what is executed to stderr.