Vgrep.Environment.Config.Sources.File

Documentation

configFromFile :: MonadIO io => io ConfigMonoid

Reads the configuration from a JSON or YAML file. The file should be located in one of the following places:

• ~/.vgrep/config.yaml,
• ~/.vgrep/config.yml,
• ~/.vgrep/config.json or
• ~/.vgrep/config.

When none of these files exist, no error is raised. When a file exists, but cannot be parsed, a warning is written to stderr.

Supported formats are JSON and YAML. The example YAML config given in the project directory (config.yaml.example) is equivalent to the default config:

>>> import qualified Vgrep.Environment.Config as C
>>> Right config <- decodeFileEither "config.yaml.example" :: IO (Either ParseException ConfigMonoid)
>>> C.fromConfigMonoid config == C.defaultConfig
True

Example YAML config file for defaultConfig:

colors:
  line-numbers:
    fore-color: blue
  line-numbers-hl:
    fore-color: blue
    style: bold
  normal: {}
  normal-hl:
    style: bold
  file-headers:
    back-color: green
  selected:
    style: standout
tabstop: 8
editor: "vi"

Example JSON file for the same config:

{
  "colors": {
    "line-numbers" : {
      "fore-color": "blue"
    },
    "line-numbers-hl": {
      "fore-color": "blue",
      "style": "bold"
    },
    "normal": {},
    "normal-hl": {
      "style": "bold"
    },
    "file-headers": {
      "back-color": "green"
    },
    "selected": {
      "style": "standout"
    }
  },
  "tabstop": 8,
  "editor": "vi"
}

The JSON/YAML keys correspond to the lenses in Vgrep.Environment.Config, the values for Color and Style can be obtained from the corresponding predefined constants in Graphics.Vty.Attributes.

data Attr

A JSON-parsable data type for Attr.

JSON example:

>>> decodeEither' "{\"fore-color\": \"black\", \"style\": \"standout\"}" :: Either ParseException Attr
Right (Attr {foreColor = Just Black, backColor = Nothing, style = Just Standout})

JSON example without quotes: >>> decodeEither' "{fore-color: black, style: standout}" :: Either ParseException Attr Right (Attr {foreColor = Just Black, backColor = Nothing, style = Just Standout})

YAML example:

>>> :{
>>> decodeEither'
>>> $  "fore-color: \"blue\"\n"
>>> <> "back-color: \"bright-blue\"\n"
>>> <> "style: \"reverse-video\"\n"
>>> :: Either ParseException Attr
>>> :}
Right (Attr {foreColor = Just Blue, backColor = Just BrightBlue, style = Just ReverseVideo})

YAML example without quotes:

>>> :{
>>> decodeEither'
>>> $  "fore-color: blue\n"
>>> <> "back-color: bright-blue\n"
>>> <> "style: reverse-video\n"
>>> :: Either ParseException Attr
>>> :}
Right (Attr {foreColor = Just Blue, backColor = Just BrightBlue, style = Just ReverseVideo})

An empty JSON/YAML object yields the default colors:

>>> decodeEither' "{}" :: Either ParseException Attr
Right (Attr {foreColor = Nothing, backColor = Nothing, style = Nothing})

Instances

Eq Attr

Defined in Vgrep.Environment.Config.Sources.File

Methods

(==) :: Attr -> Attr -> Bool

(/=) :: Attr -> Attr -> Bool

Show Attr

Defined in Vgrep.Environment.Config.Sources.File

Methods

showsPrec :: Int -> Attr -> ShowS

show :: Attr -> String

showList :: [Attr] -> ShowS

Generic Attr

Defined in Vgrep.Environment.Config.Sources.File

Associated Types

type Rep Attr :: Type -> Type

Methods

from :: Attr -> Rep Attr x

to :: Rep Attr x -> Attr

FromJSON Attr

Defined in Vgrep.Environment.Config.Sources.File

Methods

parseJSON :: Value -> Parser Attr

parseJSONList :: Value -> Parser [Attr]

type Rep Attr

Defined in Vgrep.Environment.Config.Sources.File

type Rep Attr = D1 ('MetaData "Attr" "Vgrep.Environment.Config.Sources.File" "vgrep-0.2.3.0-79CAs1b54BVGsHizAm4Sjp" 'False) (C1 ('MetaCons "Attr" 'PrefixI 'True) (S1 ('MetaSel ('Just "foreColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Color)) :*: (S1 ('MetaSel ('Just "backColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Color)) :*: S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Style)))))

data Color

A JSON-parsable data type for Color.

>>> decodeEither' "[\"black\",\"red\",\"bright-black\"]" :: Either ParseException [Color]
Right [Black,Red,BrightBlack]

Also works without quotes:

>>> decodeEither' "[black,red,bright-black]" :: Either ParseException [Color]
Right [Black,Red,BrightBlack]

Fails with error message if the Color cannot be parsed:

>>> isLeft (decodeEither' "foo" :: Either ParseException Color)
True

Instances

Eq Color

Defined in Vgrep.Environment.Config.Sources.File

Methods

(==) :: Color -> Color -> Bool

(/=) :: Color -> Color -> Bool

Show Color

Defined in Vgrep.Environment.Config.Sources.File

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Generic Color

Defined in Vgrep.Environment.Config.Sources.File

Associated Types

type Rep Color :: Type -> Type

Methods

from :: Color -> Rep Color x

to :: Rep Color x -> Color

FromJSON Color

Defined in Vgrep.Environment.Config.Sources.File

Methods

parseJSON :: Value -> Parser Color

parseJSONList :: Value -> Parser [Color]

type Rep Color

Defined in Vgrep.Environment.Config.Sources.File

type Rep Color = D1 ('MetaData "Color" "Vgrep.Environment.Config.Sources.File" "vgrep-0.2.3.0-79CAs1b54BVGsHizAm4Sjp" 'False) ((((C1 ('MetaCons "Black" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Red" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Green" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Yellow" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Blue" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Magenta" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cyan" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "White" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "BrightBlack" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BrightRed" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "BrightGreen" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BrightYellow" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "BrightBlue" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BrightMagenta" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "BrightCyan" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BrightWhite" 'PrefixI 'False) (U1 :: Type -> Type)))))

data Style

A JSON-parsable data type for Style.

>>> decodeEither' "[\"standout\", \"underline\", \"bold\"]" :: Either ParseException [Style]
Right [Standout,Underline,Bold]

Also works without quotes:

>>> decodeEither' "[standout, underline, bold]" :: Either ParseException [Style]
Right [Standout,Underline,Bold]

Fails with error message if the Style cannot be parsed:

>>> isLeft (decodeEither' "foo" :: Either ParseException Color)
True

Instances

Eq Style

Defined in Vgrep.Environment.Config.Sources.File

Methods

(==) :: Style -> Style -> Bool

(/=) :: Style -> Style -> Bool

Show Style

Defined in Vgrep.Environment.Config.Sources.File

Methods

showsPrec :: Int -> Style -> ShowS

show :: Style -> String

showList :: [Style] -> ShowS

Generic Style

Defined in Vgrep.Environment.Config.Sources.File

Associated Types

type Rep Style :: Type -> Type

Methods

from :: Style -> Rep Style x

to :: Rep Style x -> Style

FromJSON Style

Defined in Vgrep.Environment.Config.Sources.File

Methods

parseJSON :: Value -> Parser Style

parseJSONList :: Value -> Parser [Style]

type Rep Style

Defined in Vgrep.Environment.Config.Sources.File

type Rep Style = D1 ('MetaData "Style" "Vgrep.Environment.Config.Sources.File" "vgrep-0.2.3.0-79CAs1b54BVGsHizAm4Sjp" 'False) ((C1 ('MetaCons "Standout" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Underline" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReverseVideo" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Blink" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Dim" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Bold" 'PrefixI 'False) (U1 :: Type -> Type))))

Orphan instances

FromJSON Attr

Methods

parseJSON :: Value -> Parser Attr

parseJSONList :: Value -> Parser [Attr]

FromJSON Command

Methods

parseJSON :: Value -> Parser Command

parseJSONList :: Value -> Parser [Command]

FromJSON KeybindingMap

Methods

parseJSON :: Value -> Parser KeybindingMap

parseJSONList :: Value -> Parser [KeybindingMap]

FromJSON KeybindingsMonoid

Methods

parseJSON :: Value -> Parser KeybindingsMonoid

parseJSONList :: Value -> Parser [KeybindingsMonoid]

FromJSON ColorsMonoid

Methods

parseJSON :: Value -> Parser ColorsMonoid

parseJSONList :: Value -> Parser [ColorsMonoid]

FromJSON ConfigMonoid

Methods

parseJSON :: Value -> Parser ConfigMonoid

parseJSONList :: Value -> Parser [ConfigMonoid]