cli-matic.utils — cli-matic 0.2.7

Utilities used in the project

• the general section contains low-level stuff that could be anywhere
• the cli-matic section contain low-level functions used by the parser and the help generators.

a-positional-parm clj/s

(a-positional-parm args option)

Reads one positional parameter from the arguments. Returns a vector [parm value] The value is NOT solved, so it's always a string.

all-subcommands clj/s

(all-subcommands climatic-args)

Returns all subcommands, as strings. We get all versions of all subcommands.

all-subcommands-aliases clj/s

(all-subcommands-aliases climatic-args)

Maps all subcommands and subcommand aliases to their canonical name. E.g. {'add': 'add', 'a': 'add'}.

We basically add them all, then remove nil keys.

assoc-new-multivalue clj/s

(assoc-new-multivalue parameter-map option v)

Associates a new multiple value to the current parameter map. If the current value is not a vector, creates a new vector with the new value.

asString clj/s

(asString s)

Turns a collection of strings into one string, or the string itself.

If the collection includes multiple sub-arrays, those are flattened into lines as well.

asStrVec clj/s

(asStrVec s)

Whatever we get in, we want a vector of strings out.

candidate-suggestions clj/s

(candidate-suggestions candidates cmd max-str-distance)

Returns candidate suggestions, in order of reliability.

canonicalize-subcommand clj/s

(canonicalize-subcommand commands subcmd)

Returns the 'canonical' name of a subcommand, i.e. the one that appears in :command, even if we pass an alias or short version.

capture-positional-parms clj/s

(capture-positional-parms cfg subcmd remaining-args)

Captures positional parameters in the remaining-args of a subcommand.

cm-opts->cli-opts clj/s

(cm-opts->cli-opts climatic-opts)

Out of a cli-matic arg list, generates a set of options for tools.cli. It also adds in the -? and --help options to trigger display of helpness.

deep-merge clj/s

(deep-merge & maps)

Merges a number of maps, considering values in inner maps.

See https://gist.github.com/danielpcox/c70a8aa2c36766200a95#gistcomment-2308595

get-options-for clj/s

(get-options-for climatic-args subcmd)

Gets specific :options for a subcommand or, if nil, for global.

get-subcommand clj/s

(get-subcommand climatic-args subcmd)

Given args and the canonical name of a subcommand, returns the map describing it.

indent clj/s

(indent s)

Indents a single string, or each string in a collection of strings.

indent-string clj/s

(indent-string s)

Indents a single string by one space.

list-positional-parms clj/s

(list-positional-parms cfg subcmd)

Extracts all positional parameters from the configuration.

mk-cli-option clj/s

(mk-cli-option {:keys [option short as type default multiple env]
                :as cm-option})

Builds a tools.cli option out of our own format.

If for-parsing is true, the option will be used for parsing; if false, for generating help messages.

mk-env-name clj/s

(mk-env-name description env for-parsing?)

Writes a description with the env name by the end.

pad clj/s

(pad s s1 len)

Pads 's[, s1]' to so many characters

rewrite-opts clj/s

(rewrite-opts climatic-args subcmd)

Out of a cli-matic arg list, generates a set of options for tools.cli. It also adds in the -? and --help options to trigger display of helpness.

str-distance clj/s

(str-distance a b)

Distance between two strings, as expressed in percentage of changes to the length of the longest string.