Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kowainik/colourista
️🌈 Convenient interface for printing colourful messages
https://github.com/kowainik/colourista
ansi colours hacktoberfest haskell haskell-library pretty-printing terminal
Last synced: 1 day ago
JSON representation
️🌈 Convenient interface for printing colourful messages
- Host: GitHub
- URL: https://github.com/kowainik/colourista
- Owner: kowainik
- License: mpl-2.0
- Created: 2020-02-12T19:08:28.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-23T15:33:38.000Z (about 1 month ago)
- Last Synced: 2025-01-15T01:19:24.432Z (8 days ago)
- Topics: ansi, colours, hacktoberfest, haskell, haskell-library, pretty-printing, terminal
- Language: Haskell
- Homepage: https://kowainik.github.io/projects/colourista
- Size: 77.1 KB
- Stars: 67
- Watchers: 6
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# colourista
[](https://github.com/kowainik/colourista/actions)
[](https://hackage.haskell.org/package/colourista)
[](http://stackage.org/lts/package/colourista)
[](http://stackage.org/nightly/package/colourista)
[](LICENSE)
> «The best colour in the whole world is the one that looks good on you.»
>
> — Coco Chanel
`colourista` is the library that provides a convenient interface for printing
colourful messages to the terminal. It is based on
[`ansi-terminal`](https://hackage.haskell.org/package/ansi-terminal), however,
in contradistinction to this Haskell library, `colourista` is a high-level
wrapper focused on easily achieved output modification without low-level setup.
## Interface
The two main functions that `colourista` provides are:
* `formatWith` — the function that formats pure output by applying provided
formatting codes. It works with polymorphic strings.
* `formattedMessage` — the function that outputs the formatted output directly
into the terminal (working in `IO` with `Text`).
The library also provides a set of different pure and impure helpers for the
colouring and emphasis.
## Example
## How to use
`colourista` is compatible with the latest GHC compiler versions starting from `8.4`.
In order to start using `colourista` in your project, you will need to set it up with the three easy steps:
1. Add the dependency on `colourista` in your project's `.cabal` file. For this,
you should modify the `build-depends` section by adding the name of this
library. After the adjustment, this section could look like this:
```haskell
build-depends: colourista ^>= LATEST_VERSION
, ...
```
2. In the module where you wish to use the colourful output with `colourista`,
you should add the import:
```haskell
import Colourista (...)
```
3. Now you can use the functions from the library. For example:
```haskell
import qualified Data.Text as Text
main :: IO ()
main = successMessage $ Text.pack "All set up!"
```
### Usage with Stack
If `colourista` is not available on your current Stackage resolver yet, fear not! You can still use
it from Hackage by adding the following to the `extra-deps` section of your `stack.yaml`
file:
```yaml
extra-deps:
- colourista-0.1.0.0
- ...
```
Then you can add it as a dependency in your `package.yaml` file as usual:
```yaml
library:
dependencies:
- colourista
```
Great!
## Acknowledgement
Icons made by [Freepik](http://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).