This outline provides a wide array of content, focused on practical lessons towards writing real-world applications. It presumes a basic knowledge of Haskell, as would be gained from books such as Real World Haskell and Learn You a Haskell.
Much of the content described below does not yet exist, and therefore contributions are highly welcome. Additionally, some of the lists below should be expanded. If you have thoughts on missing pieces, please bring them up on the issue tracker.
Core information
You understand the basics of Haskell syntax and some common library functions. This section should get you up to speed with many commonly used features of Haskell, to provide a foundation for understanding code in general, and to follow the rest of this outline in particular.
- Basic Tooling Guide
- IDEs and Linters
- Common Typeclasses
- Common Language Extensions
- Haskell glossary
- All About Exceptions
- Basics of lazy evaluation
Data structures
Covers some of the most commonly used data structures in Haskell, and the libraries providing them.
- vector
- containers
- unordered-containers
- text (cover text-icu)
- bytestring
General patterns
This section demonstrates some common Haskell coding patterns, how they work, when they're useful, and possible pitfalls.
- Monad Transformers
- Covariance, contravariance, and positive and negative position
- Continuation Passing Style
- Builders and difference lists
Testing
- QuickCheck
- hspec, tasty, others?
- Hspec/doctest with Cabal as test framework
Serialization
- binary/cereal
- blaze-builder/bytestring-builder
- blaze-html
- attoparsec
- aeson
- yaml
- xml-conduit/html-conduit
- base16-bytestring/base64-bytestring
Standard programming needs
- HTTP client library
- Command line argument parsing optparse-applicative
- cryptohash
- time
- Random number generation (mwc-random)
- Possibly others from: https://www.fpcomplete.com/school/using-fphc/recommended-libraries
- Regular expressions with regex-applicative
- All about strings
System programming
- Launching subprocesses, capturing output, working with environment (can include Data.Conduit.Process)
- Network and Socket I/O
- Writing scripts (turtle, Shelly)
Best practices
- Exceptions best practices
- Typeclasses versus records
- "Good" use of typeclass extensions
- Proper error reporting (Either, Maybe, ErrorT, exceptions package and using MonadThrow)
- Designing APIs for Extensibility
Streaming data
Streaming data libraries allow you to process large amounts of input with reliable resource usage, be that memory, file descriptors, or other resources. There are a number of different libraries for doing this in Haskell. Instead of a single library, each library can have its own subsection here. In addition, the following provides an overview of the different options.
conduit
- https://www.fpcomplete.com/user/snoyberg/library-documentation/conduit-overview
- https://www.fpcomplete.com/user/snoyberg/library-documentation/resourcet
- http://www.yesodweb.com/blog/2014/03/network-conduit-async
- https://www.fpcomplete.com/user/snoyberg/library-documentation/vectorbuilder
- conduit-combinators
Concurrency and parallelism
Simon Marlow's book Parallel and Concurrent Programming in Haskell is a highly recommended read on the subject. In addition, we have the following topics:
- The async package
- Common concurrency patterns (e.g., the auto-update package)
- "Passing the baton" to control flow of execution between threads, using
MVar
for two threads,TVar
for multiple threads
- "Passing the baton" to control flow of execution between threads, using
- Concurrency patterns: worker threads, signals, blocking on TVars
- STM: blocking semantics around mutable variables
- resource-pool
- handling errors (SlaveThread), restarting tasks, timeouts and other common patterns
Web programming
Web programming is another topic with many different approaches. Like streaming data, we need an overview of the different options, and then a drilldown on individual approaches. For now:
Big library guide
The following libraries are somewhat "large" in the sense that they address many different concerns.
- lens
- mono-traversable
Alternate Preludes
Sometimes it is useful to use an alternative to the standard Prelude
. Reasons
include avoiding cross-version incompatibility, support for better data
structures, and avoiding partial functions. Here are some commonly used
preludes (in alphabetical order).
- base-prelude
- basic-prelude
- classy-prelude
Advanced topics
- Primitive Haskell
- https://wiki.haskell.org/Evaluationorderandstatetokens
- Cabal trickery for backwards compatibility: Cabal CPP macros. Paths module. Flags. How to test for windows. Defaulting macros for ghci. Flags to either use new library version or another package (bytestring-builder) and set a CPP variable.
- Constraint trick for instances; perhaps we can have a section for common type patterns (newtypes an obvious one, and also for example using Rank-N types to store a generic function in a data structure, versus existential types to store generic data).
Database Programming
- persistent
- esqueleto
- opaleye
- mysql-simple
- postgresql-simple
- Haskell Relational Record
Debugging/optimizing
- hlint
- Debugging
- Profiling
- Finding space leaks
- Strictness annotations
- Pragmas (UNPACK, INLINE, ...)
- Heap profiling
- Looking at GHC core
Code and project structuring
As a project grows, there are many "patterns" that might save developer some time by just doing some restructuring work. Some tricks might save development time, while others help to re-compile less.
- Common
Imports.hs
module - Multiple executables depending on common library
- Default data pattern (like in yesod book)
Application infrastructure and support
As part of "commercial haskell", I think it would be great to have both, haskell-specific and non-specific description with examples in haskell for how do you manage all the standard needs for your application infrastructure and support. Some topics would include:
- Deployment & service management
- Monitoring and metrics (ekg, bosun)
- Log handling techniques