Modulecolourista-0.1.0.2Haskell2010

Colourista.Pure

SPDX-License-Identifier: MPL-2.0 Maintainer: Kowainik xrom.xkov@gmail.com

This module introduces helpful pure codes to customise the terminal output view.

24 values

Packagecolourista-0.1.0.2
Exports24
LanguageHaskell2010
LicenceMPL-2.0
SourcePure.hs

valueformatWith :: (IsString str, Semigroup str) => [str] -> str -> str

General purpose function to format strings with multiple options. If this function takes empty list as an argument, no formatting is applied.

Some typical usages include but not limited to:

Green text: formatWith [green] myString
Bold red text: formatWith [bold, red] myString
Blue text on white background: formatWith [blue, whiteBg] myString
Italicized yellow on cyan background: formatWith [italic, yellow, cyanBg] myString

Colored examples

⚠ Caution: Double underlining doubleUnderline is not widely supported. It is also not natively supported on Windows 10.

Colour

8 declarations

valuered :: IsString str => str

Code to apply Red colouring for the terminal output.

valuegreen :: IsString str => str

Code to apply Green colouring for the terminal output.

valueblue :: IsString str => str

Code to apply Blue colouring for the terminal output.

valueyellow :: IsString str => str

Code to apply Yellow colouring for the terminal output.

valueblack :: IsString str => str

Code to apply Black colouring for the terminal output.

valuewhite :: IsString str => str

Code to apply White colouring for the terminal output.

valuemagenta :: IsString str => str

Code to apply Magenta colouring for the terminal output.

valuecyan :: IsString str => str

Code to apply Cyan colouring for the terminal output.

Background

8 declarations

valueredBg :: IsString str => str

Code to apply Red background colouring for the terminal output.

valuegreenBg :: IsString str => str

Code to apply Green background colouring for the terminal output.

valueblueBg :: IsString str => str

Code to apply Blue background colouring for the terminal output.

valueyellowBg :: IsString str => str

Code to apply Yellow background colouring for the terminal output.

valueblackBg :: IsString str => str

Code to apply Black background colouring for the terminal output.

valuewhiteBg :: IsString str => str

Code to apply White background colouring for the terminal output.

valuemagentaBg :: IsString str => str

Code to apply Magenta background colouring for the terminal output.

valuecyanBg :: IsString str => str

Code to apply Cyan background colouring for the terminal output.

Emphasis

6 declarations

valuebold :: IsString str => str

Code to apply bold emphasis for the terminal output.

valueitalic :: IsString str => str

Code to apply italic emphasis for the terminal output.

valueunderline :: IsString str => str

Code to apply underline emphasis for the terminal output.

valuedoubleUnderline :: IsString str => str

Code to apply double underline emphasis for the terminal output.

⚠ Caution: This is not widely supported. It is not natively supported on Windows 10

valuenoUnderline :: IsString str => str

Code to apply no underline emphasis for the terminal output.

valueindent :: (IsString str, Semigroup str) => Int -> str

Code to indent the terminal output by the given amount of spaces.

Reset

1 declaration

valuereset :: IsString str => str

Code to reset all previous code applied for the terminal output.