omniconf.core — com.grammarly/omniconf 0.4.3

Omniconf is an exhaustive configuration tool.

*data-readers* clj

The default data-readers to use when reading a configuration file

define clj

(define scheme)

Declare the configuration that the program supports. scheme is a map of keyword names to specs.

Example:

(define {:boolean-option {:description "can be either true or nil"} :string-option {:type :string :description "this option's value is taken as is"} :integer-option {:type :number :required true :description "parsed as integer, must be present"}}

Supported attributes:

:description - string to describe the option in the help message. :type - one of #{:string :keyword :number :boolean :edn :file :directory}. :parser - 1-arity fn to be called on a string given by CMD args or ENV. Unnecessary if :type is specified. :required - boolean value whether the option must have a value; or 0-arity fn, if it returns true, the option must have a value. :one-of - a set of accepted values for the given option. :verifier - fn on key and val, should throw an exception if option is invalid. :secret - if true, value will not be printed during verification. :nested - allows to create hierarchies of options.

enable-functions-as-defaults clj

(enable-functions-as-defaults)

Allow invoking functions passed to :default field for the options.

fail clj

(fail fmt & args)

Throws an exception with a message specified by fmt and args.

get clj

(get & ks)

Get the value from the current configuration given the path in nested structure specified by ks. Path can be provided as a single sequence, or as a variable number of keywords.

parse-boolean clj

(parse-boolean s)

Parses string as a Boolean.

parse-edn clj

(parse-edn s)

Calls clojure.edn/read-string on a string.

parse-filename clj

(parse-filename s)

Parses string as a relative filename.

parse-number clj

(parse-number s)

Parses string as a Long.

populate-from-cmd clj

(populate-from-cmd cmd-args)

(populate-from-cmd cmd-args quit-on-error)

Fill configuration from command-line arguments.

populate-from-env clj

(populate-from-env)

(populate-from-env quit-on-error)

Fill configuration from environment variables. This function must be called only after define. If quit-on-error is true, immediately quit when program occurs.

populate-from-file clj

(populate-from-file edn-file)

(populate-from-file edn-file quit-on-error)

Fill configuration from an edn file. Any data-reader functions may be optionally set by setting the data-readers binding.

populate-from-map clj

(populate-from-map config-map)

Fill configuration from a map passed directly as value.

populate-from-properties clj

(populate-from-properties)

(populate-from-properties quit-on-error)

Fill configuration from Java properties.

populate-from-ssm clj

(populate-from-ssm path)

Fill configuration from AWS Systems Manager. Recursively look up all parameters under the given path. com.grammarly/omniconf.ssm dependency must be on classpath.

populate-from-ssm-continually clj

(populate-from-ssm-continually path interval-in-seconds)

Like populate-from-ssm, but runs regularly at the specified interval. Use this to dynamically reconfigure your program at runtime. com.grammarly/omniconf.ssm dependency must be on classpath.

print-cli-help clj

(print-cli-help)

Prints a help message describing all supported command-line arguments.

report-configuration clj

(report-configuration)

Prints the current configuration state to *out*. Hide options marked as :secret.

set clj

(set & args)

Set the value for the ks path in the current configuration. Path can be provided as a single sequence, or as a variable number of keywords. If value is a string, call the respective parser on it before setting.

set-logging-fn clj

(set-logging-fn fn)

Change println to a custom logging function that Omniconf will use.

stop-ssm-poller clj

(stop-ssm-poller)

Stop the process that polls SSM for configuration, created by populate-from-ssm-continually. com.grammarly/omniconf.ssm dependency must be on classpath.

verify clj

(verify & {:keys [silent]})

Checks if all the required options are provided, if all values are in range, and prints the configuration. If :quit-on-error is set, script will exit if configuration is incorrect. If :silent is true, don't print the configuration state.

verify-directory-non-empty clj

(verify-directory-non-empty key dir)

Check if dir contains at least one file. Also checks that dir exists.

verify-file-exists clj

(verify-file-exists key file)

Check if file or directory denoted by file exists, raise error otherwise.

with-options clj macro

(with-options bindings & body)

Binds given symbols to respective configuration parameters and executes body in that context. Works only for top-level parameters.