Liking cljdoc? Tell your friends :D

hive-build.collect.io

Filesystem, environment and registry reads.

Every function here is one effect and no decision, so everything above this layer can be pure. Nothing in here interprets what it reads.

Filesystem, environment and registry reads.

Every function here is one effect and no decision, so everything above this
layer can be pure. Nothing in here interprets what it reads.
raw docstring

declared-nsclj

(declared-ns path)

The namespace name declared in the source file at path, or nil.

Reads forms until it finds the ns form, so a leading comment or reader conditional does not hide it.

The namespace name declared in the source file at `path`, or nil.

Reads forms until it finds the ns form, so a leading comment or reader
conditional does not hide it.
sourceraw docstring

envclj

(env ks)

{k -> value} for ks.

Throws when any is unset or blank: a deploy that proceeds with a missing credential fails at the registry, after the artifact has been built.

{k -> value} for `ks`.

Throws when any is unset or blank: a deploy that proceeds with a missing
credential fails at the registry, after the artifact has been built.
sourceraw docstring

exists?clj

(exists? path)
source

files-by-dirclj

(files-by-dir dirs)

{dir -> paths beneath it} for dirs.

{dir -> paths beneath it} for `dirs`.
sourceraw docstring

files-underclj

(files-under dir)

Paths of every regular file beneath dir, or () when dir is absent.

Paths of every regular file beneath `dir`, or () when `dir` is absent.
sourceraw docstring

getenvclj

(getenv k)
source

head-ok?clj

(head-ok? url auth)

True when a HEAD of url answers 200. Any failure is false: an unreachable registry must not be read as already published.

True when a HEAD of `url` answers 200. Any failure is false: an unreachable
registry must not be read as `already published`.
sourceraw docstring

on-path?clj

(on-path? command probe-args run-process)

True when command answers successfully to probe-args.

True when `command` answers successfully to `probe-args`.
sourceraw docstring

read-ednclj

(read-edn path)

Parsed EDN at path, or nil when the file is absent.

A parse failure is rethrown naming the file: the underlying message says only what was wrong, never where, and a build tool reads several EDN files.

Parsed EDN at `path`, or nil when the file is absent.

A parse failure is rethrown naming the file: the underlying message says
only what was wrong, never where, and a build tool reads several EDN files.
sourceraw docstring

read-textclj

(read-text path)

Contents of path, or nil when it is absent.

Contents of `path`, or nil when it is absent.
sourceraw docstring

spdx-idsclj

(spdx-ids paths)

Distinct SPDX-License-Identifier values declared across paths.

Distinct SPDX-License-Identifier values declared across `paths`.
sourceraw docstring

write-text!clj

(write-text! path text)
source

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close