The tools.build adapter: gathers the Project and Facts a plan is computed from, and supplies the handler that executes each step kind.
This is the only namespace that knows tools.build and deps-deploy exist.
The tools.build adapter: gathers the Project and Facts a plan is computed from, and supplies the handler that executes each step kind. This is the only namespace that knows tools.build and deps-deploy exist.
(aot-basis overlay)Compile-time basis. Injects ONLY the overlay's :provided alias, so the overlay's top-level :deps never reach the release compile classpath.
Compile-time basis. Injects ONLY the overlay's :provided alias, so the overlay's top-level :deps never reach the release compile classpath.
(bb-classpath)Resolve bb.edn deps so Babashka macro exporters also reach clj-kondo. nil when there is no bb.edn or bb is not installed.
Resolve bb.edn deps so Babashka macro exporters also reach clj-kondo. nil when there is no bb.edn or bb is not installed.
(context project)(context project overlay)(context project overlay deploy-fn)The execution context for project: the overlay an AOT compile needs (nil
for tasks that do not compile), and the deploy function, which is injected
so a release can be exercised without a registry.
The execution context for `project`: the overlay an AOT compile needs (nil for tasks that do not compile), and the deploy function, which is injected so a release can be exercised without a registry.
(deps-classpath aliases)The classpath of this project under aliases.
The classpath of this project under `aliases`.
Step kind -> (fn [ctx step] -> result). The tools.build implementation of every step a plan can contain.
Step kind -> (fn [ctx step] -> result). The tools.build implementation of every step a plan can contain.
(overlay)Parsed ./local.deps.edn, or nil when absent. Supplies a :provided alias of host sources that must be on the AOT compile classpath but must not enter the pom, and an :aot/preload namespace vector compiled first.
Parsed ./local.deps.edn, or nil when absent. Supplies a :provided alias of host sources that must be on the AOT compile classpath but must not enter the pom, and an :aot/preload namespace vector compiled first.
(pom-basis project)Project basis for the pom, minus :pom-exclude-deps. Equals the plain basis when the key is absent.
Project basis for the pom, minus :pom-exclude-deps. Equals the plain basis when the key is absent.
(probe-process command-args)Run command-args, capturing both streams. For availability checks, and for
commands whose stdout IS the answer.
Run `command-args`, capturing both streams. For availability checks, and for commands whose stdout IS the answer.
(published? project target)True when this exact coordinate already exists at target's registry.
Any failure to reach the registry is false: an unreachable registry must
not be read as already published, because that would silently skip a
release.
True when this exact coordinate already exists at `target`'s registry. Any failure to reach the registry is false: an unreachable registry must not be read as `already published`, because that would silently skip a release.
(read-facts project {:keys [probe-registry? overlay]})Everything from the filesystem and the registry that project's plan
depends on.
probe-registry? is false for tasks that never publish, so a local build
never touches the network. overlay is the parsed ./local.deps.edn, or nil
for a task that does not compile.
Everything from the filesystem and the registry that `project`'s plan depends on. `probe-registry?` is false for tasks that never publish, so a local build never touches the network. `overlay` is the parsed ./local.deps.edn, or nil for a task that does not compile.
(read-license-facts project)What the licence rules are evaluated against: what version.edn declares, whether ./LICENSE exists, and the SPDX identifiers the sources carry.
What the licence rules are evaluated against: what version.edn declares, whether ./LICENSE exists, and the SPDX identifiers the sources carry.
(read-project)The Project for the repository in the current working directory.
Read at task time, never at require time: as a library, hive-build is loaded long before anyone chooses which repository to build.
The Project for the repository in the current working directory. Read at task time, never at require time: as a library, hive-build is loaded long before anyone chooses which repository to build.
(resolve-version cfg)The version this repository releases: ./VERSION when present, otherwise 0.{:minor}.{commit count}.
The version this repository releases: ./VERSION when present, otherwise
0.{:minor}.{commit count}.(run-process command-args)Run command-args with its output going to the console.
A linter whose findings were captured and discarded is a linter that always passes, so anything whose output is meant for a human is run this way.
Run `command-args` with its output going to the console. A linter whose findings were captured and discarded is a linter that always passes, so anything whose output is meant for a human is run this way.
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 |