BM

Constants

version :: String

bm version string ("bm-haskell X.X.X.X")

Since: 0.1.0.0

Types

type Argument = String

CLI argument or process argument

Since: 0.1.0.0

type Command = FilePath

Process command

This command is executed with a single URL argument to open a bookmark/query.

Since: 0.1.0.0

type Error = String

Error message

Since: 0.1.0.0

type Keyword = String

Bookmark keyword

The configuration file defines a hierarchy of keywords that are matched against CLI arguments to determine which bookmark/query to open.

Since: 0.1.0.0

type ParameterName = String

Query parameter name

Since: 0.1.0.0

type ParameterValue = String

Query parameter value

Since: 0.1.0.0

type Trace = String

Trace line for debugging

Since: 0.1.0.0

type Url = String

Bookmark or query action URL

Since: 0.1.0.0

data Config

Configuration

YAML attributes:

• command: top-level command (string, default depends on the OS)
• args: bookmarks (array of Bookmark)

Default commands:

• Linux: xdg-open
• Windows: start
• macOS: open

Since: 0.1.0.0

Constructors

Config

Fields

• configCommand :: !Command
• configArgs :: !(Vector Bookmark)

Instances

FromJSON Config

Defined in BM

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

Show Config

Defined in BM

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

data Bookmark

Bookmark definition

YAML attributes:

• keyword: bookmark keyword (string)
• command: command for this bookmark and children (string, optional)
• url: bookmark URL (string, optional)
• query: bookmark query definition (Query, optional)
• args: child bookmarks (array of Bookmark, optional)

A command be set to override the top-level command, but this is generally not done. If a bookmark is selected and there is no URL, the first child is processed. Only one of query and args may be present.

Since: 0.1.0.0

Constructors

Bookmark

Fields

• keyword :: !Keyword
• mCommand :: !(Maybe Command)
• mUrl :: !(Maybe Url)
• queryOrArgs :: !(Either Query (Vector Bookmark))

Instances

FromJSON Bookmark

Defined in BM

Methods

parseJSON :: Value -> Parser Bookmark

parseJSONList :: Value -> Parser [Bookmark]

Show Bookmark

Defined in BM

Methods

showsPrec :: Int -> Bookmark -> ShowS

show :: Bookmark -> String

showList :: [Bookmark] -> ShowS

data Query

Query definition

YAML attributes:

• action: URL (string)
• parameter: query parameter name (string, default: q)
• hidden: array of constant parameters (Parameter)

Since: 0.1.0.0

Constructors

Query

Fields

• action :: !Url
• parameter :: !ParameterName
• hiddenParameters :: !(Vector Parameter)

Instances

FromJSON Query

Defined in BM

Methods

parseJSON :: Value -> Parser Query

parseJSONList :: Value -> Parser [Query]

Show Query

Defined in BM

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

data Parameter

HTTP GET parameter definition

YAML attributes:

• name: parameter name
• value: constant parameter value

Since: 0.1.0.0

Constructors

Parameter

Fields

• name :: !ParameterName
• value :: !ParameterValue

Instances

FromJSON Parameter

Defined in BM

Methods

parseJSON :: Value -> Parser Parameter

parseJSONList :: Value -> Parser [Parameter]

Show Parameter

Defined in BM

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

data Proc

Process specification

Since: 0.1.0.0

Constructors

Proc

Fields

• command :: !Command
• arguments :: ![Argument]

Instances

Show Proc

Defined in BM

Methods

showsPrec :: Int -> Proc -> ShowS

show :: Proc -> String

showList :: [Proc] -> ShowS

Eq Proc

Defined in BM

Methods

(==) :: Proc -> Proc -> Bool

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

API

run :: Config -> [Argument] -> (Either Error Proc, [Trace])

Determine the process to execute for the given config and CLI arguments

Since: 0.1.0.0

getCompletion

Arguments

:: Config

-> [Argument]

current CLI arguments, last one being completed

-> [Argument]

completion options

Get CLI completion options

Since: 0.1.0.0