Liking cljdoc? Tell your friends :D

kit.generator.modules-log

Keeps track of installed modules.

Keeps track of installed modules.
raw docstring

build-installation-manifestclj

(build-installation-manifest ctx {:module/keys [resolved-config]} feature-flag)

Builds a detailed manifest of what a module installation did. Called after successful generation to persist the record for later removal. Note: SHA-256 hashes are computed from on-disk state after generation completes.

Builds a detailed manifest of what a module installation did.
Called after successful generation to persist the record for later removal.
Note: SHA-256 hashes are computed from on-disk state after generation completes.
raw docstring

installed-modulesclj

(installed-modules ctx)

A list of keys of modules that were installed successfully.

A list of keys of modules that were installed successfully.
raw docstring

installed-modules-logclj

(installed-modules-log ctx)

A map of module keys to their log entries, for modules that were installed successfully.

A map of module keys to their log entries, for modules that were installed successfully.
raw docstring

module-installed?clj

(module-installed? ctx module-key)

True if the module identified by module-key was installed successfully.

True if the module identified by module-key was installed successfully.
raw docstring

module-manifestclj

(module-manifest ctx module-key)

Retrieves the detailed installation manifest for a module. Returns nil for modules installed before manifest tracking was added.

Retrieves the detailed installation manifest for a module.
Returns nil for modules installed before manifest tracking was added.
raw docstring

read-modules-logclj

(read-modules-log modules-root)

record-installationclj

(record-installation ctx module-key manifest)

Records a module installation in the log with a detailed manifest or failure status.

Records a module installation in the log with a detailed manifest or failure status.
raw docstring

sha256clj

(sha256 content)

Computes the SHA-256 hex digest of a byte array or string.

Computes the SHA-256 hex digest of a byte array or string.
raw docstring

track-installationcljmacro

(track-installation ctx module-key & body)

Records the installation status of a module identified by module-key. If the installation body throws an exception, the status is recorded as :failed. If it completes successfully, the status is recorded as :success.

Deprecated: prefer record-installation for new code, which supports detailed manifests.

Records the installation status of a module identified by module-key.
If the installation body throws an exception, the status is recorded as :failed.
If it completes successfully, the status is recorded as :success.

Deprecated: prefer record-installation for new code, which supports detailed manifests.
raw docstring

untrack-moduleclj

(untrack-module ctx module-key)

Removes a module entry from the installation log.

Removes a module entry from the installation log.
raw docstring

write-modules-logclj

(write-modules-log modules-root log)

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