- about
- add-option-set
- config-and-validate
- config-and-validate-external
- config-configure-all!
- config-set-options!
- configured-options
- convert-keys-to-set
- default-zpst-options
- display-keys
- empty-to-nil
- explain-hide-keys
- explained-options
- explained-sequence
- get-default-explained-all-options
- get-default-options
- get-explained-all-options
- get-explained-options
- get-options
- help-str
- inc-explained-sequence
- internal-set-options!
- reset-default-options!
- reset-options!
- set-explained-options!
- trim-last
- validate-incoming-options
- validate-options
- validate-style-map
- vec-str-to-str
- zprint-option-ks
- zpstrc
zpst.config
add-option-setclj
(add-option-set m)Given an option map, turn the display-keys into a set in the map.
Given an option map, turn the display-keys into a set in the map.
config-and-validateclj
(config-and-validate doc-string doc-map existing-map new-map)Do a single new map. Returns [updated-map new-doc-map error-vec]. Handles removing elements from existing map as well as validation. Depends on existing-map to be the full, current options map!
Do a single new map. Returns [updated-map new-doc-map error-vec]. Handles removing elements from existing map as well as validation. Depends on existing-map to be the full, current options map!
config-and-validate-externalclj
(config-and-validate-external)Configure from the zpstrc file on top of defaults. Left in the structure from zprint's config-and-validate-all, in case we want to add some other options for validation at some later date. Returns [new-map doc-map errors]
Configure from the zpstrc file on top of defaults. Left in the structure from zprint's config-and-validate-all, in case we want to add some other options for validation at some later date. Returns [new-map doc-map errors]
config-configure-all!clj
(config-configure-all!)Do external configuration regardless of whether or not it has already been done, replacing any internal configuration. Returns nil if successful, a vector of errors if not. Argument, if it exists, says whether or not to try to load additional libraries. Defaults to true, unusually enough.
Do external configuration regardless of whether or not it has already been done, replacing any internal configuration. Returns nil if successful, a vector of errors if not. Argument, if it exists, says whether or not to try to load additional libraries. Defaults to true, unusually enough.
config-set-options!clj
(config-set-options! new-options)(config-set-options! new-options doc-str)Add some options to the current options, checking to make sure that they are correct. External interface for setting options (i.e., called by zpst.core/set-options!).
Add some options to the current options, checking to make sure that they are correct. External interface for setting options (i.e., called by zpst.core/set-options!).
convert-keys-to-setclj
(convert-keys-to-set ks m)Given a seq of boolean keys in a map, convert them individually to a set. By individually, that is to say that this a sequence of keys, not a key sequence.
Given a seq of boolean keys in a map, convert them individually to a set. By individually, that is to say that this a sequence of keys, not a key sequence.
empty-to-nilclj
(empty-to-nil empty-seq)If the sequence is empty, then return nil, else return the sequence.
If the sequence is empty, then return nil, else return the sequence.
get-default-explained-all-optionsclj
(get-default-explained-all-options)Return the base explained options, matches get-default-options
Return the base explained options, matches get-default-options
get-default-optionsclj
(get-default-options)Return the base default options.
Return the base default options.
get-explained-all-optionsclj
(get-explained-all-options)Return any previously set doc-map complete.
Return any previously set doc-map complete.
get-explained-optionsclj
(get-explained-options)Return any previously set doc-map.
Return any previously set doc-map.
get-optionsclj
(get-options)Return the currently configured options.
Return the currently configured options.
inc-explained-sequenceclj
(inc-explained-sequence)Return current explained-seqence and add one to it.
Return current explained-seqence and add one to it.
internal-set-options!clj
(internal-set-options! doc-string doc-map existing-options new-options)Validate the new options, and update both the saved options and the doc-map as well. Will throw an exception for errors.
Validate the new options, and update both the saved options and the doc-map as well. Will throw an exception for errors.
reset-default-options!clj
(reset-default-options!)Remove any previously set options.
Remove any previously set options.
reset-options!clj
(reset-options! updated-map)(reset-options! updated-map doc-map)Replace options to be used on every call. You must have validated these options already!
Replace options to be used on every call. You must have validated these options already!
set-explained-options!clj
(set-explained-options! doc-map)Set options to be used on every call.
Set options to be used on every call.
trim-lastclj
(trim-last sym)Trim the last character off of a keyword.
Trim the last character off of a keyword.
validate-incoming-optionsclj
(validate-incoming-options doc-string incoming-options)Take some incoming options from a call and validate them. Should be called whether or not we really have any options, since this ensures that the ~/.zpst.rc file is used to initialize everything. Either throws an exception or returns the options.
Take some incoming options from a call and validate them. Should be called whether or not we really have any options, since this ensures that the ~/.zpst.rc file is used to initialize everything. Either throws an exception or returns the options.
validate-optionsclj
(validate-options options)(validate-options options source-str)Validate an options map, which contains embedded zprint options maps. Requires source-str, a descriptive phrase which will be included in any errors. Returns nil for success, a string with error(s) if not.
Validate an options map, which contains embedded zprint options maps. Requires source-str, a descriptive phrase which will be included in any errors. Returns nil for success, a string with error(s) if not.
vec-str-to-strclj
(vec-str-to-str vec-str)Take a vector of strings and concatenate them into one string with newlines between them.
Take a vector of strings and concatenate them into one string with newlines between them.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close