Copyright	Copyright (c) 2021-2023 Travis Cardwell
License	MIT
Safe Haskell	Safe-Inferred
Language	Haskell2010

BM

Contents

Constants
Types
API

Description

Synopsis

version :: String
type Argument = String
type Command = FilePath
type Error = String
type Keyword = String
type ParameterName = String
type ParameterValue = String
type Trace = String
type Url = String
data Config = Config {
- configCommand :: !Command
- configArgs :: !(Vector Bookmark)
}
data Bookmark = Bookmark {
- keyword :: !Keyword
- mCommand :: !(Maybe Command)
- mUrl :: !(Maybe Url)
- queryOrArgs :: !(Either Query (Vector Bookmark))
}
data Query = Query {
- action :: !Url
- parameter :: !ParameterName
- hiddenParameters :: !(Vector Parameter)
}
data Parameter = Parameter {
- name :: !ParameterName
- value :: !ParameterValue
}
data Proc = Proc {
- command :: !Command
- arguments :: ![Argument]
}
run :: Config -> [Argument] -> (Either Error Proc, [Trace])
getCompletion :: Config -> [Argument] -> [Argument]

Constants

version :: String Source #

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

Since: 0.1.0.0

Types

type Argument = String Source #

CLI argument or process argument

Since: 0.1.0.0

type Command = FilePath Source #

Process command

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

Since: 0.1.0.0

type Error = String Source #

Error message

Since: 0.1.0.0

type Keyword = String Source #

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 Source #

Query parameter name

Since: 0.1.0.0

type ParameterValue = String Source #

Query parameter value

Since: 0.1.0.0

type Trace = String Source #

Trace line for debugging

Since: 0.1.0.0

type Url = String Source #

Bookmark or query action URL

Since: 0.1.0.0

data Config Source #

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

Instances details

FromJSON Config Source #
Instance details Defined in BM Methods parseJSON :: Value -> Parser Config # parseJSONList :: Value -> Parser [Config] #
Show Config Source #
Instance details Defined in BM Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #

data Bookmark Source #

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

Instances details

FromJSON Bookmark Source #
Instance details Defined in BM Methods parseJSON :: Value -> Parser Bookmark # parseJSONList :: Value -> Parser [Bookmark] #
Show Bookmark Source #
Instance details Defined in BM Methods showsPrec :: Int -> Bookmark -> ShowS # show :: Bookmark -> String # showList :: [Bookmark] -> ShowS #

data Query Source #

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

Instances details

FromJSON Query Source #
Instance details Defined in BM Methods parseJSON :: Value -> Parser Query # parseJSONList :: Value -> Parser [Query] #
Show Query Source #
Instance details Defined in BM Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #

data Parameter Source #

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

Instances details

FromJSON Parameter Source #
Instance details Defined in BM Methods parseJSON :: Value -> Parser Parameter # parseJSONList :: Value -> Parser [Parameter] #
Show Parameter Source #
Instance details Defined in BM Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #

data Proc Source #

Process specification

Since: 0.1.0.0

Constructors

Proc
Fields command :: !Command arguments :: ![Argument]

Instances

Instances details

Show Proc Source #
Instance details Defined in BM Methods showsPrec :: Int -> Proc -> ShowS # show :: Proc -> String # showList :: [Proc] -> ShowS #
Eq Proc Source #
Instance details Defined in BM Methods (==) :: Proc -> Proc -> Bool # (/=) :: Proc -> Proc -> Bool #

API

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

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

Since: 0.1.0.0

getCompletion Source #

Arguments

:: Config
-> [Argument]	current CLI arguments, last one being completed
-> [Argument]	completion options

Get CLI completion options

Since: 0.1.0.0