linenoise: A lightweight readline-replacement library for Haskell

[ bsd3, library, program, user-interfaces ] [ Propose Tags ]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.3.0, 0.3.1, 0.3.2, 0.4.0
Dependencies base (>=4.12 && <5), bytestring (>=0.10 && <1), exceptions (>=0.10 && <1), linenoise, mtl (>=2.2 && <3), text (>=1.2 && <3), unliftio-core (>=0.1 && <1) [details]
License BSD-3-Clause
Copyright 2014 Stephen Diehl, 2019 Eric Conlon
Author Stephen Diehl, Eric Conlon
Maintainer ejconlon@gmail.com
Category User Interfaces
Home page https://github.com/ejconlon/haskell-linenoise#readme
Bug tracker https://github.com/ejconlon/haskell-linenoise/issues
Source repo head: git clone https://github.com/ejconlon/haskell-linenoise
Uploaded by ejconlon at 2024-01-05T23:21:53Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Executables linenoise-demo
Downloads 1089 total (14 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2024-01-06 [all 1 reports]

Readme for linenoise-0.4.0

[back to package description]

linenoise

A lightweight readline-replacement library for Haskell based on the linenoise library. (Not production ready!) See the demo app for usage, or see the climb library for higher-level building blocks for GHCi-like REPLs with colon-commands.

Differences from alternatives

  • haskeline
    • This uses FFI to a minimal C library vs pure Haskell
    • This uses standard MTL/Unlift typeclasses vs custom ones.
    • This does not require the use of a specific monad transformer.
  • readline
    • This offers a MonadIO/MonadUnliftIO interface vs raw IO.
    • This vendors and statically links its underlying library to simplify the build process.

License and attribution

This library includes the source code and license for linenoise in cbits. It is a fork of an older library with all licensing and attribution preserved.

Development workflow

This project uses stack to build.

The Makefile has a bunch of relevant phony targets for a development workflow including

  • build - Build the library and demo
  • download - Update vendored linenoise
  • demo - Run the demo app
  • deps - Install dev tools
  • lint - Lint with hlint
  • format - Format with stylish-haskell
  • docs - Generate docs

In addition, there are targets starting with ci that are invoked in various CI phases.