cli-matic.core
ATTENTION
CLI-matic has one main entry-point: run-cmd.
As an end-user, you need nothing else, but the documentation that explains how parameters are to be run.
See examples/ to get started quickly.
Developers
Most of the logic will be run in run-cmd* to make testing easier,
as run-cmd calls System/exit.
### ATTENTION CLI-matic has one main entry-point: [[run-cmd]]. As an end-user, you need nothing else, but the documentation that explains how parameters are to be run. See `examples/` to get started quickly. *Developers* Most of the logic will be run in [[run-cmd*]] to make testing easier, as [[run-cmd]] calls `System/exit`.
cli-matic.help-gen
## Generate help texts.
- arg-list-with-positional-entries
- generate-a-command
- generate-global-command-list
- generate-global-help
- generate-help-possible-mistypes
- generate-possible-mistypes
- generate-section
- generate-sections
- generate-subcmd-help
- get-first-rest-description-rows
- get-options-summary
- getGlobalHelperFn
- getSubcommandHelperFn
- MISTYPE-ERR-RATIO
cli-matic.optionals
This namespace contains optional dependencies for CLJ.
CLI-matic is supposed to work whether they are present or not.
- JSON (Cheshire)
- YAML (io.forward/yaml)
- Orchestra
Detection is taken from core.clj in https://github.com/dakrone/clj-http
### This namespace contains optional dependencies for CLJ. CLI-matic is supposed to work whether they are present or not. * JSON (Cheshire) * YAML (io.forward/yaml) * Orchestra Detection is taken from `core.clj` in https://github.com/dakrone/clj-http
This namespace contains optional dependencies for CLJS.
JSON is always available in CLJS.
### This namespace contains optional dependencies for CLJS. JSON is always available in CLJS.
cli-matic.platform
Platform-specific functions for the JVM.
If running on ClojureScript, we can have a different file for JS.
BTW, in this NS, we avoid using Spec / Orchestra.
DO NOT define macros in this namespace - see cli-matic.platform-macros
## Platform-specific functions for the JVM. If running on ClojureScript, we can have a different file for JS. BTW, in this NS, we avoid using Spec / Orchestra. **DO NOT** define macros in this namespace - see [[cli-matic.platform-macros]]
Platform-specific functions for ClojureScript.
At the moment, we only support Planck.
BTW, in this NS, we avoid using Spec / Orchestra.
## Platform-specific functions for ClojureScript. At the moment, we only support Planck. BTW, in this NS, we avoid using Spec / Orchestra.
cli-matic.platform-macros
Macros shared between CLJ and CLJS.
Unfortunately:
- Macros must be in a separate file (for CLJS)
- Macros have a different import syntax (CLJS)
- Macros defined in .clj will STILL be loaded by CLJS and will fail big time.
So we have to use a separate namespace and hide everything behind reader conditionals.
Usage is:
#?(:clj [cli-matic.platform-macros :refer [try-catch-all]]
:cljs [cli-matic.platform-macros :refer-macros [try-catch-all]] )
This was a real PITA, man.
## Macros shared between CLJ and CLJS.
Unfortunately:
- Macros must be in a separate file (for CLJS)
- Macros have a different import syntax (CLJS)
- Macros defined in .clj will STILL be loaded by CLJS and will fail big time.
So we have to use a separate namespace and hide everything behind reader conditionals.
Usage is:
#?(:clj [cli-matic.platform-macros :refer [try-catch-all]]
:cljs [cli-matic.platform-macros :refer-macros [try-catch-all]]
)
This was a real PITA, man.
cli-matic.presets
### Known presets
- asDecodedEdnFile
- asDecodedEdnValue
- asDecodedJsonFile
- asDecodedJsonValue
- asDecodedYamlFile
- asDecodedYamlValue
- asKeyword
- asLinesString
- asSet
- asSingleString
- known-presets
- parseFlag
- set-find-didyoumean
- set-find-didyoumean-str
- set-find-value
- set-help-values
- set-normalize-map
- set-normalized-entry
- SET-OF-FALSE-FLAGS
- SET-OF-TRUE-FLAGS
cli-matic.utils
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.
### 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
- all-subcommands
- all-subcommands-aliases
- assoc-new-multivalue
- asString
- asStrVec
- canonicalize-subcommand
- capture-positional-parms
- cm-opts->cli-opts
- deep-merge
- exception-info
- exit!
- get-cli-option
- indent
- indent-string
- mk-cli-option
- mk-env-name
- mk-long-opt
- mk-short-opt
- pad
- positional-parms-from-opts
- printErr
- printString
cli-matic.utils-candidates
String candidates tools.
This namespace contains utilities to compute string candidates.
### String candidates tools. This namespace contains utilities to compute string candidates.
cli-matic.utils-convert-config
Convert old configuration (v1) to the new format (v2), in a printable way.
This comes in handy when evolving existing scripts.
ATM it only works for Clojure, and not so well, as symbol de-munging is not 100% deterministic (minuses and underscores are mixed).
This namespace is not referenced from anywhere else in CLI-matic.
# Convert old configuration (v1) to the new format (v2), in a printable way. This comes in handy when evolving existing scripts. ATM it only works for Clojure, and not so well, as symbol de-munging is not 100% deterministic (minuses and underscores are mixed). This namespace is not referenced from anywhere else in CLI-matic.
cli-matic.utils-v2
Utils to work with nested configuration trees (cfg v2)
- Convert commands v1 to v2 (fully nested).
- Accessors for data in a nested structure
# Utils to work with nested configuration trees (cfg v2) - Convert commands v1 to v2 (fully nested). - Accessors for data in a nested structure
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close