colourista: Convenient interface for printing colourful messages

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Convenient interface for printing colourful messages based on the ansi-terminal library.


[Skip to Readme]

Properties

Versions 0.0.0.0, 0.1.0.0, 0.1.0.0, 0.1.0.1
Change log CHANGELOG.md
Dependencies ansi-terminal (==0.10.*), base (>=4.10.1.0 && <4.15), bytestring (==0.10.*), text (>=1.2.3.0 && <1.3) [details]
License MPL-2.0
Copyright 2020 Kowainik
Author Veronika Romashkina, Dmitrii Kovanikov
Maintainer Kowainik <xrom.xkov@gmail.com>
Category Terminal, ANSI
Home page https://github.com/kowainik/colourista
Bug tracker https://github.com/kowainik/colourista/issues
Source repo head: git clone https://github.com/kowainik/colourista.git
Uploaded by vrom911 at 2020-05-02T15:43:01Z

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for colourista-0.1.0.0

[back to package description]

colourista

logo

GitHub CI Build status Windows build status Hackage Stackage Lts Stackage Nightly MPL-2.0 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, 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:

The library also provides a set of different pure and impure helpers for the colouring and emphasis.

Example

output

How to use

colourista is compatible with the latest GHC compiler versions starting from 8.2.2.

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 colorista 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:

    build-depends: base ^>= 4.14
                 , colourista ^>= 0.0
    
  2. In the module where you wish to use the colourful output with colourista, you should add the import:

    import Colourista (successMessage)
    
  3. Now you can use the functions from the library:

    main :: IO ()
    main = successMessage "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:

extra-deps:
  - colourista-0.0.0.0
  - ansi-terminal-0.10

Then you can add it as a dependency in your package.yaml file as usual:

library:
  dependencies:
    - colourista

Great!

Acknowledgement

Icons made by Freepik from www.flaticon.com is licensed by CC 3.0 BY.