The regex-examples package


Tutorial, tests and example programs for regex, a Regular Expression Toolkit for regex-base with Compile-time checking of RE syntax, data types for matches and captures, a text replacement toolkit, portable options, high-level AWK-like tools for building text processing apps, regular expression macros and test bench, a tutorial and copious examples.

[Skip to ReadMe]


Dependenciesarray (>=0.4), base (==4.*), base-compat (>=0.6.0), bytestring (>=, containers (>=0.4), directory (>=, hashable (>=, heredoc (>=, http-conduit (>=, regex (==, regex-base (>=0.93.2), regex-pcre-builtin (>=, regex-tdfa (>=1.2.0), regex-tdfa-text (>=, shelly (>=, smallcheck (>=1.1.1), tasty (>=, tasty-hunit (>=0.9.2), tasty-smallcheck (>=, template-haskell (>=2.7), text (>=, time (>=1.4.2), time-locale-compat (>=, transformers (>=0.2.2), unordered-containers (>= [details]
CopyrightChris Dornan 2016-2017
AuthorChris Dornan
MaintainerChris Dornan <>
Home page
Bug tracker
Source repositoryhead: git clone
this: git clone
Executablesre-tutorial, re-tests, re-prep, re-nginx-log-processor, re-include, re-gen-modules, re-gen-cabals
UploadedTue Feb 21 23:07:04 UTC 2017 by ChrisDornan


Maintainers' corner

For package maintainers and hackage trustees

Readme for regex-examples-


regex is a regular expression toolkit for regex-base with:

See the About page for details.

regex and regex-examples

Road Map

    ☒  2017-01-26 v0.0.0.1 Pre-release (I)

    ☒  2017-01-30 v0.0.0.2 Pre-release (II)

    ☒  2017-02-18 v0.1.0.0 Proposed core API with presentable Haddocks

    ☒  2017-02-19 v0.2.0.0 Package split into regex and regex-examples

    ☒  2017-02-20 v0.2.0.1 Remove library from regex-examples

    ☒  2017-02-21 v0.2.0.2 Fix tests for Hackage

    ☐  2017-02-26 v0.3.0.0 API adjustments, tutorials and examples finalized

    ☐  2017-03-20 v1.0.0.0 First stable release

    ☐  2017-08-31 v2.0.0.0 Fast text replacement with benchmarks

See the Roadmap page for details.

Build Status

Hackage BSD3 License Un*x build Windows build Coverage

See build status page for details.

Installing the Package

The package can be easily installed with cabal or stack on GHC-8.0, 7.10 or 7.8 for the above platforms. See the Installation page for details.

The Tutorial Tests and Examples

See the Tutorial page and Examples page for details.

Helping Out

If you have any feedback or suggestion then please drop us a line.

    t @hregex



The Contact page has more details.


The Haddocks can be found at

The Macro Tables

The macro environments are an important part of the package and are documented here.

The Directory

A handy overview of the domain can be found here.

The Changelog

The changelog is posted here.

The Authors

This library was written and is currently maintained by Chris Dornan aka @cdornan