Module

Choku

Package: purescript-choku
Repository: m15a/purescript-choku

This module imports and re-exports some default submodules for convenience, namely

Choku.Common
Choku.Color
Choku.Style
Choku.Stdout

The last one, Choku.Stdout, might not be for your use case, as it works in Eff and customized for the STDOUT stream. To use chalk in Aff, import Choku.Stdout.Aff or Choku.Stderr.Aff instead. To use chalk for the STDERR stream, import Choku.Stderr or Choku.Stderr.Aff instead.

Re-exports from Choku.Color

#Color Source

data Color

Constructors

RGB { b :: Int, g :: Int, r :: Int }
RGB digits. Each channel has the 8-bit range 0 to 255.
Hex String
Hex number representation of the RGB color model, for example #ED49DF.
ANSI256 Int
ANSI 256 colors, ranging from 0 to 255.

Instances

Eq Color
Show Color

#mkRGB Source

mkRGB :: Int -> Int -> Int -> Maybe Color

Safe constructor to make a Color from RGB values.

Returns Nothing with out-of-bounds inputs.

#mkHex Source

mkHex :: String -> Maybe Color

Safe constructor to make a Color from Hex string.

Returns Nothing with invalid Hex string. Prefix # is not mandatory. Hex digits of either length 6 (e.g., #0a0b0c) or 3 (e.g., #ABC) are accepted.

#mkANSI256 Source

mkANSI256 :: Int -> Maybe Color

Safe constructor to make a Color from ANSI256 integer value between 0 and 255.

Returns Nothing with out-of-bounds input.

Re-exports from Choku.Common

#ColorSupportLevel Source

data ColorSupportLevel

Level of color support.

| Level            | Int | Description                           |
| ---------------- | --- | ------------------------------------- |
| `HasNoColors`    |   0 | All colors disabled                   |
| `HasBasicColors` |   1 | Basic color support (16 colors)       |
| `Has256Colors`   |   2 | 256 color support                     |
| `Has16mColors`   |   3 | Truecolor support (16 million colors) |

Constructors

Instances

#Choku Source

data Choku

The Choku type, simply wrapping a Chalk instance in the Javascript layer.

Instances

#withChokuFlipped Source

withChokuFlipped :: Choku -> String -> String

#withChoku Source

withChoku :: String -> Choku -> String

Modify a string with the chalk.

For example,

import Prelude
import Data.Maybe
import Partial.Unsafe
import Choku
let
  chk = unsafePartial $ fromJust (mkChoku 3) # bold # cyan
in
  "hello" `withChoku` chk

produces a bold cyan "hello" string.

#mkChoku Source

mkChoku :: ColorSupportLevel -> Choku

Create a new chalk instance with the specified level of color support.

#level Source

level :: Choku -> ColorSupportLevel

Return the color support level of the given chalk.

#(|&) Source

Operator alias for Choku.Common.withChokuFlipped (non-associative / precedence 7)

#(&|) Source

Operator alias for Choku.Common.withChoku (non-associative / precedence 7)

Re-exports from Choku.Stdout

#withStyleFlipped Source

withStyleFlipped :: Style -> String -> Effect String

#withStyle Source

withStyle :: String -> Style -> Effect String

Modify a string, using the default chalk for STDOUT, with the given style.

For example,

import Prelude
import Effect.Console
import Data.Maybe
import Partial.Unsafe
import Choku

log =<< "hello" `withStyle` (inverse >>> underline)

prints an inversed and underlined "hello" string.

#supportsColor Source

supportsColor :: Effect { has16m :: Boolean, has256 :: Boolean, hasBasic :: Boolean, level :: Int }

Provide detailed information of the color support level.

See https://github.com/chalk/chalk#supportscolor.

#choku Source

choku :: Effect Choku

Get the default chalk instance for STDOUT, automatically detecting the level of color support.

#(:&) Source

Operator alias for Choku.Stdout.withStyleFlipped (non-associative / precedence 7)

#(&:) Source

Operator alias for Choku.Stdout.withStyle (non-associative / precedence 7)

Re-exports from Choku.Style

#Style Source

type Style = Choku -> Choku

#yellowBright Source

yellowBright :: Style

#yellow Source

yellow :: Style

#whiteBright Source

whiteBright :: Style

#white Source

white :: Style

#underline Source

underline :: Style

#strikethrough Source

strikethrough :: Style

#reset Source

reset :: Style

#redBright Source

redBright :: Style

#red Source

red :: Style

#overline Source

overline :: Style

#magentaBright Source

magentaBright :: Style

#magenta Source

magenta :: Style

#italic Source

italic :: Style

#inverse Source

inverse :: Style

#hidden Source

hidden :: Style

#grey Source

grey :: Style

#greenBright Source

greenBright :: Style

#green Source

green :: Style

#gray Source

gray :: Style

#fg Source

fg :: Color -> Style

Modify foreground color.

#dim Source

dim :: Style

#cyanBright Source

cyanBright :: Style

#cyan Source

cyan :: Style

#bold Source

bold :: Style

#blueBright Source

blueBright :: Style

#blue Source

blue :: Style

#blackBright Source

blackBright :: Style

#black Source

black :: Style

#bgYellowBright Source

bgYellowBright :: Style

#bgYellow Source

bgYellow :: Style

#bgWhiteBright Source

bgWhiteBright :: Style

#bgWhite Source

bgWhite :: Style

#bgRedBright Source

bgRedBright :: Style

#bgRed Source

bgRed :: Style

#bgMagentaBright Source

bgMagentaBright :: Style

#bgMagenta Source

bgMagenta :: Style

#bgGrey Source

bgGrey :: Style

#bgGreenBright Source

bgGreenBright :: Style

#bgGreen Source

bgGreen :: Style

#bgGray Source

bgGray :: Style

#bgCyanBright Source

bgCyanBright :: Style

#bgCyan Source

bgCyan :: Style

#bgBlueBright Source

bgBlueBright :: Style

#bgBlue Source

bgBlue :: Style

#bgBlackBright Source

bgBlackBright :: Style

#bgBlack Source

bgBlack :: Style

#bg Source

bg :: Color -> Style

Modify background color.

Modules: Choku; Choku.Color; Choku.Common; Choku.Stderr; Choku.Stderr.Aff; Choku.Stdout; Choku.Stdout.Aff; Choku.Style