ASCII string and character processing.
A total-by-default, tested and documented library for working with ASCII text. Low on dependencies, high on usability.
text-ascii
What is this thing?
A library for handling ASCII text.
What are the goals of this project?
Totality by default
Partial functions (and type classes which provide them) will not be included: everything is total. When we include anything unsafe, it will be explicitly firewalled into its own module, behind a newtype.
No boolean blindness
Boolean blindness is not a good thing, for all the reasons listed in the link. Whenever possible, we'll try and give more useful information than a Bool.
Compatibility with the text API
We want match the API of the text package exactly. If you know how to use text, you'll know how to use this package too. Exceptions are made for places where text is either partial or boolean-blind.
Discoverability, documentation and user-friendliness
In addition to documenting everything with Haddocks, we have over 250 doctests, which provide executable examples of how the API can be used, and how it will behave. We aim to clarify every corner case left by the documentation of text, and care strongly about making the API easy to follow, learn and understand.
Correctness
We currently use doctests, but plan to add support for more testing. No such thing as too much!
Low dependencies
As far as possible, we aim to depend on GHC boot packages only. When we introduce more dependencies, we do it only when we have to. This way, we ensure this package builds quickly and doesn't 'lag' more than necessary due to GHC version changes.
What's with all the cat stuff?
What does this run on?
We support the latest three releases of GHC. Currently, these are:
- 9.4
- 9.6
- 9.8
We check on the following platforms:
- Windows
- Linux
- MacOS
What can I do with this?
The project is licensed Apache 2.0 (SPDX code Apache-2.0). For more details, please see the LICENSE.md file.