haskell-awk

Transform text from the command-line using Haskell expressions.

Latest on Hackage:1.1.1

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow stackage.org to host generated Haddocks.

Apache-2.0 licensed and maintained by Mario Pastorelli, Samuel GĂ©lineau

Hawk

Transform text from the command-line using Haskell expressions. Similar to awk, but using Haskell as the text-processing language.

Examples

In Unix the file /etc/passwd is used to keep track of every registered user in the system. Each entry in the file contains information about a single user, using a simple colon-separated format. For example:

root:x:0:0:root:/root:/bin/bash

The first field is the username. We can use Hawk to list all usernames as follows:

> cat /etc/passwd | hawk -d: -m 'head'
root

The -d option tells Hawk to use : as field delimiters, causing the first line to be interpreted as ["root", "x", "0", "0", "root", "/root", "/bin/bash"]. The -m tells Hawk to map a function over each line of the input. In this case, the function head extracts the first field of the line, which happens to be the username.

We could of course have achieved identical results by using awk instead of Hawk:

> cat /etc/passwd | awk -F: '{print $1}'
root

While Hawk and awk have similar use cases, the philosophy behind the two is very different. Awk uses a specialized language designed to concisely express many text transformations, while Hawk uses the general-purpose language Haskell, which is also known for being concise, among other things. There are many standard command-line tools that can be easily approximated using short Haskell expressions.

Another important difference is that while awk one-liners are self-contained, Hawk encourages the use of libraries and user-defined functions. By adding function definitions, module imports and language pragmas to Hawk's user-configurable prelude file, those functions, libraries and language extensions become available to Hawk one-liners. For instance, we could add a takeLast function extracting the last n elements from a list, and use it to (inefficiently) approximate tail:

> echo 'takeLast n = reverse . take n . reverse' >> ~/.hawk/prelude.hs
> seq 0 100 | hawk -a 'takeLast 3'
98
99
100

For more details, see the documentation.

Installation

To install the stable version, simply use cabal install haskell-awk (not cabal install hawk, that's another unrelated package) and add ~/.cabal/bin (or your sandbox's bin folder) to your PATH. You should be ready to use Hawk:

> hawk '[1..3]'
1
2
3

To install the development version, clone this repository and use cabal install or cabal-dev install to compile Hawk and its dependencies. Cabal installs the binary to ~/.cabal/bin/hawk, while cabal-dev installs it to ./cabal-dev/bin/hawk. The first run will create a default configuration into ~/.hawk/prelude.hs if it doesn't exist.

Build Status

Changes

What's new?

New in 1.1.1

GHC 7.10 compatibility.

New in 1.1

In a nutshell, custom context directories and GHC 7.8 compatibility.

Breaking changes

  • The detection of whether the user prelude needs to be recompiled has been improved, leading to the removal of the no-longer useful --recompile flag.

"Breaking" changes (if you used internal stuff)

  • The haskell-awk library has changed.
  • The format of ~/.hawk/cache has changed.

New features

  • GHC 7.8 compatibility.
  • A context directory other than ~/.hawk can be specified.
  • A .hawk directory can be placed in the current directory (or one of its ancestors) and it will be used instead of ~/.hawk. This allows different projects to use different user preludes.

Bugfixes

  • Some examples from the documentation needed minor changes in order to produce the documented output.
  • hawk "" is now a syntax error.
  • cabal install --enable-tests no longer complains that the runtime isn't installed.

Minor improvements

  • The nomenclature for "lines" and "words" is now "records" and "fields", because the delimiters don't need to be newline and space.
  • Usage is shown when hawk is called with no arguments.
  • A warning message is displayed when ~/.hawk is first created.
  • More succinct --help output.
  • More uniform presentation of warnings and error messages.
comments powered byDisqus