COLLECT. Reads the command contract off the classpath, and nothing else.
Two resources, merged, and the split between them is deliberate:
commands.edn DERIVED from the reference project by dev/extract_gimp_contract.py. Regenerated wholesale, so nothing hand-written may live in it. commands_extra.edn HAND-MAINTAINED additions, which a regeneration must not erase.
Every function here either returns what the resources say or delegates to
hive-gimp.contract, which owns every decision ABOUT the contract. The
split matters because this namespace is the only one that cannot be driven
from a generator: its input is a file on the classpath.
COLLECT. Reads the command contract off the classpath, and nothing else.
Two resources, merged, and the split between them is deliberate:
commands.edn DERIVED from the reference project by
dev/extract_gimp_contract.py. Regenerated wholesale,
so nothing hand-written may live in it.
commands_extra.edn HAND-MAINTAINED additions, which a regeneration must
not erase.
Every function here either returns what the resources say or delegates to
`hive-gimp.contract`, which owns every decision ABOUT the contract. The
split matters because this namespace is the only one that cannot be driven
from a generator: its input is a file on the classpath.The contract, read once.
Resources do not change under a running JVM, and re-reading per call would put a file read in the path of every command.
The contract, read once. Resources do not change under a running JVM, and re-reading per call would put a file read in the path of every command.
(commands)Command name to Descriptor, registered rows included.
Command name to `Descriptor`, registered rows included.
(describe descriptor)The published projection of one descriptor.
The published projection of one descriptor.
(descriptor name-or-tool)The Descriptor for a command name or a published tool name, or nil.
The `Descriptor` for a command name or a published tool name, or nil.
(invalid)Descriptors in the SHIPPED resources that do not conform.
Kept as a function rather than a test-only assertion so the doctor can report a bad contract in the field, where no test runner is present.
Descriptors in the SHIPPED resources that do not conform. Kept as a function rather than a test-only assertion so the doctor can report a bad contract in the field, where no test runner is present.
(load-descriptors)Every descriptor from both resources, derived first so a hand-written row is the later one and can win a tie it is entitled to win.
Every descriptor from both resources, derived first so a hand-written row is the later one and can win a tie it is entitled to win.
(read-resource path)Descriptors from a classpath EDN resource, or [] when it is absent.
Absent is not an error: the extra resource is optional, and a consumer repackaging this jar may drop it.
Descriptors from a classpath EDN resource, or [] when it is absent. Absent is not an error: the extra resource is optional, and a consumer repackaging this jar may drop it.
(register! descriptor)Add descriptor to the live contract, replacing any row with its command.
Throws when it does not conform. Returns the descriptor.
Add `descriptor` to the live contract, replacing any row with its command. Throws when it does not conform. Returns the descriptor.
Descriptors registered at runtime, by command. A re-registration of the same command replaces its row.
Descriptors registered at runtime, by command. A re-registration of the same command replaces its row.
(search q)Commands whose name or description contains q.
Commands whose name or description contains `q`.
(unregister! command)Remove the registered row for command. Shipped resources are untouched.
Remove the registered row for `command`. Shipped resources are untouched.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |