org.soulspace.clj.cli — org.soulspace.clj/clj.base 0.9.1

Functions to define and parse command line options.

add-result clj

(add-result option-map [spec value])

Add the value for an option to the option map. Handles multiple values per option.

build-specs clj

(build-specs option-defs)

Build option specifications from the option definitions.

default-option-map clj

(default-option-map specs)

Returns an option map initalized with the default values.

doc-for-spec clj

(doc-for-spec {:keys [long short doc default]})

Returns the documentation for the specification.

doc-for-specs clj

(doc-for-specs specs)

Returns the documentation for the specifications.

doc-options clj

(doc-options option-defs)

flag-spec? clj

(flag-spec? arg)

Tests if the string is a flag, which starts with the string '--[no-]'.

long-option? clj

(long-option? arg)

Tests if the string is a long option, which starts with the string '--'.

matches-option? clj

(matches-option? arg spec)

Returns true, if the arg starts with an option switch of this spec.

option-name clj

(option-name opt)

Returns the name of the option.

option? clj

(option? arg)

Tests if the string is an option, which starts with the character '-'.

parse-args clj

(parse-args args option-definitions)

Parses the args sequence into a vector of options and arguments.

parse-option-arg clj

(parse-option-arg specs arg)

Returns the option spec and the parsed value in a vector, if a matching option is found.

parse-option-args clj

(parse-option-args specs option-args)

Parses a sequence of options.